Skip to main content
GET
/
payout
/
v1
/
getBatchTransferStatus
Get Batch Transfer Status
curl --request GET \
  --url https://payout-api.cashfree.com/payout/v1/getBatchTransferStatus \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Data retrieved successfully",
  "data": {
    "rowCount": 2,
    "referenceId": 1582,
    "transfers": [
      {
        "beneId": "999999999918875",
        "transferId": "PTM_00121241112",
        "referenceId": 1523969542,
        "bankAccount": "9999999999",
        "ifsc": "PYTM0000001",
        "amount": "12.00",
        "remarks": "",
        "status": "SUCCESS",
        "utr": "W1532082925",
        "addedOn": "2018-07-20T00:00:00.000Z",
        "processedOn": "2018-07-20T00:00:00.000Z"
      }
    ]
  }
}
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 CodeStatusMessage
200SUCCESSData retrieved successfully
201PENDINGEntries are not processed yet
403ERRORToken is not valid
403ERRORIP not whitelisted
404ERRORBulk Transfer Id does not exist
412ERRORToken missing in the request
520ERRORError while fetching data
520ERRORUnknown error occured at batchTransfer

Headers

ā€‹
Authorization
string
required

Bearer auth token

ā€‹
Content-Type
string
required

application/json

Query Parameters

ā€‹
batchTransferId
string
required

It is the unique ID created for the batch transfer.

Response

200

ā€‹
status
string
Example:

"SUCCESS"

ā€‹
subCode
string
Example:

"200"

ā€‹
message
string
Example:

"Data retrieved successfully"

ā€‹
data
object