Create Payout Quote
Creates a short-lived, provider-backed quote for a payout. No funds move until the returned quote_token is submitted to POST /payouts. An Idempotency-Key header is required.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
A unique key that makes this quote request safe to retry.
255"payout-quote-aed-20260824"
Pins the request to a dated API version.
"2026-09-15"
Body
The amount to pay out in the specified currency.
6762.41
The saved payout method to quote (a potk_ identifier).
"potk_xxxxxxxxxxxxxx"
Account to pay out from, prefixed biz_. Provide exactly one of account_id or user_id.
"biz_xxxxxxxxxxxxxx"
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"
Whether the parent platform covers the payout fee instead of the account being paid out.
How fast the funds should arrive.
standard, instant "standard"
Text that appears on the recipient's bank statement. Must be 5-22 alphanumeric characters (A-Z, a-z, 0-9). Omit or pass null to use the default descriptor.
5 - 22"MYCOMPANY"
User to pay out from, prefixed user_. Provide exactly one of account_id or user_id.
Response
payout quote created
Gross payout amount.
Exact amount quoted for delivery.
Quoted exchange rate from the source currency to the destination currency.
4.13978443
When the quote expires.
"2026-01-01T12:00:00.000Z"
Fee charged for the payout.
Provider-backed payout quote ID, prefixed pout_.
"pout_aed_quote"
Amount remaining after fees.
payout_quote "payout_quote"
Server-signed quote token to submit to POST /payouts.
"signed-payout-quote"

