Skip to main content
GET
/
payout
/
v1.1
/
getTransferStatus
Get Transfer Status
curl --request GET \
  --url https://payout-api.cashfree.com/payout/v1.1/getTransferStatus \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>'
"\t// Case 1: Transfer ID/Reference ID exists and the transfer is successful.\n\t\n{\n   \"status\": \"SUCCESS\",\n   \"subCode\": \"200\",\n   \"message\": \"Details of transfer with referenceId 200223467\",\n   \"data\": \n   {\n       \"transfer\": \n       {\n           \"transferId\": \"sample01139\",\n           \"bankAccount\": \"000810139000385\",\n           \"ifsc\": \"YESB0MAN001\",\n           \"beneId\": \"test_bene\",\n           \"amount\": \"1.2\",\n           \"status\": \"SUCCESS\",\n           \"utr\": \"N351200478962883\",\n           \"addedOn\": \"2020-12-16 09:17:41\",\n           \"processedOn\": \"2020-12-16 09:17:42\",\n           \"transferMode\": \"BANK\",\n           \"acknowledged\": 1\n       }\n   }\n}\n\n\n\n\n// Case 2: Transfer ID/Reference ID exists but the transfer is not successful\n{\n   \"status\": \"SUCCESS\",\n   \"subCode\": \"200\",\n   \"message\": \"Details of transfer with referenceId 195460327\",\n   \"data\": \n   {\n       \"transfer\": \n       {\n           \"transferId\": \"1025fca380442d98\",\n           \"bankAccount\": \"20274048860\",\n           \"ifsc\": \"SBIN0002207\",\n           \"beneId\": \"TEST1234\",\n           \"amount\": \"1.1\",\n           \"status\": \"FAILED\",\n           \"addedOn\": \"2020-12-04 18:52:12\",\n           \"processedOn\": \"2020-12-04 19:07:13\",\n           \"reason\": \"BENEFICIARY_BANK_OFFLINE\",\n           \"transferMode\": \"BANK\",\n            \"acknowledged\": 0\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 CodeStatusMessageSolution
200SUCCESSDetails of transfer with referenceId (or transferId) XXXX-
403ERRORToken is not validVerify the generated token.
403ERRORIP not whitelistedWhitelist the IP address.
404ERRORTransferId is invalid or does not existEnter a valid transfer ID.
404ERRORReferenceId is invalid or does not existEnter a valid reference ID.
412ERRORToken missing in the requestEnter a valid token in the request.
422ERRORPlease provide referenceId or transferId to fetch detailsEnter a valid reference or transferId.
/520ERRORUnknown error occurredTry again after some time.
Reason (in API response)CategoryDescriptionSolution
BANK_GATEWAY_ERRORBankTechnical error at the bank
SOURCE_BANK_DECLINEDBankTPS exceeded at the bank/NPCI
FAILEDBankNo explicit failure reason from the bank
INVALID_AMOUNT_FAILMerchantAmount is invalid for the given transfer modeEnter a valid transfer amount.
INVALID_AMOUNT_FAILCustomerBank account is invalidEnter valid bank account details.
INVALID_REQUESTMerchantRequest is invalid
RETURNED_FROM_BENEFICIARYBankImmediate reversal from the beneficiary bank
INSUFFICIENT_BALANCEMerchantBalance is exhausted, need to add funds
IMPS_MODE_FAILBankIMPS mode not supported for the beneficiary
RTGS_MODE_FAILBankRTGS mode not supported (only for RTGS)
REINITIALIZE_TRANSFER_LATERBankTechnical error at the bank, retry later
NRE_ACCOUNT_FAILCustomerCustomer bank account is an NRE account
ACCOUNT_BLOCKEDCustomerCustomer bank account is blocked
DEST_LIMIT_REACHEDBankTransfer limit to beneficiary exceeded
INVALID_MODE_FAILBankTransfer mode not valid for beneficiaryEnter a different transfer mode.
NPCI_UNAVAILABLEBankNPCI in unavailable
BENEFICIARY_BANK_OFFLINEBankBeneficiary bank is offline
Reason (in API response)CategoryDescriptionSolution
ACCOUNT_FROZEN_OR_CLOSEDCustomerAccount is closed or frozen
CREDIT_LIMIT_EXCEEDEDCustomerTransfer limit to beneficiary exceeded
ACCOUNT_CLOSED_OR_FROZENCustomerTransfer limit to beneficiary exceeded
ACCOUNT_ON_HOLDCustomerAccount is temporarily on hold
ACCOUNT_FROZENCustomerAccount is frozen
IFSC_DOES_NOT_MATCHCustomerIFSC does not matchEnter a valid IFSC.
FRAUD_REVERSEDCustomerSuspect fraudulent transfer
ANY OTHER REASONBankReason not specified by bank
INVALID_OR_NO_SUCH_ACCOUNT_TYPECustomerInvalid account
ACCOUNT_CLOSEDCustomerAccount is closed
ACCOUNT_FROZEN_OR_BLOCKEDCustomerAccount is frozen or blocked
BENEFICIARY_NAME_DIFFERSCustomerBeneficiary name does not match (only for NEFT)
BENEFICIARY_BANK_NODE_OFFLINEBankBeneficiary bank offline
ACCOUNT_DOES_NOT_EXISTCustomerAccount does not existEnter 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

The response is of type any.