Skip to main content
POST
Batch Transfer V2
5XX error
When you get a 5XX response, don’t initiate another transaction.
Check the status of the batch transfer using Get Batch Transfer Status V2 and then proceed further.
Get Transfer Status
Use the Get Batch Transfer Status V2 API to get the status of the batch transfer request. The Get Transfer Status V2 API does not give you the status of the batch transfer requests.

4XX errors

Authorizations

x-client-id
string
header
required

Client app ID. You can find your app ID in the Merchant Dashboard.

x-client-secret
string
header
required

Client secret key. You can find your secret key in the [Merchant Dashboard]((https://merchant.cashfree.com/payouts/developers/api-keys).

Headers

x-api-version
string
default:2024-01-01
required

It is the API version to be used.

x-request-id
string

Request ID for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to Cashfree.

x-cf-signature
string

Signature to be sent if IP is not whitelisted.

Body

application/json

Find the request parameters of the API request to transfer money to multiple beneficiaries.

Batch Transfer V2

batch_transfer_id
string
required

It is the unique ID you create to identify the batch transfer request. The maximum character limit is 60. Alphanumeric and underscore ( _ ) characters are allowed.

Maximum string length: 60
transfers
object[]

Response

OK

Batch Transfer V2 Response

batch_transfer_id
string

It displays the unique ID you created to identify the batch transfer request.

cf_batch_transfer_id
string

It displays the unique ID created by Cashfree Payments. You receive this ID in the response after initiating the batch transfer request.

status
string

It displays the status of the API request.