Skip to main content
GET
Get a quote by ID

Authorizations

Authorization
string
header
required

Enter Auth0 JWT token

Path Parameters

id
string
required

Quote UUID

Response

The quote. Both intents return the same shape.

expiresAt
string
required

Quote expiry timestamp (ISO 8601). Read this field for how long the quote is valid rather than assuming a duration.

Example:

"2026-04-13T12:00:30Z"

fromCurrency
string
required

Source currency (debited from the caller)

Example:

"NGN"

id
string
required

Quote identifier

Example:

"uuid-here"

rate
string
required

All-in rate: fromCurrency per 1 toCurrency. Always present; a same-currency or stablecoin-par quote (no FX leg) reports "1.00000000".

Example:

"2524.47560000"

targetAmount
string
required

Amount received in toCurrency

Example:

"100"

toCurrency
string
required

Target currency (received by the beneficiary, or credited to the caller's own balance for a convert quote)

Example:

"GBP"

totalDebitAmount
string
required

Total amount debited from the caller in fromCurrency. A payout quote prices FX + markup only, so this is the FX base; the payout's per-transaction fee (a flat amount, or basis points of the debit floored at that amount) is added at payout creation. A convert quote includes its fee here: the debit less fee is what converts at rate.

Example:

"252447.5600"

fee
string

Convert intent only: the fee taken out of totalDebitAmount, in feeCurrency. "0.0000" where your policy prices the pair without one.

Example:

"2.5000"

feeCurrency
string

Convert intent only: the currency fee is charged in — the source currency.

Example:

"USD"

status
enum<string>

Quote status (only included on GET)

Available options:
active,
used,
expired