Batch Transfer V1.2

Use this API to create transfers to multiple beneficiaries. This API accepts an array of transfer objects under the batch field.

Click to view details about batch format, transfer objects, and response codes.

Batch Format

ValueDescription
BENEFICIARY_IDWith 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_ACCOUNTWith this value, Additional details such as bankAccount, ifsc, name, email, phone must be passed in the transfer object within the batch array
UPIWith this value, Additional details such as vpa, name, email, phone must be passed in the transfer object within the batch array
PAYTMWith this value, Additional details such as name, email, phone must be passed in the transfer object within the batch array
AMAZONPAYWith this value, Additional details such as name, email, phone must be passed in the transfer object within the batch array

Transfer Objects

Field NameDescription
transferIdA unique transfer id.
amountAmount to be transferred.
beneIdThe ID of the beneficiary. This field must be passed if the batch format option is BENEFICIARY_ID.
transferModeRequired 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
bankAccountBank account number for payout. This field must be passed if the batch format option is BANK_ACCOUNT.
ifscIFSC 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.
nameName 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.
phoneThe 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.

Response Codes

Sub CodeStatusMessage
200SUCCESSBatch Transfer requested successfully. Please check later for processing status.
202PENDINGRequest received. Please check status after some time.
403ERRORToken is not valid
412ERRORToken missing in the request
520ERRORUnknown error occurred at batchTransfer
520ERRORBatch Transfer request failed
520ERRORError in batch transfer
403ERRORPermission Denied
422ERRORBatch transfer id is missing
422ERRORBatch format is missing
409ERRORInvalid Batch Format
409ERRORBatch TransferId already exists
422ERRORInvalid Batch Transfer Id provided
422ERRORPlease provide at least one transfer entry
422ERRORThe maximum number of entries allowed per file is 500, please try again.
422ERRORTransfer Parameters missing in the request
520ERRORUnknown error occurred

Language