Skip to main content
DELETE
/
beneficiary
Remove Beneficiary V2
curl --request DELETE \
  --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": "DELETED",
  "added_on": "2023-12-04T15:50:00Z"
}
HTTP Status CodeError CodeMessageNext Action
201---
400beneficiary_id_invalidbeneficiary_id : should contain only letters, numbers, hyphen, underscore, pipe, and dot. Value received: .\qewqefwqevEnter a valid beneficiary_id.
400beneficiary_id_length_exceededbeneficiary_id : should not be more than 50 characters long. value received: test_bene_idEnter a valid a beneficiary_id
404beneficiary_not_foundBeneficiary does not existProvide the beneficiary_id of an existing beneficiary

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.

Query Parameters

​
beneficiary_id
string

It is the unique ID you create to identify the beneficiary. The maximum character limit is 50. Only alphabets and whitespaces are allowed.

Maximum length: 50

Response

OK

Contains the information of the created beneficiary

​
beneficiary_id
string

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

Example:

"JOHN18011343"

​
beneficiary_name
string

It displays the name of the beneficiary.

Example:

"John Doe"

​
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
Example:

"VERIFIED"

​
added_on
string

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

Example:

"2023-11-22T12:38:22Z"