Skip to main content
POST
Create an authorization hold

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

auditUser
string
required

The audit user to log the request

Body

application/json

The fields that you want to apply to your newly created authorization hold transaction

accountId
string<biginteger>
required

Account id

type
enum<string>
required

Authorization hold type

Available options:
AHOLD,
PBALPAY
amount
number
required

Amount to hold

Required range: x > 0
currency
string
required

A valid ISO 4217 currency code

Pattern: [A-Z]{3}
Example:

"EUR"

text
string

Free text

Maximum string length: 255

Response

Authorization hold created successfully

authorizationTransactionId
string<biginteger>

Transaction Id of generated authorization request