Cashfree Payments Developer Documentation

POST

payout

requestTransfer

{
  "status": "SUCCESS,",
  "subCode": "200,",
  "message": "Transfer completed successfully,",
  "data": {
    "referenceId": "10023,",
    "utr": "P16111765023806,",
    "acknowledged": 1
  }
}

This API will be retired soon. Please plan to migrate to the latest version, Transfers V2.

Once you trigger the requestTransfer API, the transfer to the beneficiary account will be attempted immediately and the bank’s reference number will be returned in the API response. The median time for the response is 2 to 5 seconds.

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	Transfer completed successfully.
201	SUCCESS	Transfer Scheduled for next working day.
201	PENDING	Awaiting confirmation from beneficiary bank.
201	PENDING	Transfer request pending at the bank.
202	PENDING	Request received. Please check status after some time.
403	ERROR	Token is not valid	Verify the generated token.
403	ERROR	IP not whitelisted	Whitelist the IP address.
403	ERROR	This feature is not available for your account.
403	ERROR	Transfer mode is not available for your account.
412	ERROR	Token missing in the request.
412	ERROR	BeneId missing in the request.	Enter a valid beneficiary ID.
412	ERROR	Amount missing in the request.	Enter a valid transfer amount.
412	ERROR	TransferId missing in the request.	Enter a valid transfer ID.
422	ERROR	Invalid amount passed.	Enter a valid transfer amount.
422	ERROR	Invalid transferId passed.	Enter a valid transfer ID.
422	ERROR	No Payee Virtual Address associated with the beneficiary.
422	ERROR	Remarks can have only numbers, alphabets and whitespaces.	Enter any remarks of a maximum of 70 alphanumeric characters and white spaces.
409	ERROR	Transfer Id already exists.	Enter a different transfer ID.
404	ERROR	Beneficiary does not exist.	Enter valid beneficiary details.
422	ERROR	Beneficiary details not valid.	Enter valid beneficiary details.
422	ERROR	No Bank account or IFSC associated with the beneficiary.	Enter valid bank account details.
412	ERROR	Not enough available balance in the account.	Retry with sufficient balance in the account.
412	ERROR	Please wait 30 minutes after adding the beneficiary.
412	ERROR	Transfer amount is less than minimum amount of Rs. 100.	Enter a transfer amount that is equal to or more than Rs. 100.
412	ERROR	Transfer amount is greater than the maximum amount of Rs.100000.	Enter a transfer amount that is equal to or less than Rs. 100000.
422	ERROR	Invalid IFSC code provided for bank account.	Enter valid bank account details.
422	ERROR	Invalid bank account number or IFSC provided.	Enter a valid bank account number and IFSC.
422	ERROR	Transfer request to paytm wallet failed.
400/520	ERROR	Transfer attempt failed at the bank.
520	ERROR	Transfer request triggered.No response from bank.
403	ERROR	Transfer to this beneficiary not allowed.	Enter a different beneficiary ID.
400	ERROR	Transfer limit for beneficiary exceeded.
412	ERROR	Transfer limit for your account exceeded.
412	ERROR	Invalid transfer mode passed in the request.
412	ERROR	Transfer mode not enabled for the account.
412	ERROR	Invalid Tag passed in the request.

Headers

Authorization

string

required

Bearer Auth Token

Content-Type

string

required

application/json

Body

application/json

amount

number

required

amount to be transferred. Decimals allowed (>= 1.00)

beneId

string

required

Beneficiary Id. Alphanumeric characters allowed.

transferId

string

required

A unique Id to identify this transfer. Alphanumeric and underscore (_) allowed (40 character limit).

remarks

string

Additional remarks, if any. Alphanumeric and white spaces allowed (70 characters limit).

transferMode

string

It is the mode of transfer. Allowed values are: banktransfer, neft, imps, rtgs, upi, paytm, and amazonpay. The default transferMode is banktransfer.

Response

200 - application/json

The response is of type any.

Was this page helpful?

Get Transfer Status Batch Transfer

{
  "status": "SUCCESS,",
  "subCode": "200,",
  "message": "Transfer completed successfully,",
  "data": {
    "referenceId": "10023,",
    "utr": "P16111765023806,",
    "acknowledged": 1
  }
}

Payout APIs

V2

V1

One Escrow

Cashgram

Standard Transfer Sync

Headers

Body

Response