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>"
}
'import requests
url = "https://payout-api.cashfree.com/payout/v1.2/requestTransfer"
payload = {
"beneId": "<string>",
"amount": 123,
"transferId": "<string>",
"transferMode": "<string>",
"paymentInstrumentId": "<string>",
"remarks": "<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>',
amount: 123,
transferId: '<string>',
transferMode: '<string>',
paymentInstrumentId: '<string>',
remarks: '<string>'
})
};
fetch('https://payout-api.cashfree.com/payout/v1.2/requestTransfer', 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.2/requestTransfer",
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>',
'amount' => 123,
'transferId' => '<string>',
'transferMode' => '<string>',
'paymentInstrumentId' => '<string>',
'remarks' => '<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.2/requestTransfer"
payload := strings.NewReader("{\n \"beneId\": \"<string>\",\n \"amount\": 123,\n \"transferId\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"paymentInstrumentId\": \"<string>\",\n \"remarks\": \"<string>\"\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.2/requestTransfer")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.body("{\n \"beneId\": \"<string>\",\n \"amount\": 123,\n \"transferId\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"paymentInstrumentId\": \"<string>\",\n \"remarks\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://payout-api.cashfree.com/payout/v1.2/requestTransfer")
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 \"amount\": 123,\n \"transferId\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"paymentInstrumentId\": \"<string>\",\n \"remarks\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"subCode": "200",
"message": "Transfer completed successfully",
"data": {
"referenceId": "10023",
"utr": "P16111765023806",
"acknowledged": 1
}
}Standard Transfer Sync v1.2
Use this API to initiate an amount transfer request at Cashfree by providing beneficiary id, amount, and transfer id. This is a sync transfer request.
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>"
}
'import requests
url = "https://payout-api.cashfree.com/payout/v1.2/requestTransfer"
payload = {
"beneId": "<string>",
"amount": 123,
"transferId": "<string>",
"transferMode": "<string>",
"paymentInstrumentId": "<string>",
"remarks": "<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>',
amount: 123,
transferId: '<string>',
transferMode: '<string>',
paymentInstrumentId: '<string>',
remarks: '<string>'
})
};
fetch('https://payout-api.cashfree.com/payout/v1.2/requestTransfer', 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.2/requestTransfer",
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>',
'amount' => 123,
'transferId' => '<string>',
'transferMode' => '<string>',
'paymentInstrumentId' => '<string>',
'remarks' => '<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.2/requestTransfer"
payload := strings.NewReader("{\n \"beneId\": \"<string>\",\n \"amount\": 123,\n \"transferId\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"paymentInstrumentId\": \"<string>\",\n \"remarks\": \"<string>\"\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.2/requestTransfer")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.body("{\n \"beneId\": \"<string>\",\n \"amount\": 123,\n \"transferId\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"paymentInstrumentId\": \"<string>\",\n \"remarks\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://payout-api.cashfree.com/payout/v1.2/requestTransfer")
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 \"amount\": 123,\n \"transferId\": \"<string>\",\n \"transferMode\": \"<string>\",\n \"paymentInstrumentId\": \"<string>\",\n \"remarks\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"subCode": "200",
"message": "Transfer completed successfully",
"data": {
"referenceId": "10023",
"utr": "P16111765023806",
"acknowledged": 1
}
}Body
Beneficiary Id. Alphanumeric characters allowed.
amount to be transferred. Decimals allowed (>= 1.00)
A unique Id to identify this transfer. Alphanumeric and underscore (_) allowed (40 character limit).
It is the mode of transfer. Allowed values are: banktransfer, neft, imps, rtgs, upi, paytm, and amazonpay. The default transferMode is banktransfer.
Specify the fund source ID from where you want the amount to be debited.
Additional remarks, if any. Alphanumeric and white spaces allowed (70 characters limit).
Response
Successful response with status and data or error information
- Option 1
- Option 2
- Option 3
"SUCCESS"
"200"
"Transfer completed successfully"
Partner-facing references for the accepted transfer, including the Cashfree reference ID, bank or network UTR when issued, and partner acknowledgement.
Show child attributes
Show child attributes
Was this page helpful?