AuthorizationHoldList

authorizationHolds object[]

Array [

idstring

Authorization hold id.

customerIdstringrequired

Customer Id.

Example: 5435323362

accountIdstring

Customer account id.

amountint64required

Amount to block.

currencyCodeCurrency (string)required

Currency alphabetic code as specified by ISO 4217

Possible values: >= 3 characters and <= 3 characters

Example: EUR

createdOndate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

expiresOndate-time

Represents RFC 3339, section 5.6 date-time.

Example: 2021-07-15T17:54:12Z

statusstring

Status of the authorization hold.

Possible values: [ACTIVE, EXPIRED, USED, RELEASED]

]

meta object

Contains paging information regarding the returned records, when response is paginated.

The input for paginated query contains two parameters:

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.

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 returned numberOfRecords is 0.

The number of previous pages can be calculated by dividing offset to limit.

numberOfRecordsinteger

This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

Example: 1

limitinteger

This is the requested number of records to be returned per page.

Example: 10

offsetinteger

This is the requested starting position of the response, where 0 is the first record.

Example: 0

pageinteger

This is the page of records on which the lookup starts. The starting page is 1.

Example: 1

AuthorizationHoldList
{
  "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
  }
}