Get Beneficiary Details
curl --request GET \
--url https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>'import requests
url = "https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId}"
headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'}
};
fetch('https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId}', 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/getBeneficiary/{beneId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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"
"net/http"
"io"
)
func main() {
url := "https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId}"
req, _ := http.NewRequest("GET", url, nil)
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.get("https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId}")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.asString();require 'uri'
require 'net/http'
url = URI("https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"subCode": "200",
"message": "Details of beneficiary",
"data": {
"beneId": "JOHN18011",
"name": "John",
"groupName": "DEFAULT",
"email": "johndoe@cashfree.com",
"phone": "9876543210",
"address1": "ABCavenue",
"address2": "",
"city": "Bangalore",
"state": "Karnataka",
"pincode": "0",
"bankAccount": "00001111222233",
"ifsc": "HDFC0000001",
"status": "VERIFIED"
}
}{
"status": "ERROR",
"subCode": "403",
"message": "APIs not enabled. Please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1)"
}{
"status": "ERROR",
"subCode": "404",
"message": "Beneficiary does not exist"
}Beneficiary
Get Beneficiary Details
Use this API to get the details of a particular beneficiary in your account.
GET
/
payout
/
v1
/
getBeneficiary
/
{beneId}
Get Beneficiary Details
curl --request GET \
--url https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId} \
--header 'Authorization: <authorization>' \
--header 'Content-Type: <content-type>'import requests
url = "https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId}"
headers = {
"Authorization": "<authorization>",
"Content-Type": "<content-type>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: '<authorization>', 'Content-Type': '<content-type>'}
};
fetch('https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId}', 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/getBeneficiary/{beneId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
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"
"net/http"
"io"
)
func main() {
url := "https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId}"
req, _ := http.NewRequest("GET", url, nil)
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.get("https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId}")
.header("Authorization", "<authorization>")
.header("Content-Type", "<content-type>")
.asString();require 'uri'
require 'net/http'
url = URI("https://payout-api.cashfree.com/payout/v1/getBeneficiary/{beneId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = '<content-type>'
response = http.request(request)
puts response.read_body{
"status": "SUCCESS",
"subCode": "200",
"message": "Details of beneficiary",
"data": {
"beneId": "JOHN18011",
"name": "John",
"groupName": "DEFAULT",
"email": "johndoe@cashfree.com",
"phone": "9876543210",
"address1": "ABCavenue",
"address2": "",
"city": "Bangalore",
"state": "Karnataka",
"pincode": "0",
"bankAccount": "00001111222233",
"ifsc": "HDFC0000001",
"status": "VERIFIED"
}
}{
"status": "ERROR",
"subCode": "403",
"message": "APIs not enabled. Please fill out the [Support Form](https://merchant.cashfree.com/merchants/landing?env=prod&raise_issue=1)"
}{
"status": "ERROR",
"subCode": "404",
"message": "Beneficiary does not exist"
} This API will be retired soon. Please plan to migrate to the latest version, Beneficiary V2.
Click to view the response codes.
Click to view the response codes.
| Sub code | Status | Message | Next action |
|---|---|---|---|
| 200 | SUCCESS | Details of beneficiary | - |
| 403 | ERROR | Token is not valid | Verify the generated token |
| 404 | ERROR | Beneficiary does not exist | Provide a valid beneficiary ID |
| 412 | ERROR | Token missing in the request | Enter the generated token as the value for Authorization under Headers in this format: Bearer <token>. |
Path Parameters
Unique Beneficiary ID of the beneficiary for which you want to view the details.
Was this page helpful?
⌘I