Sign in

a8a43db4255f

OpenAPI 3.1.02026-08-093813925.4 MB
Payouts

Rename Saved Payout Method

Changes the label used to identify a saved payout method.

patch/payouts/methods/{payout_method_id}

Request body

nicknamestring required

New label for the payout method.

Response

payout method renamed

account_referencestring nullable required

Masked identifier for the destination.

bank_verification_state'checking' | 'verified' | 'no_data' | 'warning' | 'broken' | 'null' nullable required

Lifecycle trust state: checking (verification still running), verified (bank confirmed ownership or a payout already completed to it), no_data (bank had nothing on file), warning (bank could not confirm ownership), broken (payouts failed with a permanent account error), null (never checked).

created_atstring date-time required
destination_currencystring required
estimated_arrivalobject nullable required

null after an update. List payout methods to retrieve arrival estimates.

fee_structureobject nullable required

null after an update. List payout methods to retrieve the configured fee terms.

idstring required

Payout method ID, prefixed potk_.

institution_namestring nullable required
is_defaultboolean required
nicknamestring nullable required

User-defined label for the payout method.

object'payout_method' required
payer_namestring nullable required
quoteobject nullable required

Always null after an update.

status'created' | 'active' | 'broken' required
unavailable_reason'destination_retired' | 'null' nullable required

Why this method can no longer receive payouts: destination_retired (the payout provider stopped offering the destination — the method must be re-added), null (usable).