Get Beneficiary Details

Retrieves details of an existing beneficiary of user in the PPI system.

• If bene_instrument_id is provided, the response includes details for the specified instrument only.
• If bene_instrument_id is not provided, the response includes details for all bene_instruments linked to the given bene_id.

POST /ppi/user/bene/details

cURL

withInstrumentId

curl --request POST \
  --url https://api.cashfree.com/ppi/user/bene/details \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '
{
  "user_id": "USER827364",
  "bene_id": "BENE28448",
  "bene_instrument_id": "INST194947"
}
'

200

SUCCESS_WITH_INSTRUMENT_ID

{
  "bene_id": "BENE28448",
  "cf_bene_id": "473974924929",
  "user_id": "USER827364",
  "bene_first_name": "John",
  "bene_last_name": "Doe",
  "status": "ACTIVE",
  "bene_instruments": [
    {
      "bene_instrument_id": "INST194947",
      "type": "BANK_ACCOUNT",
      "bank_bank_account_number": "3749378903",
      "ifsc": "HDFC0001234",
      "status": "ACTIVE",
      "verification_status": "VERIFIED",
      "cf_bene_instrument_id": "8324782642946"
    }
  ],
  "bene_contact_details": {
    "email": "[e-mail]",
    "phone": "9876543210",
    "dob": "1990-05-12",
    "gender": "MALE",
    "address": "No. 123, 5th Main, Indiranagar",
    "city": "Bangalore",
    "state": "Karnataka",
    "pincode": "560038",
    "country": "India"
  },
  "purpose": "Family",
  "notes": {
    "example_key_1": "example_value_1",
    "example_key_2": "example_value_2"
  }
}

Authorizations

x-client-id · string · header · required

Your unique client identifier issued by Cashfree. You can find this in your Merchant Dashboard.

x-client-secret · string · header · required

The secret key associated with your client ID. Use this to authenticate your API requests. You can find this in your Merchant Dashboard.

Headers

x-api-version · string · default: 2025-11-01 · required

API version to be used. Format is in YYYY-MM-DD.

Example:

"2025-11-01"

Body

application/json

Request parameters to fetch beneficiary details for a user.

user_id · string · required

Unique identifier for the user, as provided by you during PPI user creation.

Required string length: 1 - 50

Example:

"USER827364"

bene_id · string · required

Unique identifier for the beneficiary, as provided by you during beneficiary creation.

Required string length: 1 - 50

Example:

"BENE28448"

bene_instrument_id · string

Unique identifier for the instrument, as provided by you during beneficiary creation. If not provided, all bene_instruments for the beneficiary will be returned.

Required string length: 1 - 50

Example:

"INST194947"

Response

200

application/json

Success response for fetching beneficiary details.

bene_id · string

Unique identifier for the beneficiary, as provided by you during beneficiary creation.

Example:

"BENE28448"

cf_bene_id · string

Cashfree-generated unique ID for the beneficiary.

Example:

"473974924929"

user_id · string

Unique identifier for the user, as provided by you during PPI user creation.

Example:

"USER827364"

bene_first_name · string

First name of the beneficiary.

Example:

"John"

bene_last_name · string

Last name of the beneficiary.

Example:

"Doe"

status · string

Status of the beneficiary.

Example:

"ACTIVE"

bene_instruments · (Bank Account · object | VPA · object)[]

List of payment bene_instruments for the beneficiary.

Bank Account

VPA

Show child attributes

bene_contact_details · object

Contact details of the beneficiary. Only not null fields will be returned.

Show child attributes

purpose · string

Example:

"Family"

notes · object

Optional key-value pairs for any extra information. Keys and values must be strings. The following constraints apply:

• Maximum 10 entries.
• Keys: maximum 50 characters. Alphanumeric characters, underscores (_), periods (.), commas (,), single quotes ('), ampersands (&), hyphens (-), and spaces are allowed.
• Values: maximum 200 characters. Same character set as keys.

Show child attributes