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}"
This API will be retired soon. Please plan to migrate to the latest version, Beneficiary V2.
Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)
Sub CodeStatusMessageNext Action
200SUCCESSDetails of beneficiary-
403ERRORToken is not validVerify the generated token
404ERRORBeneficiary does not existProvide a valid beneficiary ID
412ERRORToken missing in the requestEnter the generated token as the value for Authorization under Headers in this format: Bearer <token>.

Headers

ā€‹
Authorization
string
required

Bearer auth token

ā€‹
Content-Type
string
required

application/json

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