Skip to main content
POST
TypeScript

Autorisations

Authorization
string
header
requis

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:create_destination

En-têtes

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Exemple:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Corps

application/json
supported_payout_method_id
string
requis

The supported payout method to save (a podst_ identifier from a previous listing).

Exemple:

"podst_xxxxxxxxxxxxxx"

account_id
string

The account to add the payout method for, prefixed biz_. Provide this or user_id.

Exemple:

"biz_xxxxxxxxxxxxxx"

destination_currency
string
défaut:usd

Currency the supported payout method delivers payouts in.

Exemple:

"usd"

fields
object

The supported payout method's required field values, keyed by field id — list them with GET /payouts/supported_methods?supported_payout_method_id=.... Field ids are stable fld_ identifiers you may hardcode; they never change for a given field. A Basis Theory token id may be passed in place of a raw value. For a U.S. bank routing-number field, a raw nine-digit value must also pass the ABA checksum. A validation failure returns the method's full required_fields schema alongside the error. Required whenever the account details are supplied directly.

Exemple:
is_default
boolean
défaut:false

Whether to make this the account's default payout method.

Exemple:

false

nickname
string

A label for the payout method, unique per destination.

Exemple:

"Ops checking"

The token your return_url received after a Log in with PayPal session started with POST /payouts/paypal_link_sessions. Use it for a PayPal supported payout method instead of fields. Sending fields or plaid_public_token alongside it is rejected, and nickname is ignored because Whop names the method after the PayPal email. The PayPal holder's name must match the name on the account's payout setup. An account PayPal reports as unverified, or with an unconfirmed email, is saved and flagged on the method's log rather than refused. Single use; expires 15 minutes after the login.

Exemple:

"pplt_mYWzcqskZuBf2-JTpooLjo5hl5HdE2P68o90dgJjWGQ"

recipient
object

Creates a recipient payout account linked to the funding ledger as a non-default account, then saves the bank method on it. No Whop user, Whop account, or recipient ledger is created. A valid recipient email is required. Recipient methods cannot be default or recurring methods and cannot use Plaid.

user_id
string

The user to add the payout method for, prefixed user_. Provide this or account_id.

Exemple:

"user_xxxxxxxxxxxxxx"

Réponse

payout method created

account_reference
string | null
requis

Masked identifier for the destination.

Exemple:

"••••0472"

created_at
string<date-time>
requis
Exemple:

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

destination_currency
string
requis
Exemple:

"usd"

estimated_arrival
object | null
requis

Null on create. List payout methods to retrieve arrival estimates.

Exemple:

null

fee_structure
object | null
requis

Null on create. List payout methods to retrieve the configured fee terms.

Exemple:

null

id
string
requis

Payout method ID, usable as payout_method_id on POST /payouts.

Exemple:

"potk_xxxxxxxxxxxxxx"

institution_name
string | null
requis
Exemple:

"Frost Bank"

is_default
boolean
requis
Exemple:

false

last_paid_out_at
string<date-time> | null
requis

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.

Exemple:

null

nickname
string | null
requis

User-defined label for the payout method.

Exemple:

"Ops checking"

object
enum<string>
requis
Options disponibles:
payout_method
Exemple:

"payout_method"

payer_name
string | null
requis
Exemple:

"ACH Bank Deposit"

quote
object | null
requis

Always null on create.

Exemple:

null

status
enum<string>
requis

Always created on create — no payout has used the method yet.

Options disponibles:
created,
active,
broken
Exemple:

"created"

status_reason
string | null
requis

Always null on create.

Exemple:

null

supported_payout_method
object | null
requis
unavailable_reason
enum<string> | null
requis

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.

Options disponibles:
destination_retired,
null
Exemple:

"destination_retired"

bank_verification_state
enum<string> | null

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

Options disponibles:
checking,
verified,
no_data,
warning,
broken,
null
Exemple:

"checking"

is_clone
boolean

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

Exemple:

false

linked_via_plaid
boolean

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

Exemple:

false

needs_plaid_reconnect
boolean

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

Exemple:

false

recipient
object

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

type
enum<string>

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.

Options disponibles:
external,
whop_card
Exemple:

"external"