Error
A valid request URL is required to generate request examples{
"status": "00",
"message": "The process was completed successfully",
"data": {
"reference": "HLD123456789"
}
}{
"status": "01",
"error_code": "MISSING_FIELD",
"message": "The field is missing",
"data": {}
}{
"status": "02",
"message": "The authentication failed",
"data": {}
}{
"status": "03",
"message": "You are not allowed to perform this operation",
"data": {}
}{
"status": "04",
"message": "The resource you are looking for does not exist",
"data": {}
}{
"status": "05",
"message": "An unknown error occurred",
"data": {}
}Accounts
Place Hold on Account
Place a hold on funds in an account
POST
/
accounts
/
{account_number}
/
holds
Error
A valid request URL is required to generate request examples{
"status": "00",
"message": "The process was completed successfully",
"data": {
"reference": "HLD123456789"
}
}{
"status": "01",
"error_code": "MISSING_FIELD",
"message": "The field is missing",
"data": {}
}{
"status": "02",
"message": "The authentication failed",
"data": {}
}{
"status": "03",
"message": "You are not allowed to perform this operation",
"data": {}
}{
"status": "04",
"message": "The resource you are looking for does not exist",
"data": {}
}{
"status": "05",
"message": "An unknown error occurred",
"data": {}
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Connection ID for the target bank
Unique key to ensure idempotency of the request
SHA-256 signature of client_secret + ";" + idempotency-key
Path Parameters
Account number in NUBAN format
Body
application/json
A unique internal reference to the specific transaction
Example:
"HLD123456789"
Transaction amount to be held
Example:
500
A description stating the reason the funds where held
Example:
"Loan repayment hold"
The time when the API Provider should commence holding the funds
Example:
"2024-03-20"
The date when the API Provider should release the funds from customer account if no payment is made against the held funds
Example:
"2024-04-20"
The status of the hold
Available options:
ACTIVE, INACTIVE Example:
"ACTIVE"
Show child attributes
Show child attributes