Skip to main content
POST
/
payout
/
v1
/
removeBeneficiary
Remove Beneficiary
curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1/removeBeneficiary \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "beneId": "<string>"
}
'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Beneficiary removed"
}
This API will be retired soon. Please plan to migrate to the latest version, Beneficiary V2.
Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)
Sub codeStatusMessageNext action
200SUCCESSBeneficiary removed-
403ERRORToken is not validValidate the generated token.
403ERRORIP not whitelistedWhitelist the IP address.
404ERRORBeneficiary does not exist with given IdEnter a valid beneficiary ID.
412ERRORToken missing in the requestEnter the generated token as the value for Authorization under Headers in this format: Bearer <token>
412ERRORBeneId missing in the requestEnter a valid beneficiary ID.
422ERRORPlease provide a valid Beneficiary IdEnter a valid beneficiary ID.
520ERRORUnknown error occurredTry again after some time.

Headers

ā€‹
Authorization
string
required

Bearer auth token

ā€‹
Content-Type
string
required

application/json

Body

application/json
ā€‹
beneId
string
required

Beneficiaries Id to delete, alphanumeric and underscore allowed (50 character limit)

Response

200

ā€‹
status
string
Example:

"SUCCESS"

ā€‹
subCode
string
Example:

"200"

ā€‹
message
string
Example:

"Beneficiary removed"