Skip to main content
POST
Create Payout Quote

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Body

application/json
from_currency
string
required

Currency to debit from balance.

to_currency
string
required

Destination payout currency.

amount
string
required

Amount in from_currency to quote.

payout_method
string | null

Optional payout method hint.

Response

Success - Payout quote generated

Response containing payout quote details.

quote_id
string
required

Payout quote ID.

from_currency
string
required

Debited currency.

to_currency
string
required

Destination currency.

from_amount
string
required

The amount debited from your balance in from_currency, before the withdrawal fee is deducted.

to_amount
string
required

The amount the destination will receive in to_currency, net of the withdrawal fee. This is NOT a gross currency conversion of from_amount: the fee is deducted from from_amount before the exchange rate is applied, so to_amount already reflects what lands on the other side.

exchange_rate
string
required

Applied quote exchange rate.

expires_at
string<date-time>
required

Quote expiration timestamp.