Delete a beneficiary

This endpoint deletes a beneficiary. You will no longer be able to initiate disbursements using the deleted beneficiary ID. This action is irreversible.

Delete a bank transfer beneficiary by id.

delete

/v1/beneficiaries/bank-beneficiary/{id}

Authorizations

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/beneficiaries/bank-beneficiary/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

No body

Success

Delete a payment gateway beneficiary by id

delete

/v1/beneficiaries/gateway-beneficiary/{id}

Authorizations

Path parameters

idstringrequired

Responses

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/beneficiaries/gateway-beneficiary/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

200

No body

Success