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>"
}'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Transfer completed successfully",
  "data": {
    "referenceId": "10023",
    "utr": "P16111765023806",
    "acknowledged": 1
  }
}

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
Successful response with status and data or error information
status
string
Example:

"SUCCESS"

subCode
string
Example:

"200"

message
string
Example:

"Transfer completed successfully"

data
object

Was this page helpful?