Batch Transfer

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

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

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.

Response Codes

Sub Code

Status

Message

200

SUCCESS

Batch Transfer requested successfully. Please check later for processing status.

202

PENDING

Request received. Please check status after some time.

403

ERROR

Token is not valid

412

ERROR

Token missing in the request

520

ERROR

Unknown error occurred at batchTransfer

520

ERROR

Batch Transfer request failed

520

ERROR

Error in batch transfer

403

ERROR

Permission Denied

422

ERROR

Batch transfer id is missing

422

ERROR

Batch format is missing

409

ERROR

Invalid Batch Format

409

ERROR

Batch TransferId already exists

422

ERROR

Invalid Batch Transfer Id provided

422

ERROR

Please provide at least one transfer entry

422

ERROR

The maximum number of entries allowed per file is 500, please try again.

422

ERROR

Transfer Parameters missing in the request

520

ERROR

Unknown error occurred

Language