Cashfree Payments Developer Documentation

Direct Transfer V1.2

curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1.2/directTransfer \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "amount": 123,
  "transferId": "<string>",
  "transferMode": "<string>",
  "beneDetails": {
    "name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "address1": "<string>",
    "bankAccount": "<string>",
    "ifsc": "<string>",
    "vpa": "<string>"
  },
  "paymentInstrumentId": "<string>"
}
'

{
  "status": "PENDING",
  "subCode": "201",
  "message": "Transfer request pending at the bank",
  "data": {
    "referenceId": "23457526",
    "utr": "",
    "acknowledged": 0
  }
}

POST

payout

v1.2

directTransfer

Direct Transfer V1.2

curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1.2/directTransfer \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "amount": 123,
  "transferId": "<string>",
  "transferMode": "<string>",
  "beneDetails": {
    "name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "address1": "<string>",
    "bankAccount": "<string>",
    "ifsc": "<string>",
    "vpa": "<string>"
  },
  "paymentInstrumentId": "<string>"
}
'

{
  "status": "PENDING",
  "subCode": "201",
  "message": "Transfer request pending at the bank",
  "data": {
    "referenceId": "23457526",
    "utr": "",
    "acknowledged": 0
  }
}

Headers

Authorization

string

required

Bearer auth token.

Content-Type

string

required

application/json

Body

application/json

amount

number<float>

required

Amount to be transferred. Amount should be greater that INR 1.00. Decimals are allowed.

transferId

string

required

A unique ID to identify this transfer. Alphanumeric characters and underscores are allowed (40 character limit).

transferMode

string

required

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

beneDetails

object

required

Object with the beneficiary details to whom amount is to be transferred

Show child attributes

beneDetails.name

string

required

Beneficiary name, only alphabets and white space (100 character limit)

beneDetails.phone

string

required

Beneficiary phone number, phone number registered in India (only digits, 8 - 12 characters after stripping +91)

beneDetails.email

string

required

Beneficiary email address, string in email Id format (Ex: [email protected]) - should contain @ and dot (.) - (200 character limit)

beneDetails.address1

string

required

Beneficiary address. Alphanumeric characters and space allowed (150 character limit).

beneDetails.bankAccount

string

Beneficiary bank account (9 - 18 alphanumeric character limit) (Required in case of banktransfer, imps, neft mode)

beneDetails.ifsc

string

Accounts IFSC (standard IFSC format) - length 11, first four bank IFSC and 5th digit 0 (Required in case of banktransfer, imps, neft mode)

beneDetails.vpa

string

Beneficiary VPA, alphanumeric, dot (.), hyphen (-), at sign (@), and underscore () allowed (100 character limit). Note: underscore () and dot (.) gets accepted before and after at sign (@), but hyphen (-) get only accepted before at sign (@) (Required in case of UPI)

paymentInstrumentId

string

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

Response

200 - Transfer Status

status

string

Example:

"SUCCESS"

subCode

string

Example:

"200"

message

string

Example:

"Transfer completed successfully"

data

object

Show child attributes

data.referenceId

string

Example:

"10023"

data.utr

string

Example:

"P16111765023806"

data.acknowledged

integer

Example:

1

⌘I

Payout APIs

V2

V1

One Escrow

Cashgram

Direct Transfer V1.2

Headers

Body

Response