Deposit Request

POST 
/deposit-request

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

This facilitates a request from the end customer to deposit a specified amount into their cash account within the system.

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 stringrequired

Possible values: non-empty

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

currency stringrequired

Example: USD

depositType stringrequired

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

0 for Cheque, 1 for Bank, 2 for Cash

chequeNumber string
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

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

{
  "status": "SUCCESS",
  "reason": "N/A",
  "rejectCode": 0,
  "requestId": 1674717955022,
  "amount": 10000,
  "narration": "N/A"
}

Loading...