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>"
}
}
'import requests
url = "https://payout-api.cashfree.com/payout/v1/lend"
payload = {
"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>"
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
body: JSON.stringify({
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>'
}
})
};
fetch('https://payout-api.cashfree.com/payout/v1/lend', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://payout-api.cashfree.com/payout/v1/lend",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://payout-api.cashfree.com/payout/v1/lend"
payload := strings.NewReader("{\n \"beneId\": \"<string>\",\n \"loanId\": \"<string>\",\n \"amount\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"serviceCharges\": \"[{\\\"key\\\":\\\"\\\", \\\"value\\\":\\\"\\\"}]\",\n \"beneDetails\": {\n \"bankAccount\": \"<string>\",\n \"ifsc\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"vpa\": \"<string>\",\n \"address1\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://payout-api.cashfree.com/payout/v1/lend")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.body("{\n \"beneId\": \"<string>\",\n \"loanId\": \"<string>\",\n \"amount\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"serviceCharges\": \"[{\\\"key\\\":\\\"\\\", \\\"value\\\":\\\"\\\"}]\",\n \"beneDetails\": {\n \"bankAccount\": \"<string>\",\n \"ifsc\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"vpa\": \"<string>\",\n \"address1\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://payout-api.cashfree.com/payout/v1/lend")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n \"beneId\": \"<string>\",\n \"loanId\": \"<string>\",\n \"amount\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"serviceCharges\": \"[{\\\"key\\\":\\\"\\\", \\\"value\\\":\\\"\\\"}]\",\n \"beneDetails\": {\n \"bankAccount\": \"<string>\",\n \"ifsc\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"vpa\": \"<string>\",\n \"address1\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"subCode": "200",
"message": "Transfer completed successfully",
"data": {
"referenceId": "54109311",
"utr": "1681409852019854",
"acknowledged": 1
}
}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 --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>"
}
}
'import requests
url = "https://payout-api.cashfree.com/payout/v1/lend"
payload = {
"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>"
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'},
body: JSON.stringify({
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>'
}
})
};
fetch('https://payout-api.cashfree.com/payout/v1/lend', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://payout-api.cashfree.com/payout/v1/lend",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: <content-type>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://payout-api.cashfree.com/payout/v1/lend"
payload := strings.NewReader("{\n \"beneId\": \"<string>\",\n \"loanId\": \"<string>\",\n \"amount\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"serviceCharges\": \"[{\\\"key\\\":\\\"\\\", \\\"value\\\":\\\"\\\"}]\",\n \"beneDetails\": {\n \"bankAccount\": \"<string>\",\n \"ifsc\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"vpa\": \"<string>\",\n \"address1\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "<content-type>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://payout-api.cashfree.com/payout/v1/lend")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.body("{\n \"beneId\": \"<string>\",\n \"loanId\": \"<string>\",\n \"amount\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"serviceCharges\": \"[{\\\"key\\\":\\\"\\\", \\\"value\\\":\\\"\\\"}]\",\n \"beneDetails\": {\n \"bankAccount\": \"<string>\",\n \"ifsc\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"vpa\": \"<string>\",\n \"address1\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://payout-api.cashfree.com/payout/v1/lend")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
request.body = "{\n \"beneId\": \"<string>\",\n \"loanId\": \"<string>\",\n \"amount\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"serviceCharges\": \"[{\\\"key\\\":\\\"\\\", \\\"value\\\":\\\"\\\"}]\",\n \"beneDetails\": {\n \"bankAccount\": \"<string>\",\n \"ifsc\": \"<string>\",\n \"name\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"vpa\": \"<string>\",\n \"address1\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"subCode": "200",
"message": "Transfer completed successfully",
"data": {
"referenceId": "54109311",
"utr": "1681409852019854",
"acknowledged": 1
}
}Body
application/json
It is the unique ID to identify the beneficiary. Only alphanumeric characters are allowed.
It is the unique ID to identify the loan. Only alphanumeric characters are allowed.
It is the loan amount. It should be equal to or greater than 1.00.
It is the mode of transfer. Allowed values are: banktransfer, neft, imps, rtgs, upi, paytm, and amazonpay. The default transferMode is banktransfer.
It is the service charges that need to be disbursed to different parties.
It is the details of the beneficiary.
Show child attributes
Show child attributes
⌘I
