post https://payout-gamma.cashfree.com/payout/v1.2/requestBatchTransfer
Use this API to initiate transfers to multiple beneficiaries. This API accepts an array of transfer objects under the batch field.
Version 2 APIs
We provide version 2 APIs for Payouts that benefits you in multiple ways.
Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)
Get Batch Transfer Status
Use the Get Batch Transfer Status V1.2 API to get the status of the batch transfer request. The Get Transfer Status V1.2 API does not give you the status of the batch transfer requests. Read the batch transfer document to understand the flow of the API.
Click to view details about batch format.
Batch Format
| Value | Description |
|---|---|
| BENEFICIARY_ID | With this value, beneId and transferMode must be passed in the transfer object within the batch array alphanumeric and underscore allowed (60 character limit) If batchFormat is set to any of the below values, transfers will only be processed via specified mode. |
| BANK_ACCOUNT | With this value, Additional details such as bankAccount, ifsc, name, email, phone must be passed in the transfer object within the batch array |
| UPI | With this value, Additional details such as vpa, name, email, phone must be passed in the transfer object within the batch array |
| PAYTM | With this value, Additional details such as name, email, phone must be passed in the transfer object within the batch array |
| AMAZONPAY | With this value, Additional details such as name, email, phone must be passed in the transfer object within the batch array |
Click to view the details of transfer objects.
Transfer Objects
| Field Name | Description |
|---|---|
| transferId | A unique transfer id. |
| amount | Amount to be transferred. |
| beneId | The ID of the beneficiary. This field must be passed if the batch format option is BENEFICIARY_ID. |
| transferMode | Required only when batchFormat is set to BENEFICIARY_ID, mode of transfer for each transfer in batch needs to be set. Allowed values are: banktransfer, upi, paytm, and amazonpay |
| bankAccount | Bank account number for payout. This field must be passed if the batch format option is BANK_ACCOUNT. |
| ifsc | IFSC of the corresponding bank account. This field must be passed if the batch format option is BANK_ACCOUNT. |
| vpa [optional] | VPA of the corresponding user. This field must be passed if the batch format option is UPI. |
| name | Name of the account holder. This field must be passed if the batch format option is BANK_ACCOUNT. |
| email [optional] | Email of the beneficiary. This field must be passed if the batch format option is BANK_ACCOUNT. |
| phone | The phone of the beneficiary. This field must be passed if the batch format option is BANK_ACCOUNT/PAYTM/AMAZONPAY. |
| remarks [optional] | Remarks, if any. |
Currently, batch transfer supports transfers to bank accounts, UPI, Paytm, and Amazon Pay. If the beneficiary object does not have valid details attached to it, the transfer fails.
Click to view the response codes.
Response Codes
| Sub Code | Status | Message | Next Action |
|---|---|---|---|
| 200 | SUCCESS | Batch Transfer requested successfully. Please check later for processing status. | - |
| 200 | SUCCESS | beneficiary already exists with a different name. Please delete | |
| 202 | PENDING | Request received. Please check status after some time. | - |
| 403 | ERROR | Token is not valid | Verify the generated token. |
| 403 | ERROR | Permission Denied | |
| 409 | ERROR | Invalid Batch Format | Enter valid batch format details. |
| 409 | ERROR | Batch TransferId already exists | Enter a valid batch transfer ID. |
| 412 | ERROR | Token missing in the request | Enter a valid token in the request. |
| 422 | ERROR | Batch transfer id is missing | Enter a valid batch transfer ID. |
| 422 | ERROR | Batch format is missing | Enter valid batch format details. |
| 422 | ERROR | Invalid Batch Transfer Id provided | Enter a valid batch transfer ID. |
| 422 | ERROR | Please provide at least one transfer entry | Enter at least one transfer entry. |
| 422 | ERROR | The maximum number of entries allowed per file is 500, please try again. | Enter only a maximum of 500 entries per file. |
| 422 | ERROR | Transfer Parameters missing in the request | Enter all the required transfer parameters in the request. |
| 520 | ERROR | Unknown error occurred at batchTransfer | |
| 520 | ERROR | Batch Transfer request failed | |
| 520 | ERROR | Error in batch transfer | |
| 520 | ERROR | Unknown error occurred |