GET
/
beneficiary
curl --request GET \
  --url https://sandbox.cashfree.com/payout/beneficiary \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>'
{
  "beneficiary_id": "JOHN18011343",
  "beneficiary_name": "John Doe",
  "beneficiary_instrument_details": {
    "bank_account_number": "1223334444",
    "bank_ifsc": "HDFC0000001",
    "vpa": "test@upi"
  },
  "beneficiary_contact_details": {
    "beneficiary_email": "sample@cashfree.com",
    "beneficiary_phone": "9876543210",
    "beneficiary_country_code": "+91",
    "beneficiary_address": "177A Bleecker Street",
    "beneficiary_city": "New York City",
    "beneficiary_state": "New York",
    "beneficiary_postal_code": "560011"
  },
  "beneficiary_status": "VERIFIED",
  "added_on": "2023-12-04T15:50:00Z"
}

Authorizations

​
x-client-id
string
header
required

Client ID. You can find your app id in the Merchant Dashboard.

​
x-client-secret
string
header
required

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

​
x-api-version
string
default:2024-01-01
required

It is the API version to be used. The accepted format is YYYY-MM-DD.

​
x-request-id
string

It is the request ID for the API call. This ID can be used to resolve tech realted issues. Communicate this in your tech related queries to Cashfree Payments.

​
x-cf-signature
string

Signature to be sent if IP is not whitelisted

Query Parameters

​
beneficiary_id
string

It is the unique ID you created to identify the beneficiary while creating the beneficiary.

Maximum length: 50
​
bank_account_number
string

It is the bank account number of the beneficiary. If bank_account_number is passed in query, bank_ifsc should also be passed.

Required string length: 4 - 25
​
bank_ifsc
string

It is the IFSC information as present in the beneficiary's bank account information. If bank_ifsc is passed in query, bank_account_number should also be passed.

Required string length: 11

Response

200
application/json

OK

Contains the information of the created beneficiary