Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Bank account holds

Lists all holds on a bank account. Use filter[status][in][] to filter by specific statuses. Use filter[updated-at][gte] to return only holds last updated at or after a timestamp. Use filter[origin-type][eq] to filter by origin type.

get/v0/bank/accounts/{bank-account-id}/holds

Path parameters

bank-account-idstring required

Query parameters

filter[origin-type][eq]'card-transaction'
filter[updated-at][gte]string date-time

Return only holds updated at or after the given timestamp.

filter[status][in][]string[]
sort'-created-at' | 'created-at'
page[size]integer
page[after]string byte

A base64 encoded opaque string returned in paginated responses.

page[before]string byte

A base64 encoded opaque string returned in paginated responses.

Response

OK

Example response

{
  "holds": [
    {
      "amount": {
        "currency": "GBP",
        "value": "1000.00"
      }
    }
  ]
}