Skip to main content
POST
Disable Beneficiary
Disables a beneficiary. No future payments are allowed to a disabled beneficiary, but it remains visible in listings. The request takes the path id with an empty body.
Disable is the way to retire a beneficiary — there is no hard delete on this API.

Path Parameters

string
required
Id of the parent account (e.g. acct_...).
string
required
Beneficiary id (e.g. bene_...).

Response

Returns 200 with the beneficiary object, where status is disabled.