get https://in.staging.decentro.tech/v2/banking/account/beneficiaries
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/account/beneficiaries |
| Production | https://in.decentro.tech/v2/banking/account/beneficiaries |
This API can be used by you to check all the beneficiaries created in Decentro's system.
Three parameters are present -
- provider_code: (Mandatory) The provider code must be passed here. The values available are all,yesb,icic,dbss,idfb
- sender_account_number : (Optional) The sender Virtual Account Number must be passed here.
- beneficicary_code: (Optional) The beneficiary code must be passed here. Only 1 beneficiary_code can be passed.
API specifications
Response Payload
| Response Parameter | Mandatory (M) / Optional (O) / Conditional Mandatory (CM) | Description |
|---|---|---|
| status | M | The status of the API. The following values will be populated. Success = The API request was successful Failure = The API request was a failure |
| decentro_txn_id | M | a URN generated by Decentro for the API request. |
| response_keys | M | Response key documenting the status of the API hit and various errors |
| response_message | M | API status message. |
| data | CM | An Object that contains the below parameters. The object will be populated when the API request is successful |
| sender_account_number | CM | The sender virtual account addis ed against the beneficiary. |
| beneficiary_code | CM | The code generated when a beneficiary is created |
| beneficiary_account_number | CM | The beneficiary account number added |
| beneficiary_ifsc | CM | The beneficiary ifsc added. |
| beneficiary_upi_handle | CM | The beneficiary UPI ID was added. |
| CM | The beneficiary email addresses | |
| mobile | CM | The beneficiary mobile number |
| transfer_type | CM | The transfer type assigned to the beneficiary 1. IMPS 2. NEFT 3. RTGS 4. UPI 5. ANY |
| provider | CM | The provider against the sender virtual account |
| name | CM | The beneficiary mobile number |