Hold Amount
Developing
POST
/core/account/hold-amount
Hold Amount
from the withdrawable balance but the account otherwise stays fully operational. The hold is
identified by the
resourceId returned in the response.Request Body
| Field Name | Type | Required | Description |
|---|---|---|---|
nuban | string | TRUE | Account number (NUBAN) to place the hold on. |
amount | number | TRUE | Amount to hold. Must be 0.01 or greater. |
reasonForBlock | string | TRUE | Reason recorded against the hold. Maximum 100 characters. |
{
"nuban": "0000000206",
"amount": 5000.00,
"reasonForBlock": "Loan collateral"
}Response
| Field Name | Type | Description |
|---|---|---|
officeId | integer | Identifier of the office that owns the client / account. |
clientId | integer | Client identifier of the account holder. |
savingsId | integer | Savings account ID identifier. |
resourceId | integer | This is the hold (lien) transaction id – supply it as holdTransactionId when calling release-amount. |
Request
None
Request Code Samples
Responses
Modified at 2026-09-04 10:57:00