Withdraw

POST 
/v1.1/finance/withdraw

This is used to request to withdraw some amount from a customer cash account in the system by the end customer.

This function serves as a request to withdraw a specific amount from a customer's cash account within the system, initiated by the end customer.

Request

application/json

Body

accountNumber stringrequired

The Security account number

amount numberrequired

The amount

bankId numberrequired

Find valid bank id for the institution Master Data > Get Institutional Bank Accounts

bankAccountNumber string

Find customer bank account numbers Master Data > Get Customer Bank Accounts

withdrawalType stringrequired

Possible values: non-empty, [0, 1, 2]

0 for Cheque, 1 for Bank, 2 for Cash

location string
currency stringrequired

The currency

Example: USD

chequeDate string

Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])$

Example: 2022/04/04

valueDate string

Possible values: Value must match regular expression ^[0-9]{4}/(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])$

Example: 2022/04/04

referenceNumber string

reference Id for the transaction

Responses

200

OK

application/json

Schema

Schema

requestId number
amount number
narration string

Possible values: non-empty

status stringrequired

Possible values: non-empty, [SUCCESS, FAILED]

reason string
rejectCode number

Find error codes here

Example (from schema)

{
  "requestId": 0,
  "amount": 0,
  "narration": "string",
  "status": "SUCCESS",
  "reason": "string",
  "rejectCode": 0
}

example

{
  "requestId": 0,
  "amount": 15000,
  "narration": "Withdrawal amount is less than the minimum withdrawal amount. Minimum withdrawal amount is USD 10000.0. Please Contact Customer Service at 077123123 for further inquiry",
  "status": "SUCCESS",
  "reason": "",
  "rejectCode": 0
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status string
error string
message string
path string
rejectCode string

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.1/finance/withdraw",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.1/finance/withdraw",
  "rejectCode": "1007"
}

Loading...