Skip to main content
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>'
"{\n  \"status\":\"SUCCESS\", \n  \"subCode\":\"200\", \n  \"message\":\"Details of beneficiary\", \n  \"data\":\n  { \n     \"beneId\":\"JOHN18011\", \n     \"name\":\"John\",\n     \"groupName\":\"DEFAULT\", \n     \"email\":\"johndoe@cashfree.com\", \n     \"phone\":\"9876543210\", \n     \"address1\":\"ABCavenue\", \n     \"address2\":\"\", \n     \"city\":\"Bangalore\", \n     \"state\":\"Karnataka\", \n     \"pincode\":\"0\", \n     \"bankAccount\":\"00001111222233\", \n     \"ifsc\":\"HDFC0000001\",\n      \"status\":\"VERIFIED\"\n   }\n}"

Headers

​
Authorization
string
required

Bearer auth token

​
Content-Type
string
required

application/json

​
X-Cf-Signature
string

Signature to be sent if IP is not whitelisted.

Path Parameters

​
beneId
string
required

Unique Beneficiary ID of the beneficiary for which you want to view the details.

Response

200

​
status
string
Example:

"SUCCESS"

​
subCode
string
Example:

"200"

​
message
string
Example:

"Details of beneficiary"

​
data
object