Cashfree Payments Developer Documentation

POST

transfers

batch

{
  "batch_transfer_id": "test_batch_transfer_id",
  "cf_batch_transfer_id": "123456",
  "status": "RECEIVED"
}

5XX error
When you get a 5XX response, do not 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.

Authorizations

x-client-id

string

headerrequired

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

x-client-secret

string

headerrequired

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

x-api-version

string

default: 2024-01-01required

It is the API version to be used. The accepted format is YYYY-MM-DD.

x-request-id

string

It is the request ID for the API call. This ID can be used to resolve tech realted issues. Communicate this in your tech related queries to Cashfree Payments.

Body

application/json

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 length: 60

transfers

object[]

transfers.transfer_id

string

required

It is the unique ID you create to identify the transfer. You can use a maximum of 40 characters to create a transfer_id. Alphanumeric and underscore ( _ ) are allowed.

Maximum length: 40

transfers.transfer_amount

number

required

It is the transfer amount. Decimal values are allowed. The minimum value should be equal to or greater than 1.00. (>= 1.00)

transfers.transfer_currency

string

It is the currency of the transfer amount. The default value is INR.

transfers.transfer_mode

enum<string>

It is the mode of transfer. Allowed values are banktransfer, imps, neft, rtgs, upi, paytm, amazonpay, card. The default transfer_mode is banktransfer.

Available options:

banktransfer,

imps,

neft,

rtgs,

upi,

paytm,

amazonpay,

card,

cardupi

transfers.beneficiary_details

object

It should contain the details of the beneficiary who receives the transfer amount.

transfers.beneficiary_details.beneficiary_id

string

It is the unique ID you created to identify the beneficiary. Alphanumeric characters are allowed.

transfers.beneficiary_details.beneficiary_name

string

It is the name of the beneficiary. The maximum character limit is 100.

transfers.beneficiary_details.beneficiary_instrument_details

object

It should contain the details of where the beneficiary will receive the money. You input these details if you haven't added the beneficiary in the Payouts dashboard.

transfers.beneficiary_details.beneficiary_contact_details

object

It should contain the contact details of the beneficiary.

transfers.transfer_remarks

string

It can contain any additional remarks for the transfer. Alphanumeric and whitespaces are allowed. The maximum character limit is 70.

Maximum length: 70

transfers.fundsource_id

string

It is the ID of the fund source from where you want to debit the transfer amount.

Response

200 - application/json

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.

Was this page helpful?

Get Batch Transfer Status V2 Get Beneficiary V2

{
  "batch_transfer_id": "test_batch_transfer_id",
  "cf_batch_transfer_id": "123456",
  "status": "RECEIVED"
}

Payout APIs

V2

V1

Batch Transfer V2

Authorizations

Headers

Body

Response