Skip to main content
POST
Create FX Quote

Path Parameters

string
required
The account’s external ID (starts with acct_)

Request Body

string
required
Currency to convert from (e.g., USD, EUR, USDC)
string
required
Currency to convert to (e.g., EUR, USD, USDT)
string
required
Amount to convert (decimal string, must be positive)
string
required
Whether the amount is in source or target currency: source or target
object
Fee the platform charges its end user, deducted from the target proceeds when the quote is executed: the end user is credited target_amount minus platform_fee.amount, and the fee is credited to the platform’s fee-collection account. Platform customers only (end-customer accounts, feature-flagged). Fields: currency (string, must equal target_currency) and amount (string, > 0, at most the currency’s decimal places, less than target_amount).

Response

string
FX quote identifier (starts with fxq_)
string
Always returns "fx_quote"
string
Account ID
string
Source currency code
string
Target currency code
string
Whether the amount is source or target
string
Source currency amount (decimal)
string
Target currency amount (decimal)
object
Platform fee deducted from target_amount at execution (currency, amount), or null when none.
string
All-in exchange rate including spread (decimal)
string
ISO 8601 timestamp when quote expires
string
ISO 8601 timestamp when quote was executed (null if not yet executed)
string
ISO 8601 timestamp when created
string
ISO 8601 timestamp when last updated

Response Example