Cashfree Payments Developer Documentation

GET

payout

v1.1

getTransferStatus

{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Details of transfer with referenceId 200223467",
  "data": {
    "transfer": {
      "transferId": "sample01139",
      "bankAccount": "000810139000385",
      "ifsc": "YESB0MAN001",
      "beneId": "test_bene",
      "amount": "1.2",
      "status": "SUCCESS",
      "utr": "N351200478962883",
      "addedOn": "2020-12-16T09:17:41.000Z",
      "processedOn": "2020-12-16T09:17:42.000Z",
      "transferMode": "BANK",
      "acknowledged": 1
    }
  }
}

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	Solution
200	SUCCESS	Details of transfer with referenceId (or transferId) XXXX	-
403	ERROR	Token is not valid	Verify the generated token.
403	ERROR	IP not whitelisted	Whitelist the IP address.
404	ERROR	TransferId is invalid or does not exist	Enter a valid transfer ID.
404	ERROR	ReferenceId is invalid or does not exist	Enter a valid reference ID.
412	ERROR	Token missing in the request	Enter a valid token in the request.
422	ERROR	Please provide referenceId or transferId to fetch details	Enter a valid reference or transferId.
/520	ERROR	Unknown error occurred	Try again after some time.

Reason (in API response)	Category	Description	Solution
BANK_GATEWAY_ERROR	Bank	Technical error at the bank
SOURCE_BANK_DECLINED	Bank	TPS exceeded at the bank/NPCI
FAILED	Bank	No explicit failure reason from the bank
INVALID_AMOUNT_FAIL	Merchant	Amount is invalid for the given transfer mode	Enter a valid transfer amount.
INVALID_AMOUNT_FAIL	Customer	Bank account is invalid	Enter valid bank account details.
INVALID_REQUEST	Merchant	Request is invalid
RETURNED_FROM_BENEFICIARY	Bank	Immediate reversal from the beneficiary bank
INSUFFICIENT_BALANCE	Merchant	Balance is exhausted, need to add funds
IMPS_MODE_FAIL	Bank	IMPS mode not supported for the beneficiary
RTGS_MODE_FAIL	Bank	RTGS mode not supported (only for RTGS)
REINITIALIZE_TRANSFER_LATER	Bank	Technical error at the bank, retry later
NRE_ACCOUNT_FAIL	Customer	Customer bank account is an NRE account
ACCOUNT_BLOCKED	Customer	Customer bank account is blocked
DEST_LIMIT_REACHED	Bank	Transfer limit to beneficiary exceeded
INVALID_MODE_FAIL	Bank	Transfer mode not valid for beneficiary	Enter a different transfer mode.
NPCI_UNAVAILABLE	Bank	NPCI in unavailable
BENEFICIARY_BANK_OFFLINE	Bank	Beneficiary bank is offline

Reason (in API response)	Category	Description	Solution
ACCOUNT_FROZEN_OR_CLOSED	Customer	Account is closed or frozen
CREDIT_LIMIT_EXCEEDED	Customer	Transfer limit to beneficiary exceeded
ACCOUNT_CLOSED_OR_FROZEN	Customer	Transfer limit to beneficiary exceeded
ACCOUNT_ON_HOLD	Customer	Account is temporarily on hold
ACCOUNT_FROZEN	Customer	Account is frozen
IFSC_DOES_NOT_MATCH	Customer	IFSC does not match	Enter a valid IFSC.
FRAUD_REVERSED	Customer	Suspect fraudulent transfer
ANY OTHER REASON	Bank	Reason not specified by bank
INVALID_OR_NO_SUCH_ACCOUNT_TYPE	Customer	Invalid account
ACCOUNT_CLOSED	Customer	Account is closed
ACCOUNT_FROZEN_OR_BLOCKED	Customer	Account is frozen or blocked
BENEFICIARY_NAME_DIFFERS	Customer	Beneficiary name does not match (only for NEFT)
BENEFICIARY_BANK_NODE_OFFLINE	Bank	Beneficiary bank offline
ACCOUNT_DOES_NOT_EXIST	Customer	Account does not exist	Enter valid bank account details.

Headers

Authorization

string

required

Bearer auth token

Content-Type

string

required

application/json

Query Parameters

referenceId

string

Reference ID of the transaction. (Either referenceId or transferId is mandatory)

transferId

string

Transfer ID of the transaction.

Response

200 - application/json

data

object

message

string

status

string

subCode

string

Was this page helpful?

Standard Transfer Async Standard Transfer Sync

{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Details of transfer with referenceId 200223467",
  "data": {
    "transfer": {
      "transferId": "sample01139",
      "bankAccount": "000810139000385",
      "ifsc": "YESB0MAN001",
      "beneId": "test_bene",
      "amount": "1.2",
      "status": "SUCCESS",
      "utr": "N351200478962883",
      "addedOn": "2020-12-16T09:17:41.000Z",
      "processedOn": "2020-12-16T09:17:42.000Z",
      "transferMode": "BANK",
      "acknowledged": 1
    }
  }
}

Payout APIs

V2

V1

One Escrow

Cashgram

Get Transfer Status

Headers

Query Parameters

Response