Skip to main content
DELETE
/
ppi
/
user
/
bene
/
remove
curl --request DELETE \
  --url https://api.cashfree.com/ppi/user/bene/remove \
  --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"
}
'
{
  "user_id": "USER827364",
  "bene_id": "BENE28448",
  "instrument": {
    "bene_instrument_id": "INST194947",
    "type": "BANK_ACCOUNT",
    "bank_bank_account_number": "3749378903",
    "ifsc": "HDFC0001234",
    "status": "REMOVED",
    "verification_status": "VERIFIED",
    "cf_bene_instrument_id": "8324782642946"
  },
  "status": "ACTIVE"
}

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 remove a beneficiary or a beneficiary instrument 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, the entire beneficiary will be removed.

Required string length: 1 - 50
Example:

"INST194947"

Response

Success response for removing a beneficiary.

ā€‹
user_id
string

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

Example:

"USER827364"

ā€‹
bene_id
string

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

Example:

"BENE28448"

ā€‹
instrument
Bank Account Ā· object

Instrument removed from the beneficiary (if provided in request).

ā€‹
status
string

Status of the beneficiary. Possible values:

  • ACTIVE
  • REMOVED
Example:

"ACTIVE"