v2025-01-01
- Overview
- Orders
- Payments
- Payment Links
- Refunds
- Customers
- Payment Methods
- Offers
- Settlements
- Simulation
- Utilities
Get Batch Transfer Status V1.2
Use this API to get the status of the Batch Transfer.
GET
/
payout
/
v1.2
/
getBatchTransferStatus
Copy
curl --request GET \
--url https://payout-api.cashfree.com/payout/v1.2/getBatchTransferStatus \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>'
Copy
"{\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 Code | Status | Message | Next Action |
---|---|---|---|
200 | SUCCESS | Data retrieved successfully | - |
201 | PENDING | Entries are not processed yet | - |
403 | ERROR | Token is not valid | Verify the generated token. |
403 | ERROR | IP not whitelisted | Whitelist the IP address. |
404 | ERROR | Bulk Transfer Id does not exist | Enter a valid batch transfer ID. |
412 | ERROR | Token missing in the request | Enter a valid token in the request. |
520 | ERROR | Error while fetching data | |
520 | ERROR | Unknown error occurred at batchTransfer |
Query Parameters
Batch transfer ID to fetch the status
Response
200
application/json
200
The response is of type object
.
Copy
curl --request GET \
--url https://payout-api.cashfree.com/payout/v1.2/getBatchTransferStatus \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>'
Copy
"{\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}"
Assistant
Responses are generated using AI and may contain mistakes.