Manage Beneficiaries v2

🙌

Important Note

Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.

API Endpoints

Add / Modify / Disable any beneficiary for sending money from the virtual account (on top of the underlying physical bank account)

API Specifications

Request Payload

Request ParameterMandatory (M) / Optional (O) / Conditional Mandatory (CM)Description
actionMADD/MODIFY/VERIFY/DELETE are the actions available
beneficiary_codeCMThe Beneficiary code generated after adding a beneficiary.
To be passed when the ‘action’ is MODIFY/VERIFY/DISABLE
sender_account_numberMThe virtual account against which the beneficiary is added. The virtual account added must belong to the provider selected.
account_numberCMThe beneficiary account to be added.

1. Mandatory only for ‘action’ is ADD.

2. Not required for MODIFY/DELETE
upi_handleCMBeneficiary UPI ID to be passed. 'upi_handle’ is mandatory if the intended transfer type is UPI.

1. ‘ifsc’ parameter is not required for UPI transfer.

2. Special characters such as dot(.) are accepted for values after (@) sign.

3. The UPI ID must follow the NPCI format (Ex: name@bankName or mobilenumber@bankName).

4. If the transfer type is selected as IMPS/NEFT/RTGS, this parameter is not required
ifscCMThe beneficiary IFSC code to be added.

1. Alphanumeric values are allowed as per the IFSC code assigned to the beneficiary bank.

2. If the transfer type is UPI, this parameter is not required.

3. Maximum length is 11 characters
transfer_typeCMIMPS/NEFT/RTGS are the transfer type to be passed
nameCMThe beneficiary name to be added. Mandatory if ‘action’ is ADD. ‘MODIFY’ action is available
mobile_numberCMThe beneficiary mobile number to be added.
Mandatory if ‘action’ is ADD.
‘MODIFY’ action is available
emailCMThe beneficiary email address to be added.
Mandatory if ‘action’ is ADD.
‘MODIFY’ action is available
sender_mobileOThe remitter/VA mobile to be passed.

Response Payload

Response ParameterMandatory (M) / Optional (O) / Conditional Mandatory (CM)Description
decentroTxnIDMA URN generated by Decentro against the API request
statusMThe status of the API Request
responseCodeMThe response code of the API request
messageMMessage propagated against the API action
dataCMObject
ifscCMThe beneficiary IFSC code

1.Mandatory for a successful API response

2. Optional for a non-successful I response
accountNumberCMThe beneficiary Account Number

1. Mandatory for a successful API response

2. Optional for a non-successful API response
beneficiaryCodeCMThe Beneficiary code

1. Mandatory for a successful API response

2. Optional for a non-successful API response
beneficiaryNameCMThe Benficiary Name

1. Mandatory for 'ADD','MODIFY','VERIFY' and 'DISABLE'

2. Optional for 'MODIFY' when there no modification required for beneficiary name
Language
Click Try It! to start a request and see the response here!