Get Authorization Holds
GET/authorization-holds
(In Development)
Authorization holds API allows balance blocking for transfer operations.
This allows for ensuring balance is available when a transfer is ordered and avoids balance not enough
failures.
Retrieve list of active authorization holds only.
Request
Query Parameters
Filter by Customer ID
Filter by Account ID
Possible values: <= 50
Limit number of results
Offset results by the specified number
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- GET_AUTH_HOLDS
Schema
Array [
]
- limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
- offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.
authorizationHolds
object[]
Authorization hold id.
Customer Id.
Customer account id.
Amount to block.
Possible values: >= 3 characters
and <= 3 characters
Currency alphabetic code as specified by ISO 4217
Represents RFC 3339, section 5.6 date-time.
Represents RFC 3339, section 5.6 date-time.
Possible values: [ACTIVE
, EXPIRED
, USED
, RELEASED
]
Status of the authorization hold.
meta
object
Contains paging information regarding the returned records, when response is paginated.
The input for paginated query contains two parameters:
Note! The total number of records is not returned, to prevent queries spanning on all records. If
numberOfRecords
<limit
, this means no further pages are available. On request of offset beyond the last record, the returnednumberOfRecords
is 0.
The number of previous pages can be calculated by dividing offset
to limit
.
This is the number of records returned in the lookup. Always numberOfRecords
is smaller than or equal to limit
.
This is the requested number of records to be returned per page.
This is the requested starting position of the response, where 0 is the first record.
This is the page of records on which the lookup starts. The starting page is 1.
{
"authorizationHolds": [
{
"id": "string",
"customerId": "5435323362",
"accountId": "string",
"amount": 0,
"currencyCode": "EUR",
"createdOn": "2021-07-15T17:54:12Z",
"expiresOn": "2021-07-15T17:54:12Z",
"status": "ACTIVE"
}
],
"meta": {
"numberOfRecords": 1,
"limit": 10,
"offset": 0,
"page": 1
}
}
{
"authorizationHolds": [
{
"id": "3423566434",
"customerId": "5435323362",
"accountId": "5014567344",
"amount": 50,
"currencyCode": "GBP",
"createdOn": "2021-07-15T17:54:12Z",
"expiresOn": "2100-01-01T00:00:00Z",
"status": "ACTIVE"
},
{
"id": "3423566465",
"customerId": "5435323362",
"accountId": "5014567344",
"amount": 20,
"currencyCode": "GBP",
"createdOn": "2021-06-15T17:54:12Z",
"expiresOn": "2100-01-01T00:00:00Z",
"status": "USED"
}
],
"meta": {
"numberOfRecords": 2,
"limit": 1,
"page": 0
}
}