Update Saved Payout Method
Changes the label used to identify a saved payout method or makes it the account’s default payout method.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
Pins the request to a dated API version.
"2026-08-25-2"
Path Parameters
Payout method ID, prefixed potk_.
Body
Set to true to make this the account's default payout method. false is not accepted.
true true
New label for the payout method, with at least one non-whitespace character and a maximum of 100 characters.
1 - 100"Primary checking"
Response
payout method updated
Masked identifier for the destination.
"••••0472"
Lifecycle trust state: checking (verification still running), verified (bank confirmed ownership or a payout already completed to it), no_data (verification unavailable or bank returned no ownership data), warning (bank could not confirm the destination's owner), broken (payouts failed with a permanent account error), null (never checked).
checking, verified, no_data, warning, broken, null "no_data"
"2026-01-01T12:00:00.000Z"
"usd"
null after an update. List payout methods to retrieve arrival estimates.
null after an update. List payout methods to retrieve the configured fee terms.
Payout method ID, prefixed potk_.
"potk_xxxxxxxxxxxxxx"
"Frost Bank"
Whether this method is a copy of one saved on another of the payer's accounts.
false
true
When the most recent completed payout was delivered to this method, as an ISO 8601 timestamp. null when nothing has been paid out to it yet.
Whether the payer added this method by signing in to their bank rather than typing account details.
false
Whether the bank sign-in behind this method has expired and must be redone before it counts as linked.
false
User-defined label for the payout method.
"Primary checking"
payout_method "payout_method"
"ACH Bank Deposit"
Always null after an update.
created — saved, no payout has completed through it yet. active — a payout through it completed. broken — a payout through it failed with an error attributable to the method, and it no longer accepts payouts; a later successful payout returns it to active.
created, active, broken "created"
Machine-readable code for why the method is broken — the newest failure recorded through it, whether a payout error or a pre-payout rejection. null unless the method is broken, or when it was disabled without a recorded failure.
Why this method is unavailable: destination_retired means the payout provider stopped offering the destination. Whop may automatically remap an eligible method that was not linked through Plaid to a compatible replacement; otherwise, the account owner must re-add it. null means no unavailability reason is known.
destination_retired, null "destination_retired"

