v1
latestOpenAPI 3.0.02026-07-24270120.1 KBBeneficiary
API to add/modify a Beneficiary for a Customer ID at a supported bank.
Request body
Entity ID for your organization
Program id related to beneficiary activity
4-character bank code (see example table) where beneficiary is linked
Your unique internal reference number for this payout request.
Required only if you need to use maker-checker functionality with the bank.
Required only if you need to use maker-checker functionality with the bank.
The generated checksum. Hash the beneficiary object using SHA-256.
The API endpoint where we will submit updates on the beneficiary status for each custRefNo.
String Use A to add beneficiary - Use M to modify beneficiary, Use D to deactivate beneficiary
IMPS/NEFT/RTGS/IFT or a combination separated by ‘|’. (For example: NEFT|RTGS|IMPS)
Unique Beneficiary code
Beneficiary name
IFS code for the beneficiary bank account
Beneficiary account number
Beneficiary email address
Beneficiary mobile number (without country code)
Remarks for this action
Your unique external reference number for this payout request
Response
Successful response
Alphanumeric reference received in the request
'success' if request is successful, 'error' if error has occurred
Success or Error message