v1

latestOpenAPI 3.0.02026-07-24270120.1 KB

Beneficiary

API to add/modify a Beneficiary for a Customer ID at a supported bank.

post/beneficiary

Request body

entityIdstring required

Entity ID for your organization

programIdstring required

Program id related to beneficiary activity

bankCodestring required

4-character bank code (see example table) where beneficiary is linked

customerIdstring required

Your unique internal reference number for this payout request.

makerIdstring

Required only if you need to use maker-checker functionality with the bank.

checkerIdstring

Required only if you need to use maker-checker functionality with the bank.

checksumstring required

The generated checksum. Hash the beneficiary object using SHA-256.

callbackUrlstring

The API endpoint where we will submit updates on the beneficiary status for each custRefNo.

beneficiary.reqModestring required

String Use A to add beneficiary - Use M to modify beneficiary, Use D to deactivate beneficiary

beneficiary.txnTypestring required

IMPS/NEFT/RTGS/IFT or a combination separated by ‘|’. (For example: NEFT|RTGS|IMPS)

beneficiary.benCode string

Unique Beneficiary code

beneficiary.benName string

Beneficiary name

beneficiary.benIFSCstring required

IFS code for the beneficiary bank account

beneficiary.benAcctNostring required

Beneficiary account number

beneficiary.Emailstring required

Beneficiary email address

beneficiary.Mobilestring required

Beneficiary mobile number (without country code)

beneficiary.remarksstring

Remarks for this action

externalReferenceNumberstring required

Your unique external reference number for this payout request

Response

Successful response

custRefNostring

Alphanumeric reference received in the request

statusstring

'success' if request is successful, 'error' if error has occurred

messagestring

Success or Error message