Cashfree Payments Developer Documentation

POST

payout

v1.2

requestTransfer

curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1.2/requestTransfer \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "beneId": "<string>",
  "amount": 123,
  "transferId": "<string>",
  "transferMode": "<string>",
  "paymentInstrumentId": "<string>",
  "remarks": "<string>"
}'

"{\n  \"status\":\"SUCCESS\", \n  \"subCode\":\"200\", \n  \"message\":\"Transfer completed successfully\", \n  \"data\": \n  {\n    \"referenceId\":\"10023\",\n    \"utr\":\"P16111765023806\",\n    \"acknowledged\": 1\n  }\n}\n\n{\n  \"status\":\"ERROR\",\n  \"subCode\":\"404\",\n  \"message\":\"Beneficiary does not exist\"\n}\n\n{\n  \"status\":\"ERROR\",\n  \"subCode\":\"422\", \n  \"message\":\"Remarks can have only numbers,alphabets and whitespaces\"\n}"

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.	-
201	ERROR	Transfer request triggered.No response from bank.	-
202	PENDING	Request received. Please check status after some time.	-
400	ERROR	Mode Not valid for Beneficiary.	Enter a different transfer mode for the beneficiary.
400	ERROR	Transfer Id already exists.	Enter a different transfer ID.
400	ERROR	Not enough available balance in the account.	Retry with sufficient balance in the account.
400	ERROR	Please wait 30 minutes after adding the beneficiary.	-
400	ERROR	Transfer amount is less than minimum amount of Rs. 100.	Enter a transfer amount that is equal to or more than Rs. 100.
400	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.
400	ERROR	Transfer request to paytm wallet failed.	Retry the request with a different transfer mode.
400	ERROR	Transfer attempt failed at the bank.
400	ERROR	Transfer to this beneficiary not allowed.	Enter a different beneficiary ID.
400	ERROR	Transfer amount is less than minimum amount of Rs.1	Enter a transfer amount that is equal to or more than Rs. 1.
400	ERROR	Transfer limit for your account exceeded.
400	ERROR	Transfer mode not enabled for the account.
400	ERROR	Specified paymentInstrumentId not available.	Enter a valid payment instrument ID.
400	ERROR	Specified paymentInstrumentId not valid for this payment mode.	Enter a valid payment instrument ID.
400	ERROR	Multiple PaymentInstruments available for this payment mode.
400	ERROR	Transfer limit for beneficiary exceeded.
403	ERROR	Token is not valid	Verify the generated token.
403	ERROR	IP not whitelisted	Whitelist the IP address.
404	ERROR	Beneficiary does not exist.	Enter a valid beneficiary ID.
412	ERROR	Please provide a valid transferId.	Enter a valid transfer ID.
422	ERROR	Please provide a valid beneId.	Enter a valid beneficiary ID.
422	ERROR	Invalid bank account number or IFSC provided.	Enter a valid bank account number and IFSC.
422	ERROR	Invalid IFSC code provided for bank account.	Enter a valid IFSC.
422	ERROR	Invalid Amount Passed.Only 2 decimal places are allowed.
422	ERROR	Please provide a valid transferId.	Enter a valid transfer ID.
422	ERROR	Remarks is invalid.	Enter any remarks of a maximum of 70 alphanumeric characters and white spaces.

Headers

Authorization

string

required

Bearer Auth Token

Content-Type

string

required

application/json

Body

application/json

beneId

string

required

Beneficiary Id. Alphanumeric characters allowed.

amount

number

required

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

transferId

string

required

A unique Id to identify this transfer. Alphanumeric and underscore (_) allowed (40 character 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.

paymentInstrumentId

string

Specify the fund source ID from where you want the amount to be debited.

remarks

string

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

Response

200

application/json

200

The response is of type any.

Was this page helpful?

Overview Get Batch Transfer Status V1.2

curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1.2/requestTransfer \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "beneId": "<string>",
  "amount": 123,
  "transferId": "<string>",
  "transferMode": "<string>",
  "paymentInstrumentId": "<string>",
  "remarks": "<string>"
}'

"{\n  \"status\":\"SUCCESS\", \n  \"subCode\":\"200\", \n  \"message\":\"Transfer completed successfully\", \n  \"data\": \n  {\n    \"referenceId\":\"10023\",\n    \"utr\":\"P16111765023806\",\n    \"acknowledged\": 1\n  }\n}\n\n{\n  \"status\":\"ERROR\",\n  \"subCode\":\"404\",\n  \"message\":\"Beneficiary does not exist\"\n}\n\n{\n  \"status\":\"ERROR\",\n  \"subCode\":\"422\", \n  \"message\":\"Remarks can have only numbers,alphabets and whitespaces\"\n}"

Payout APIs

V2

V1

One Escrow

Cashgram

Standard Transfer Sync v1.2

Headers

Body

Response