Skip to main content
GET
Get quote by ID

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Path Parameters

quoteId
string
required

Quote ID (qt_ prefix).

Response

200 - application/json

The request has succeeded.

A price quote for moving money between two instruments. It locks an exchange rate and the amounts for a short window; execute it by creating a transaction that references this quote's id.

id
string
required

Quote ID (qt_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
object
enum<string>
required

Resource type discriminator. Always "quote".

Available options:
quote
status
enum<string>
required

Current status of the quote.

Available options:
open,
accepted,
expired
customerId
string
required

The OMS customer that owns this record (cst_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
source
OMS wallet · object
required

The funding side, echoed from the request with resolved instrument detail.

destination
OMS wallet · object
required

The receiving side, echoed from the request with resolved instrument detail.

pricing
object
required

Consolidated economics.

sourceToDestination
enum<string>

Corridor composite derived from the two sides.

Available options:
cryptoToCrypto,
cryptoToCash,
cryptoToFiatAccount,
cashToCrypto,
fiatAccountToCrypto,
fiatAccountToFiatAccount
expiresAt
string<date-time>

When the locked pricing expires.

createdAt
string<date-time>

When the quote was created.

metadata
object

Free-form key-value pairs supplied at creation or update.