Skip to main content
POST
Create Payout Quote

Authorizations

Authorization
string
header
required

An Account API key, an App 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.

Headers

Idempotency-Key
string
required

A unique key that makes this quote request safe to retry.

Maximum string length: 255
Example:

"payout-quote-aed-20260824"

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-24"

Body

application/json
payout_method_id
string
required

The saved payout method to quote (a potk_ identifier).

Example:

"potk_xxxxxxxxxxxxxx"

account_id
string

Account to pay out from, prefixed biz_. Provide exactly one of account_id or user_id.

Example:

"biz_xxxxxxxxxxxxxx"

amount
number<float>

The amount to pay out in the specified currency, fees included. Provide exactly one of amount or recipient_amount.

Example:

6762.41

currency
string

The currency to pay out. When omitted, uses usd if that balance can cover a withdrawal, otherwise the account's only other funded currency.

Example:

"eur"

payment_method_id
string

A saved card of the account, prefixed payt_, to quote paying this payout from. The quote's amount is the card charge, fee adds the estimated card fees to the payout fee, and net_amount is what the recipient receives.

platform_covers_fees
boolean

Whether the parent platform covers the payout fee instead of the account being paid out.

recipient_amount
number<float>

The amount the recipient should receive, with fees added on top. When the payout method pays out in currency, the quote's destination_amount covers it; otherwise its net_amount does. Provide exactly one of amount or recipient_amount.

speed
enum<string>
default:standard

How fast the funds should arrive.

Available options:
standard,
instant
Example:

"standard"

statement_descriptor
string | null

Payment description sent with the payout, such as an invoice number or what it pays for. Must be 5-80 printable ASCII characters (letters, digits, spaces and punctuation); Whop sends it in upper case. Not all countries and banks show it on the recipient's statement, and it is not the sender name. Omit or pass null to use the default descriptor.

Required string length: 5 - 80
Pattern: ^[ -~]+$
Example:

"ACME INV-10432"

user_id
string

User to pay out from, prefixed user_. Provide exactly one of account_id or user_id.

Response

payout quote created

amount
object
required

Gross payout amount.

destination_amount
object
required

Exact amount quoted for delivery.

exchange_rate
number<float>
required

Quoted exchange rate from the source currency to the destination currency.

Example:

4.13978443

expires_at
string<date-time>
required

When the quote expires.

Example:

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

fee
object
required

Fee charged for the payout.

id
string
required

Provider-backed payout quote ID, prefixed pout_.

Example:

"pout_aed_quote"

net_amount
object
required

Amount remaining after fees.

object
enum<string>
required
Available options:
payout_quote
Example:

"payout_quote"

quote_token
string
required

Server-signed quote token to submit to POST /payouts.

Example:

"signed-payout-quote"

An optional payout method to connect for estimated savings. The quote still uses the requested saved method.