Bulk Payouts CSV
This page gives you an overivew of Decentro's bulk payouts capabilities.
Overview
Decentro, as part of its payments module, provides various capabilities to handle features like payouts, collections, and recurring collections. While most of these capabilities work very well for one transaction at a time, they become challenging to handle when there are multiple transactions, such as payouts, VPA validation, account verification, etc. This can result in the platform having a sub-par experience and the beneficiary not getting the desired service.
Keeping this in mind, Decentro has designed its Hulk Platform that can take in tasks up to 1000s of records at a single time and process everything at its end without the platform having to work on writing scripts, etc.
Note: Decentro's dashboard will soon be having all of these features so that a platform can just leverage the same instead of these APIs.
Integration
Decentro provides the below capabilities in batch mode.
- Batch Payouts: this is designed to help platforms undertake payouts to multiple beneficiaries without having to integrate the same into their system. The Batch Payouts can be performed by passing the input as csv or JSON
- Batch Validate Bank Account: this is designed to help platforms undertake account verification of multiple beneficiaries before undertaking a payout.
Bulk Payouts CSV
Decentro provides a method to transfer funds to multiple accounts in one go by using Batch Payout API. By using this Batch Payout API, platforms can now transfer funds to multiple bank accounts all at once, with just a single API request. This streamlines the process and makes it more efficient for users.
To use this API, customers must pass a .csv file to the API with the following details inside the input file as per a standard template.
Bulk Payout Input File Template
Here is a CSV Template to pass as the input file to the API. Customers can download this template
Input File
| Columns | Type | Mandatory (M)/ Conditional Mandatory (CM)/Optional (O) | Description |
|---|---|---|---|
| reference_id | Text | O | A unique reference ID created by the customer for every transaction. Column header not required if this parameter is not passed. |
| purpose_message | Text | M | Message/Narration of the transaction being performed |
| from_account | Text | M | The virtual account provided by Decentro |
| to_account | Text | CM | The Beneficiary account number.. The column header must exist but the values can be blank. |
| to_upi | Text | CM | The Beneficiary UPI ID to be passed. If this field is provided, "beneficiary_details.ifsc_code" is not to be added. The column header must exist but the values can be blank. |
| transfer_type | Text | M | UPI, IMPS, NEFT and RTGS |
| transfer_amount | Text | M | The amount that needs to be transferred |
| beneficiary_details.payee_name | Text | M | The account number which needs to be validated. |
| beneficiary_details.ifsc_code | Text | CM | The IFSC code of the account which needs to be validated. Not required when "to_upi" is to be passed. The column header must exist but the values can be blank. |
| beneficiary_details.mobile_number | Text | O | The beneficiary mobile number. The column header must exist but the values can be blank. |
| beneficiary_code | Text | CM | The URN generated for adding a beneficiary using manage beneficiary. If this field is passed, then "beneficiary_details.payee_name","beneficiary_details.mobile_number" and "beneficiary_details.ifsc_code" are not to be added. The column header must exist but the values can be blank. |
Note
All of the above parameters are mandatory. The minimum number of entries is 10(Excluding the column headers) and the maximum number of entries is 100.
Please refer to Initiate Payout API request parameters on the validations being performed on each parameter
After submitting the input file to the API, the API will first examine the file's columns to ensure they are valid. Once the columns are confirmed to be correct, the API will then begin the bulk process for the inputs in the file.
After the input file has been successfully processed and the bulk processing is completed, Decentro will send the output file to the customer's registered email address. This output file will contain the results of the transaction status and details of the accounts listed in the input file.
The following details will appear in the output file
Output File
| Columns | Description |
|---|---|
| Reference ID | The Unique reference ID passed by the customer for each transaction |
| Decentro Transaction ID | Unique Reference ID generated by Decentro for each Transaction |
| Account Number | The Beneficiary Account Number |
| IFSC Code | The Beneficiary IFSC Code |
| Request Status | This is the status of the validation request Success: The request has been successfully accepted Failure: There was a problem with the request. Please check the Error Reason column. |
| Amount | The amount of the transaction |
| Transaction Status | This is the status of the transaction for the beneficiary account number Success: The transaction was successfully processed. Failure: The transaction failed Pending: The transaction is in a pending state. Please check the status using Get Transaction Status API |
| Message | The transaction message |
| Bank Reference Number | The bank reference number of the transaction |
| Account Holder’s Name | The name of the beneficiary will be present here, the name will appear of the account is valid |
| New Balance | The balance of the virtual account after the transfer of funds |
Link to Batch Payout CSV API
Updated about 2 months ago