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}"

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.

āŒ˜I