Skip to main content
Version: 1.2.0 - Production

Withdraw

POST 
/v1.2/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.

Security account number or cash account number is required. Cash account number will be prioritized

Request​

Header Parameters

    Throttle-Key string

Body

    accountNumber stringrequired

    The Security account number

    cashAccountNumber string

    The Cash 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​

OK

Schema
    requestId number
    amount number
    narration string

    Possible values: non-empty

    status stringrequired

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

    cashAccountNumber string
    reason string
    rejectCode number

    Find error codes here

Loading...
Is this page helpful for you?
Last updated on