Get Batch Transfer Status V1.2

Use this API to get the status of the Batch Transfer.

GET /payout/v1.2/getBatchTransferStatus

Get Batch Transfer Status V1.2

cURL

curl --request GET \
  --url https://payout-api.cashfree.com/payout/v1.2/getBatchTransferStatus \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'

200

{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Data retrieved successfully",
  "data": {
    "rowCount": 2,
    "referenceId": 1582,
    "paymentInstrumentId": "CASHFREE_1",
    "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)

Click to view the response codes.

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

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

application/json

200

status · string

Example:

"SUCCESS"

subCode · string

Example:

"200"

message · string

Example:

"Data retrieved successfully"

data · object

Show child attributes