Skip to main content
POST
/
payout
/
v1.2
/
requestBatchTransfer
Batch Transfer V1.2
curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1.2/requestBatchTransfer \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "batchTransferId": "<string>",
  "batchFormat": "<string>",
  "deleteBene": true,
  "batch": [
    "<string>"
  ],
  "paymentInstrumentId": "<string>"
}'
"{\n    \"status\": \"SUCCESS\",\n    \"subCode\": \"200\",\n    \"message\": \"Batch Transfer requested successfully. Please check later for processing status.\",\n    \"data\": {\n        \"referenceId\": 486\n    }\n}"
This API will be retired soon. Please plan to migrate to the latest version, Transfers V2.
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.
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
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.
Sub CodeStatusMessageNext Action
200SUCCESSBatch Transfer requested successfully. Please check later for processing status.-
200SUCCESSbeneficiary already exists with a different name. Please delete
202PENDINGRequest received. Please check status after some time.-
403ERRORToken is not validVerify the generated token.
403ERRORPermission Denied
409ERRORInvalid Batch FormatEnter valid batch format details.
409ERRORBatch TransferId already existsEnter a valid batch transfer ID.
412ERRORToken missing in the requestEnter a valid token in the request.
422ERRORBatch transfer id is missingEnter a valid batch transfer ID.
422ERRORBatch format is missingEnter valid batch format details.
422ERRORInvalid Batch Transfer Id providedEnter a valid batch transfer ID.
422ERRORPlease provide at least one transfer entryEnter at least one transfer entry.
422ERRORThe maximum number of entries allowed per file is 500, please try again.Enter only a maximum of 500 entries per file.
422ERRORTransfer Parameters missing in the requestEnter all the required transfer parameters in the request.
520ERRORUnknown error occurred at batchTransfer
520ERRORBatch Transfer request failed
520ERRORError in batch transfer
520ERRORUnknown error occurred

Headers

​
Authorization
string
required

Bearer auth token

​
Content-Type
string
required

application/json

Body

application/json
​
batchTransferId
string
required

Unique Id of the Batch Transfer, alphanumeric and underscore allowed (60 character limit)

​
batchFormat
string
required

Format of the batch transfers, valid values are, BENEFICIARY_ID, BANK_ACCOUNT, UPI, PAYTM, AMAZONPAY. Details are available below.

​
batch
string[]
required

An array of transfer objects

​
deleteBene
boolean

Flag to delete and read new beneficiaries if a beneficiary with the same Beneficiary Id is available. When the batch transfer format is BANK_ACCOUNT

​
paymentInstrumentId
string

Specify the payment instrument from where you want the amount to be debited.

Response

200

The response is of type any.