Skip to main content
PATCH
/
accounts
/
{account_number}
/
holds
/
{hold_reference}
Error
A valid request URL is required to generate request examples
{
  "status": "00",
  "message": "Hold released successfully",
  "data": {
    "reference": "ABCD12345678901234567890"
  }
}
{
  "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

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
connection-id
string

Connection ID for the target bank

​
idempotency-key
string
required

Unique key to ensure idempotency of the request

​
signature
string
required

SHA-256 signature of client_secret + ";" + idempotency-key

Path Parameters

​
account_number
string
required

Account number in NUBAN format

Example:

"0123456789"

​
hold_reference
string
required

Unique reference of the hold to release

Example:

"HLD123456789"

Body

application/json
​
status
enum<string>
required

The status of the hold

Available options:
ACTIVE,
INACTIVE
Example:

"INACTIVE"

Response

Hold released successfully

​
status
string
required
Example:

"00"

​
message
string
required
Example:

"Hold released successfully"

​
data
object
required