Skip to main content
POST
/
payout
/
v1
/
requestBatchTransfer
Batch Transfer
curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1/requestBatchTransfer \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "batchTransferId": "<string>",
  "batchFormat": "<string>",
  "batch": [
    "<string>"
  ],
  "deleteBene": true
}
'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Request accepted",
  "data": {
    "referenceId": 1594
  }
}

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

Response

200