Skip to content
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/account-management/

Operations
Operations
Operations
Operations
Operations
Operations
Operations

Index reservations on an account. Version 2022-07-18

Request

Returns an array containing all outstanding reservations on the account specified in the request URL. The API will not return reservations that have been applied or revoked.
Important This endpoint replaces the old version. However, please note that you have to set the api-version header to the version you want (e.g., 2022-07-18). If you do not specify a version, then the API will return the older version of the response.

Path
account_idstringrequired

Unique identifier of a customer's account.

Example: e48c29b85992b8772eb7ddd518490920cacc
Query
page[number]string

Returns a specific page of results.

page[size]string

Determines the size of each page of results.

filter[type]string(reservation_types)

Filters the returned reservations by type.

Enum"CardAuthorization""SepaCreditTransfer""ClearingTransaction""IntraCustomerTransfer""SepaCreditBatch""Seizure""SecuritiesPurchase""PendingTrade""SEPAInstantCreditTransfer"
Example: filter[type]=CardAuthorization
filter[id]string

Filters the returned reservations by ID.

Example: filter[id]=162ddd7e-790c-5963-908f-4cedfd30f9a1
filter[status]string

Filters the reservations by status, e.g., OPEN.

Enum"OPEN""RESOLVED"
Example: filter[status]=OPEN
sortstring

Sorts the returned reservations by created_at date.

Enum"created_at""-created_at"
Example: sort=-created_at
No request payload

Responses

Successfully fetched the reservations.

Bodyapplication/jsonArray [
idstring

ID of the reservation.

Example: "162ddd7e-790c-5963-908f-4cedfd30f9a1"
descriptionstring

A description for the reservation, which is visible to the customer.

account_idstring

ID of the account to which the reservation is attached.

Example: "e48c29b85992b8772eb7ddd518490920cacc"
ibanstring

IBAN of the account to which the reservation is attached.

Example: "DE84110101010001234567"
amountobject

The amount of the reservation, in Euro cents.

typestring(reservation_types)
Enum"CardAuthorization""SepaCreditTransfer""ClearingTransaction""IntraCustomerTransfer""SepaCreditBatch""Seizure""SecuritiesPurchase""PendingTrade""SEPAInstantCreditTransfer"
referencestring

Internal reference number for the reservation.

Example: "85f20dc2-190f-47d3-94c7-2737ca71f286"
statusstring

The current status of the reservation. Possible values are OPEN and RESOLVED.

Enum"OPEN""RESOLVED"
Example: "OPEN"
meta_inforeservations_meta_info (object)
reservations_meta_info (object)
created_atstring

UTC timestamp from when the reservation was created.

Example: "2022-06-20T18:49:49Z"
resolved_atstring

UTC timestamp from when the reservation was resolved. If the reservation has not yet been resolved, then this property will have a value of null.

Example: "null"
]
Response
application/json
[ { "id": "162ddd7e-790c-5963-908f-4cedfd30f9a1", "description": "string", "account_id": "e48c29b85992b8772eb7ddd518490920cacc", "iban": "DE84110101010001234567", "amount": {}, "type": "CardAuthorization", "reference": "85f20dc2-190f-47d3-94c7-2737ca71f286", "status": "OPEN", "meta_info": {}, "created_at": "2022-06-20T18:49:49Z", "resolved_at": "null" } ]

(Deprecated) Get account reservations. Version 2022-06-01Deprecated

Request

Returns an array containing all reservations on a given account. This endpoint will deprecated soon. All partners must switch to the new version.

Path
account_idstringrequired
Query
page[number]string

Returns a specific page of results.

page[size];string

Determines the size of each page of results.

filter[reservation_type]string

Filters the returned reservations by type.

Enum"CARD_AUTHORIZATION""SEPA_CREDIT_TRANSFER""CLEARING_TRANSACTION""INTRA_CUSTOMER_TRANSFER""SEPA_CREDIT_BATCH""SEIZURE""SEPAInstantCreditTransfer"
Example: filter[reservation_type]=CARD_AUTHORIZATION
filter[id]string

Filters the returned reservations by ID.

Example: filter[id]=162ddd7e-790c-5963-908f-4cedfd30f9a1
filter[status]string

Filters the reservations by status, e.g., OPEN.

Enum"OPEN""RESOLVED"
Example: filter[status]=OPEN
sortstring

Sorts the returned reservations by created_at date.

Enum"created_at""-created_at"
Example: sort=-created_at
No request payload

Responses

The operation was successful.

Bodyapplication/jsonArray [
idstring

ID of the reservation.

Example: "b814e2213c5c45149945ed53422db0c4cres"
amountobject

Amount of the reservation (in Euro cents).

reservation_typestring

The type of reservation.

Enum"CARD_AUTHORIZATION""CLEARING_TRANSACTION""INTRA_CUSTOMER_TRANSFER""SEIZURE""SEPA_CREDIT_BATCH""SEPA_CREDIT_TRANSFER""ProtectedAccountSeizure"
Example: "CARD_AUTHORIZATION"
referencestring

Reference for the reservation.

Example: "c222a0b8-07ea-49be-83c1-68719be286e6"
statusstring

The current status of the reservation. Possible values are OPEN and RESOLVED.

Enum"OPEN""RESOLVED"
Example: "OPEN"
meta_infoobject(Solaris-Resources-MetaInfo)

An object containing all meta information related to the reservation.

expires_atstring
expired_atstring
resolved_atstring
descriptionstring
]
Response
application/json
[ { "id": "b814e2213c5c45149945ed53422db0c4cres", "amount": {}, "reservation_type": "CARD_AUTHORIZATION", "reference": "c222a0b8-07ea-49be-83c1-68719be286e6", "status": "OPEN", "meta_info": {}, "expires_at": "string", "expired_at": "string", "resolved_at": "string", "description": "string" } ]
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations