GET
/
beneficiary
{
  "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
headerrequired

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

ā€‹
x-client-secret
string
headerrequired

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

Headers

ā€‹
x-api-version
string
default: 2024-01-01required

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.

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

Contains the information of the created beneficiary

ā€‹
beneficiary_id
string

It displays the unique Id you created to identify the beneficiary.

ā€‹
beneficiary_name
string

It displays the name of the beneficiary.

ā€‹
beneficiary_instrument_details
object

It displays the payment instrument details of the beneficiary.

ā€‹
beneficiary_contact_details
object

It displays the contact details of the beneficiary.

ā€‹
beneficiary_status
enum<string>

It displays the current status of the beneficiary. Possible values are as follows

  • VERIFIED: Beneficiary is verified and is available for payouts
  • INVALID: Beneficiary is invalid
  • INITIATED: Beneficiary verification initiated
  • CANCELLED: Beneficiary verification cancelled
  • FAILED: Failed to verify beneficiary
  • DELETED: Beneficiary is deleted
Available options:
VERIFIED,
INVALID,
INITIATED,
CANCELLED,
FAILED,
DELETED
ā€‹
added_on
string

It displays the time of the addition of the beneficiary in UTC.

Was this page helpful?

Batch Transfer V2Create Beneficiary V2