Skip to main content
POST
Create Payout Quote

인증

Authorization
string
header
필수

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.

Scopes

payout:withdraw_funds

헤더

Idempotency-Key
string
필수

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

Maximum string length: 255
예시:

"payout-quote-aed-20260824"

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

본문

application/json
payout_method_id
string
필수

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

예시:

"potk_xxxxxxxxxxxxxx"

account_id
string

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

예시:

"biz_xxxxxxxxxxxxxx"

amount
number

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

예시:

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.

예시:

"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. Send recipient_amount instead of amount to quote the charge that delivers a set amount.

platform_covers_fees
boolean

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

recipient_amount
number

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. With payment_method_id, the card charge is set so the quote's net_amount is exactly this amount, or the quote is refused. Provide exactly one of amount or recipient_amount.

speed
enum<string>
기본값:standard

How fast the funds should arrive.

사용 가능한 옵션:
standard,
instant
예시:

"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: ^[ -~]+$
예시:

"ACME INV-10432"

user_id
string

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

응답

payout quote created

amount
object
필수

Gross payout amount.

conversion
object | null
필수

How a USD balance pays a bank in another currency: it converts into the payout method's currency, and the payout leaves from the balance in that currency. Null when the payout is paid from the requested balance directly.

destination_amount
object
필수

Exact amount quoted for delivery.

exchange_rate
number
필수

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

예시:

4.13978443

expires_at
string<date-time>
필수

When the quote expires.

예시:

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

fee
object
필수

Fee charged for the payout.

id
string
필수

Provider-backed payout quote ID, prefixed pout_.

예시:

"pout_aed_quote"

market_exchange_rate
number | null
필수

Interbank mid-market rate, with no spread, for the same conversion as exchange_rate. The gap between the two is the cost of the conversion. null when the payout provider does no foreign exchange, such as USD to a USD bank account. Also null when no market rate from the last 15 minutes is available, and on card-funded quotes.

예시:

4.14226979

market_exchange_rate_at
string<date-time> | null
필수

When market_exchange_rate was taken from the market feed, as an ISO 8601 timestamp. null when market_exchange_rate is null.

예시:

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

net_amount
object
필수

Amount remaining after fees.

object
enum<string>
필수
사용 가능한 옵션:
payout_quote
예시:

"payout_quote"

quote_token
string
필수

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

예시:

"signed-payout-quote"

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

server_time
string<date-time>
필수

Server time when the response was prepared, as an ISO 8601 timestamp. Subtract it from expires_at to get the remaining quote lifetime without relying on your own clock.

예시:

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