Skip to main content
PATCH
TypeScript

Autorisaties

Authorization
string
header
vereist

An Account API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payout:update_destination

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

Payout method ID, prefixed potk_.

Body

application/json
address
object

The payout address to keep on file for this payout method. Only the fields you send are changed; blank fields are ignored.

is_default
enum<boolean>

Set to true to make this the account's default payout method. false is not accepted.

Beschikbare opties:
true
Voorbeeld:

true

nickname
string

New label for the payout method, with at least one non-whitespace character and a maximum of 100 characters.

Required string length: 1 - 100
Voorbeeld:

"Primary checking"

Respons

payout method updated

account_reference
string | null
vereist

Masked identifier for the destination.

Voorbeeld:

"••••0472"

bank_verification_state
enum<string> | null
vereist

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

Beschikbare opties:
checking,
verified,
no_data,
warning,
broken,
null
Voorbeeld:

"checking"

created_at
string<date-time>
vereist
Voorbeeld:

"2026-01-01T12:00:00.000Z"

destination_currency
string
vereist
Voorbeeld:

"usd"

estimated_arrival
object | null
vereist

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

Voorbeeld:

null

fee_structure
object | null
vereist

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

Voorbeeld:

null

id
string
vereist

Payout method ID, prefixed potk_.

Voorbeeld:

"potk_xxxxxxxxxxxxxx"

institution_name
string | null
vereist
Voorbeeld:

"Frost Bank"

is_clone
boolean
vereist

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

Voorbeeld:

false

is_default
boolean
vereist
Voorbeeld:

true

last_paid_out_at
string<date-time> | null
vereist

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.

Voorbeeld:

null

linked_via_plaid
boolean
vereist

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

Voorbeeld:

false

needs_plaid_reconnect
boolean
vereist

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

Voorbeeld:

false

nickname
string | null
vereist

User-defined label for the payout method.

Voorbeeld:

"Primary checking"

object
enum<string>
vereist
Beschikbare opties:
payout_method
Voorbeeld:

"payout_method"

payer_name
string | null
vereist
Voorbeeld:

"ACH Bank Deposit"

quote
object | null
vereist

Always null after an update.

Voorbeeld:

null

status
enum<string>
vereist

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.

Beschikbare opties:
created,
active,
broken
Voorbeeld:

"created"

status_reason
string | null
vereist

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.

Voorbeeld:

null

supported_payout_method
object | null
vereist
type
enum<string>
vereist

The kind of payout method. external sends funds out of Whop. whop_card moves funds onto the account's own Whop Card. A whop_card method takes standard-speed payouts only, and cannot be updated, reconnected, or deleted.

Beschikbare opties:
external,
whop_card
Voorbeeld:

"external"

unavailable_reason
enum<string> | null
vereist

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.

Beschikbare opties:
destination_retired,
null
Voorbeeld:

"destination_retired"

recipient
object

The recipient of a third-party payout method. Present only for recipient payout methods.