Skip to main content
DELETE
Delete Payout Destination
Deletes a payout destination. The delete is a soft delete: the record is retained for audit and its status is left untouched, but the destination stops being returned by any client endpoint and can no longer be paid. Deleting also cancels the pending approval of a wallet that Hop has not yet activated. Deleting the beneficiary is refused while any non-deleted destination remains. 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

string
The payout destination identifier that was deleted
string
Always returns "payout_destination"
boolean
Always returns true

Errors

Response Example