Lend

Use this API to send requests for loan disbursement to the beneficiary. The service charges are pooled for the respective party and disbursed at the end of day. Disbursement amount = (Amount - total service charges).

POST /payout/v1/lend

Lend

cURL

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>"
  }
}
'

200

Example

{
  "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

Response

200

application/json

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