Error
A valid request URL is required to generate request examples{
"status": "00",
"message": "Account holds retrieved successfully",
"data": {
"holds": [
{
"account_number": "0123456789",
"reference": "HLD123456789",
"amount": 500,
"narration": "Loan repayment hold",
"start_hold_date": "2024-03-20",
"end_hold_date": "2024-04-20",
"status": "ACTIVE"
}
]
}
}{
"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
Get Account Holds
Get all holds placed on an account
GET
/
accounts
/
{account_number}
/
holds
Error
A valid request URL is required to generate request examples{
"status": "00",
"message": "Account holds retrieved successfully",
"data": {
"holds": [
{
"account_number": "0123456789",
"reference": "HLD123456789",
"amount": 500,
"narration": "Loan repayment hold",
"start_hold_date": "2024-03-20",
"end_hold_date": "2024-04-20",
"status": "ACTIVE"
}
]
}
}{
"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