Withdraw

POST /transfers/withdraw

Description

Initiate a withdrawal transfer.

Path Parameters

Name	Type	Description
None		No parameters

Request Headers

Name	Type	Description
countryCode	string	The country code (header)
tenantId	string	The tenant ID (header)
userId	string	The user ID (header)

Request Body

• Content Type: application/json

{
  "debitAccountId": "string",
  "amount": 100,
  "recipientName": "string",
  "recipientBankCode": "string",
  "recipientAccountNumber": "string",
  "userId": "string",
  "requestId": "string",
  "narration": "string",
  "settlementUuId": "string"
}

Response Code: 200 - OK

Description

Withdraw successful.

Response Fields

Field	Type	Description
status	boolean	Indicates if the operation was successful
statusCode	integer	Status code
message	string	Response message
data	object	Data related to the withdrawal
errors	array	List of error messages, if any

Example

{
  "status": true,
  "statusCode": 0,
  "message": "Withdraw successful",
  "data": {},
  "errors": [
    {
      "message": "Some error occurred",
      "descriptiveMessage": "Detailed error message"
    }
  ]
}

Headers

Content-Type	Value
apiKey	{{apiKey}}
countryCode	string
tenantId	string
userId	string

Body

{
  "debitAccountId": "acc123",
  "amount": 100,
  "recipientName": "John Doe",
  "recipientBankCode": "001",
  "recipientAccountNumber": "123456789",
  "userId": "usr456",
  "requestId": "req789",
  "narration": "Withdrawal request",
  "settlementUuId": "settle123"
}

🔑 Authentication bearer

Param	Value	Type
token	{{accessCode}}	string