Cashfree Payments Developer Documentation

GET

transfers

batch

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

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.

Query Parameters

cf_batch_transfer_id

string

It is the unique ID created by Cashfree Payments. You receive it in the response of the initiated batch transfer request. (Either cf_batch_transfer_id or batch_transfer_id is mandatory)

batch_transfer_id

string

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

Response

200 - application/json

Batch Transfer Status V2 Response

batch_transfer_id

string

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

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 batch transfer.

transfers

object[]

transfers.transfer_id

string

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

transfers.cf_transfer_id

string

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

transfers.status

string

It displays the status of the transfer.

transfers.beneficiary_details

object

It displays the details of the beneficiary.

transfers.transfer_amount

number

It displays the transfer amount initiated in the request.

transfers.transfer_service_charge

number

It displays the service charge applicable for the successful transfer request.

transfers.transfer_service_tax

number

It displays the service tax applicable for the successful transfer request.

transfers.transfer_mode

string

It displays the mode of the transfer.

transfers.transfer_utr

string

It displays the unique number that is generated to recognise any fund transfer that is created by the bank that facilitates the transfer.

transfers.fundsource_id

string

It displays the ID of the fund source from where the money was debited for this transfer request.

transfers.added_on

string

It displays the time of when the transfer request was added to the system.

transfers.updated_on

string

It displays the updated time for the transfer.

Was this page helpful?

Standard Transfer V2 Batch Transfer V2

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

Payout APIs

V2

V1

Get Batch Transfer Status V2

Authorizations

Headers

Query Parameters

Response