Skip to main content
GET
/
payout
/
v1.2
/
getBatchTransferStatus
Get Batch Transfer Status V1.2
curl --request GET \
  --url https://payout-api.cashfree.com/payout/v1.2/getBatchTransferStatus \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
"{\n  \"status\" : \"SUCCESS\",\n  \"subCode\": \"200\", \n  \"message\": \"Data retrieved successfully\", \n  \"data\":\n  { \n   \"rowCount\" : 2, \n   \"referenceId\" : 1582, \n   \"paymentInstrumentId\": \"CASHFREE_1\",\n   \"transfers\": \n   [ { \n      \"beneId\":\"9999999999_18875\", \n      \"transferId\":\"PTM_00121241112\", \n      \"referenceId\":1523969542, \n      \"bankAccount\":\"9999999999\", \n      \"ifsc\":\"PYTM0000001\", \n      \"amount\":\"12.00\", \n      \"remarks\":\"\",\n      \"status\":\"SUCCESS\", \n      \"utr\":\"W1532082925\", \n      \"addedOn\":\"2018-07-20\", \n      \"processedOn\":\"2018-07-20\"\n    },\n    {\n      \"beneId\":\"9999999999_18875\", \n      \"transferId\":\"PTM_00052312126\", \n      \"referenceId\":1523969543, \n      \"bankAccount\":\"9999999999\",\n      \"ifsc\":\"PYTM0000001\", \n      \"amount\":\"12.00\", \n      \"remarks\":\"\", \n      \"status\":\"SUCCESS\", \n      \"utr\":\"W1532082926\", \n      \"addedOn\":\"2018-07-20\", \n      \"processedOn\":\"2018-07-20\"\n    }]\n   }\n}"
This API will be retired soon. Please plan to migrate to the latest version, Transfers V2.
Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)
Sub CodeStatusMessageNext Action
200SUCCESSData retrieved successfully-
201PENDINGEntries are not processed yet-
403ERRORToken is not validVerify the generated token.
403ERRORIP not whitelistedWhitelist the IP address.
404ERRORBulk Transfer Id does not existEnter a valid batch transfer ID.
412ERRORToken missing in the requestEnter a valid token in the request.
520ERRORError while fetching data
520ERRORUnknown error occurred at batchTransfer

Headers

​
Authorization
string
required

Bearer auth token

​
Content-Type
string
required

application/json

Query Parameters

​
batchTransferId
string
required

Batch transfer ID to fetch the status

Response

200

​
status
string
Example:

"SUCCESS"

​
subCode
string
Example:

"200"

​
message
string
Example:

"Data retrieved successfully"

​
data
object