Create Authorization Hold

POST 
/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.

Create a new authorization hold, to reserve balance for transfer of funds.

If expiresOn is not defined the authorization hold blocks funds indefinitely.

Request

application/json

Body

required

customerId stringrequired

Customer Id.

amount int64required

Amount to block.

currencyCode Currency (string)required

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

Currency alphabetic code as specified by ISO 4217

createdOn date-time

Represents RFC 3339, section 5.6 date-time.

expiresOn date-time

Represents RFC 3339, section 5.6 date-time.

status string

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

Status of the authorization hold.

Responses

201

Created

application/json

Schema

Schema

id string

Authorization hold id.

customerId stringrequired

Customer Id.

accountId string

Customer account id.

amount int64required

Amount to block.

currencyCode Currency (string)required

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

Currency alphabetic code as specified by ISO 4217

createdOn date-time

Represents RFC 3339, section 5.6 date-time.

expiresOn date-time

Represents RFC 3339, section 5.6 date-time.

status string

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

Status of the authorization hold.

Example (from schema)

{
  "id": "string",
  "customerId": "5435323362",
  "accountId": "string",
  "amount": 0,
  "currencyCode": "EUR",
  "createdOn": "2021-07-15T17:54:12Z",
  "expiresOn": "2021-07-15T17:54:12Z",
  "status": "ACTIVE"
}

CREATE_AUTHORISATION_HOLD_RESPONSE

{
  "id": "5983745394",
  "customerId": "5435323362",
  "accountId": "5014567344",
  "amount": 10000,
  "currencyCode": "GBP",
  "createdOn": "2021-07-15T17:54:12Z",
  "expiresOn": "2021-08-15T17:54:12Z",
  "status": "ACTIVE"
}

400

Unable to process request due to validation or other errors.

application/json

Schema

Schema

error

object

Represents details of an error.

code string

The error code.

message string

The description of the error.

details string[]

Details for the errors of any parameter value.

fieldErrors

object[]

List of field errors associated with the main error.

Array [

field string

Identifies the JSON request field.

error string

The problem associated with the field.

]

Example (from schema)

{
  "error": {
    "code": "string",
    "message": "string",
    "details": [
      "string"
    ],
    "fieldErrors": [
      {
        "field": "string",
        "error": "string"
      }
    ]
  }
}

CURRENCY_CODE_DOES_NOT_MATCH_TO_ACCOUNT_CURRENCY

{
  "code": "CURRENCY_CODE_DOES_NOT_MATCH_TO_ACCOUNT_CURRENCY",
  "message": "Requested currency code does not match the currency of the account",
  "details": [
    "Requested currency code does not match the currency of the account"
  ],
  "fieldErrors": [
    {
      "field": "currencyCode",
      "error": "Requested currency code does not match the currency of the account"
    }
  ]
}

Loading...