Sign in
Reservations

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

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.<br> 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.

get/v1/accounts/{account_id}/reservations

Path parameters

account_idstring required

Unique identifier of a customer's account.

Query parameters

page[number]string

Returns a specific page of results.

page[size]string

Determines the size of each page of results.

filter[type]'CardAuthorization' | 'SepaCreditTransfer' | 'ClearingTransaction' | 'IntraCustomerTransfer' | 'SepaCreditBatch' | 'Seizure' | 'SecuritiesPurchase' | 'PendingTrade' | 'SEPAInstantCreditTransfer'

Filters the returned reservations by type.

filter[id]string

Filters the returned reservations by ID.

filter[status]'OPEN' | 'RESOLVED'

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

sort'created_at' | '-created_at'

Sorts the returned reservations by created_at date.

Response

Successfully fetched the reservations.

idstring

ID of the reservation.

descriptionstring

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

account_idstring

ID of the account to which the reservation is attached.

ibanstring

IBAN of the account to which the reservation is attached.

type'CardAuthorization' | 'SepaCreditTransfer' | 'ClearingTransaction' | 'IntraCustomerTransfer' | 'SepaCreditBatch' | 'Seizure' | 'SecuritiesPurchase' | 'PendingTrade' | 'SEPAInstantCreditTransfer'
referencestring

Internal reference number for the reservation.

status'OPEN' | 'RESOLVED'

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

created_atstring

UTC timestamp from when the reservation was created.

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 response

[
  {
    "id": "162ddd7e-790c-5963-908f-4cedfd30f9a1",
    "account_id": "e48c29b85992b8772eb7ddd518490920cacc",
    "iban": "DE84110101010001234567",
    "amount": {
      "value": 800,
      "unit": "cents",
      "currency": "EUR"
    },
    "reference": "85f20dc2-190f-47d3-94c7-2737ca71f286",
    "status": "OPEN",
    "meta_info": {
      "merchant": {
        "country_code": "DE",
        "category_code": "6011",
        "name": "BERLINER VOLKSBANK EG",
        "town": "TXL ABFLUG"
      },
      "original_amount": {
        "currency": "EUR",
        "value": -1000,
        "fx_rate": 1
      },
      "pos_entry_mode": "CHIP",
      "trace_id": "651afb5beea67124d57be6dee27a2c5b7a241e58",
      "transaction_date": "2021-10-11",
      "transaction_time": "2021-10-11T22:33:26Z",
      "transaction_type": "PURCHASE",
      "wallet_type": "GOOGLE",
      "device_pan": "4537920000006141"
    },
    "created_at": "2022-06-20T18:49:49Z",
    "resolved_at": "null"
  }
]