Cashfree Payments Developer Documentation

Lend

curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1/lend \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "beneId": "<string>",
  "loanId": "<string>",
  "amount": "<string>",
  "transferMode": "<string>",
  "serviceCharges": "[{\"key\":\"\", \"value\":\"\"}]",
  "beneDetails": {
    "bankAccount": "<string>",
    "ifsc": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "vpa": "<string>",
    "address1": "<string>"
  }
}
'

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

POST

payout

lend

Lend

curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1/lend \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "beneId": "<string>",
  "loanId": "<string>",
  "amount": "<string>",
  "transferMode": "<string>",
  "serviceCharges": "[{\"key\":\"\", \"value\":\"\"}]",
  "beneDetails": {
    "bankAccount": "<string>",
    "ifsc": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "vpa": "<string>",
    "address1": "<string>"
  }
}
'

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

Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)

Click to view the response codes.

Sub Code	Status	Message	Next Action
200	SUCCESS	Transfer completed successfully	None
201	PENDING	Transfer request pending at the bank	None
400	ERROR	beneId is missing in the request	Enter a beneId in the request
400	ERROR	Total service charge is greater than disbursal amount	Enter valid amount which is greater than sum of service charges
400	ERROR	Insufficient balance in LENDER fundsource	Lender needs to recharges their CF wallet
403	ERROR	APIs not enabled. Please fill out the Support Form	Please fill out the Support Form
422	ERROR	Please provide valid token details	Provide a valid token
422	ERROR	amount should be at least 1.0	Enter a transfer amount that is equal to or more than Rs. 1.
422	ERROR	Invalid bank account number or ifsc provided	Provide valid bank account details

Headers

Authorization

string

required

Bearer Auth Token

Content-Type

string

required

application/json

Body

application/json

beneId

string

required

It is the unique ID to identify the beneficiary. Only alphanumeric characters are allowed.

loanId

string

required

It is the unique ID to identify the loan. Only alphanumeric characters are allowed.

amount

string

required

It is the loan amount. It should be equal to or greater than 1.00.

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.

serviceCharges

string

default:[{"key":"", "value":""}]

It is the service charges that need to be disbursed to different parties.

beneDetails

object

It is the details of the beneficiary.

Show child attributes

beneDetails.bankAccount

string

It is the bank account of the beneficiary. It must be between 9-18 alphanumeric characters. It is a required parameter in the case of banktransfer, imps, and neft.

beneDetails.ifsc

string

The IFSC information of the bank account of the dealer/distributor who raised the invoice for the customer to pay. It should be an alphanumeric value of 11 characters. The first 4 characters should be alphabets, the 5th character should be a 0, and the remaining 6 characters should be numerals.

beneDetails.name

string

It is the name of the beneficiary. It should be a maximum of 100 characters. Only alphabets and whitespaces ( ) are allowed.

beneDetails.phone

string

It is the phone number of the beneficiary. The phone number must be registered in India. Only numeric values are allowed. It should be between 8 and 12 characters excluding +91.

beneDetails.email

string

It is the email address of the beneficiary. A maximum of 200 characters are allowed. The value should contain @ and period (.).

beneDetails.vpa

string

It is the virtual payment address of the beneficiary. A maximum of 100 characters are allowed. Accepted values: alphanumeric, period (.), hyphen (-), at sign (@), underscore (). Underscore () and period (.) are accepted before and after at sign (@). Hyphen (-) is accepted only before at sign (@).

beneDetails.address1

string

It is the address of the beneficiary. A maximum of 150 characters are allowed. Only alphanumeric values and whitespaces ( ) are allowed.

Response

200

Success transfer for beneId
Success transfer for beneDetails bank account
Sucess transfer for beneDetails VPA

status

string

Example:

"SUCCESS"

subCode

string

Example:

"200"

message

string

Example:

"Transfer completed successfully"

data

object

Show child attributes

data.referenceId

string

Example:

"54109311"

data.utr

string

Example:

"1681409852019854"

data.acknowledged

integer

default:0

Example:

1

CardPay Overview

⌘I

Payout APIs

V2

V1

One Escrow

Cashgram

Lend

Headers

Body

Response