Sign in

6fb1c04bf255

OpenAPI 3.1.02026-08-123844095.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, with at least one non-whitespace character and a maximum of 100 characters.

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 (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).

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_cloneboolean required

Whether this method is a copy of one saved on another of the payer's accounts.

is_defaultboolean required
linked_via_plaidboolean required

Whether the payer added this method by signing in to their bank rather than typing account details.

needs_plaid_reconnectboolean required

Whether the bank sign-in behind this method has expired and must be redone before it counts as linked.

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 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.