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}

Path parameters

id*string

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/v1/beneficiaries/bank-beneficiary/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Delete a payment gateway beneficiary by id

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

Path parameters

id*string

Response

200

Success

Request

JavaScriptCurlPython

const response = await fetch('/v1/beneficiaries/gateway-beneficiary/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();