post https://in.staging.decentro.tech/v2/banking/beneficiary
Important Note
Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.
API Endpoints
| Environment | Endpoint |
|---|---|
| Staging / Sandbox | https://in.staging.decentro.tech/v2/banking/beneficiary |
| Production | https://in.decentro.tech/v2/banking/beneficiary |
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 Parameter | Mandatory (M) / Optional (O) / Conditional Mandatory (CM) | Description |
|---|---|---|
| action | M | ADD/MODIFY/VERIFY/DISABLE are the actions available |
| beneficiary_code | CM | The Beneficiary code generated after adding a beneficiary. To be passed when the ‘action’ is MODIFY/VERIFY/DISABLE |
| sender_account_number | M | The virtual account against which the beneficiary is added. The virtual account added must belong to the provider selected. |
| account_number | CM | The beneficiary account is to be added. 1. Mandatory only for ‘action’ is ADD. 2. Not required for MODIFY/DISABLE |
| upi_handle | CM | Beneficiary 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 |
| ifsc | CM | The 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_type | CM | IMPS/NEFT/RTGS/ANY are the transfer type to be passed |
| name | CM | The beneficiary name to be added. Mandatory if ‘action’ is ADD. ‘MODIFY’ action is available |
| mobile_number | O | The beneficiary mobile number to be added. |
| O | The beneficiary email address to be added. | |
| sender_mobile | O | The remitter/VA mobile to be passed. |
Response Payload
| Response Parameter | Mandatory (M) / Optional (O) / Conditional Mandatory (CM) | Description |
|---|---|---|
| decentroTxnID | M | A URN generated by Decentro against the API request |
| status | M | The status of the API Request |
| responseCode | M | The response code of the API request |
| message | M | Message propagated against the API action |
| data | CM | Object |
| ifsc | CM | The beneficiary IFSC code 1.Mandatory for a successful API response 2. Optional for a non-successful I response |
| accountNumber | CM | The beneficiary Account Number 1. Mandatory for a successful API response 2. Optional for a non-successful API response |
| beneficiaryCode | CM | The Beneficiary code. The beneficiary code will be a URN mapped against the beneficiary addition. 1. Mandatory for a successful API response 2. Optional for a non-successful API response |
| beneficiaryName | CM | The Beneficiary Name 1. Mandatory for 'ADD', 'MODIFY', 'VERIFY', and 'DISABLE' 2. Optional for 'MODIFY' when there is no modification required for beneficiary name |