post https://in.staging.decentro.tech/decentro/bulk/bulk_payout
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/decentro/bulk/bulk_payout |
| Production | https://in.decentro.tech/decentro/bulk/bulk_payout |
This API allows you to facilitate money transfers to/from the linked virtual bank accounts of your customers from within your application.
API Specifications
Request Payload
| Request Parameter | Mandatory (M) / Optional (O) / Conditional Mandatory (CM) | Description |
|---|---|---|
| reference_id | M | A URN to be passed by the user for each batch API request. Alphanumeric values are allowed. Special characters such as “@ # $ % ^ & * ! ; : ~ ` ? = + ) ( apostrophe, double quotes” are not allowed. |
| input_type | M | "JSON" is to be passed |
| input | M | The object where the payout details must be passed. |
| reference_id | M | A URN to be passed by the user for each API request. Alphanumeric values are allowed. Special characters such as “@ # $ % ^ & * ! ; : ~ ` ? = + ) ( apostrophe, double quotes” are not allowed. This parameter can be used for platforms internal mapping of the API request |
| purpose_message | M | 1. The narration/remarks that will be displayed in the beneficiaries bank statement. 2. Only Alphanumeric values are allowed, special characters such as “@ # $ % ^ & * ! ; : ~ ` ? = + ) ( apostrophe, double quotes” are not allowed. 3. Minimum length is 5 characters and Maximum length is 255 characters |
| from_account | M | The virtual account against which the payout must be performed. The virtual account added must belong to the provider selected. |
| to_account | CM | The Beneficiary Account to be added. 1. "to_account" is mandatory if the intended transfer type is IMPS/NEFT/RTGS. 2. "ifsc_code" parameter is required for IMPS/NEFT/RTGS transfers. 3. If the transfer type is set as UPI, this parameter is not required. |
| to_upi | CM | Beneficiary UPI ID to be passed. 'to_upi’ 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 |
| transfer_type | M | UPI/IMPS/NEFT/RTGS are the available transfer type |
| transfer_amount | M | The Amount to be transferred.Minimum amount is INR 1 (2 Decimal values are allowed Ex: 1.00) |
| beneficiary_code | CM | A URN generated when a beneficiary is created by using Manage Beneficiary API. If the beneficiary_details is passed in the API, then beneficiary_code is not required. |
| beneficiary_details | CM | An object that contains 4 parameters that are required to add the details of the beneficiary. If beneficiary_code is passed in the API, then beneficiary_details are not required. |
| payee_name | M | Beneficiary name to be added. |
| ifsc_code | CM | 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 |
| email_address | O | Beneficiary Email Address to be added. Alphanumeric and special characters are allowed but after (@), only dot(.) is allowed. Sample email format ([email protected]) |
| mobile_number | O | Mobile numbers have to be strictly 10 digits long and start with one of 9, 8, 7 or 6. Only numeric characters are allowed. Country code is not required. |
Response Payload
| Response Parameter | Mandatory (M) / Optional (O) / Conditional Mandatory (CM) | Description |
|---|---|---|
| status | M | The status of the batch API request. These are the statuses available 1. Success 2. Failure |
| decentroTxnId | M | A URN generated by Decentro against the API request |
| download_url | O | A link to the csv file generated that contains the request and response payload for each payout API initiated. This parameter is only available when status is "Success" |
| response_key | O | The response key of the API. This parameter is only available when status is "Failure". |
| message | O | The message on the status of the API action. This parameter is only available when status is "Success" |
Simulation Data
Decentro provides the test data which will simulate various scenarios of the API when a transaction takes place.
Note: This test data is only valid in the Staging environment. Account details passed in the from_account parameter must match the provider secret passed in the headers.
Important: Please refer to the Simulation Data guide here