Skip to main content
PATCH
Update Payout Destination
label is the only field this endpoint accepts. Any other key in the body is rejected with 422, and an empty body is a 200 no-op that returns the destination unchanged. Bank details, wallet details, currency and status cannot be edited. Delete the destination and create a new one instead. 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_)

Request Body

string
Your own label for this destination (max 255 characters). null, or an absent field, leaves the current value unchanged.

Response

Returns the updated payout destination object, the same shape as Get Payout Destination.

Errors

Request Example

Response Example