Skip to main content
DELETE
Delete Beneficiary
Deletes a beneficiary. The delete is a soft delete: the record is retained for audit and its status is left untouched, but the beneficiary stops being returned by any client endpoint. Delete every payout destination first: a beneficiary with any non-deleted destination, disabled and pending ones included, returns 422 DELETE_BLOCKED with details.beneficiary_id. Requires an API key with write access on the payments scope.

Path Parameters

string
required
The account’s external ID (starts with acct_)
string
required
The beneficiary’s external ID (starts with bene_)

Response

string
The beneficiary identifier that was deleted
string
Always returns "beneficiary"
boolean
Always returns true

Errors

Response Example