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
Authorizations
Path parameters
idstringRequired
Responses
200
Success
delete
DELETE /v1/beneficiaries/bank-beneficiary/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Success

No content

Delete a payment gateway beneficiary by id

delete
Authorizations
Path parameters
idstringRequired
Responses
200
Success
delete
DELETE /v1/beneficiaries/gateway-beneficiary/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
200

Success

No content
PreviousFetch a beneficiaryNextBanks

Last updated