Sign in
Bank account holds

Fetches a single hold by ID.

get/v0/bank/holds/{hold-id}

Path parameters

hold-idstring required

Response

OK

expires-atstring date-time

ISO 8601 formatted date-time.

origin-type'card-transaction' required
updated-atstring date-time required

ISO 8601 formatted date-time.

origin-metadataobject

Identifiers from the system that originated the hold or transaction. Keys and values are originator-specific.

direction'debit' | 'credit' required
status'released' | 'placed' required
created-atstring date-time required

ISO 8601 formatted date-time.

release-reasonstring

The final release reason (e.g. clearing, expiry, reversal

Example response

{
  "amount": {
    "currency": "GBP",
    "value": "1000.00"
  }
}