Skip to main content
POST
Disable Beneficiary
Sets the beneficiary’s status to disabled. A disabled beneficiary cannot fund new payouts, but it stays visible in listings and keeps its payout destinations. The call is idempotent: disabling an already-disabled beneficiary returns 200 with the beneficiary unchanged. It does not cascade. The beneficiary’s payout destinations keep their own status, and must be disabled individually if you want them disabled too. There is no client endpoint to re-enable a beneficiary. Re-activating one is a Hop support operation. Contact support if a beneficiary was disabled by mistake. 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

Returns the full beneficiary object, the same shape as Get Beneficiary, with status set to disabled.

Errors

Response Example