Skip to main content
POST
Disable Payout Destination
Sets the destination’s status to disabled. A disabled destination cannot be used for new payouts, but it stays visible in listings and on its beneficiary. The call is idempotent: disabling an already-disabled destination returns 200 with the destination unchanged. Disabling a pending wallet also cancels its approval, so it will not be activated by Hop. There is no client endpoint to re-enable a payout destination. Re-activating one is a Hop support operation. Contact support if a destination was disabled by mistake, or create a new destination. 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_)
string
required
The payout destination’s external ID (starts with dest_)

Response

Returns the full payout destination object, the same shape as Get Payout Destination, with status set to disabled.

Errors

Response Example