Sign in

v1

latestOpenAPI 3.0.02026-07-24270120.1 KB

Bank Payout

API to request payment from bank accounts enabled for this functionality. If Multi-Factor Authentication is enabled in Program configuration then the OTP will be sent out using the method selected.

post/bank-payout

Request body

entityIdstring required

Entity ID for your organization

programIdstring required

Program ID related to payout activity

bankCodestring required

4-character bank code (see example table below)

customerIdstring required

Customer / Corporate ID issued by the bank for the account to be debited.

custTxnRefNostring required

Your unique internal reference number for this payout request.

externalReferenceNumberstring

A unique reference number for this payoutrequest

debitAcctNostring required

The account from which the amount should be debited.

callbackUrlstring

The API endpoint where we will submit updates on the payment status for each custTxnRefNo.

payment.txnTypestring required

IMPS/NEFT/RTGS/IFT

payment.amountnumber required

Num The amount to be debited for this payout request. Positive values only will be considered.

payment.valueDatestring required

The value date to be posted for this transaction in YYYY-MM-DD format. Should be the current date only.

payment.benCodestring

Beneficiary code. Required for Beneficiary Code based payout

payment.benNamestring required

Beneficiary name

payment.benIFSCstring

IFS code for the beneficiary bank account. Required for Beneficiary Account based payout

payment.benAcctNostring

Beneficiary account number. Required for Beneficiary Account based payout

payment.benEmailstring

Beneficiary email address

payment.benMobilestring

Beneficiary mobile number (without country code)

payment.descriptionstring

description for the transaction

payment.remark1string

Remark for the transaction

payment.remark2string

Remark for the transaction

payment.remark3string

Remark for the transaction

Response

Successful response

custTxnRefNostring

Alphanumeric reference received in the request

statusstring

success / failure

messagestring

success / failure

entityIdstring

Entity ID for your organization

utrNostring

UTR No. for the payout

programIdstring

programId