Quotes

Retrieve a quote

Retrieves a quote by its ozav_q_ id, including its rate, exchange_conditions, and expires_at. Every quote today is rate_type: floating with expires_at: null: the rate is indicative and re-derives at execution (see Quote.rate_type).

get/quotes/{quote_id}

Request

  • Base URL
    https://developers.ozav.io/v2
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

quote_idstring required

The opaque quote id (ozav_q_...).

Response

The quote.

idstring required

Opaque quote identifier, prefixed ozav_q_.

object'quote' required

Resource type discriminator; always the literal quote.

customer_idstring

Opaque customer id (prefixed ozav_cus_) the quote was created for.

rate_type'floating' | 'locked' required

How the rate behaves until execution.

  • floating - indicative; the rate re-derives at execution time. Every quote returns this today, and it comes with expires_at: null: a firm price holds for only a few seconds, so OZAV re-quotes at execution instead of expiring your quote. Treat rate as indicative: what executes can differ from the quote.
  • locked - held fixed until expires_at. Not served on this API yet. When it ships it will require the price-lock facility enabled on your account, and will carry a real expires_at. Ask OZAV if you need a firm price today.

Do not branch on expires_at being non-null: on floating it is always null, in sandbox and in production alike.

ratestring required

The FX rate as a decimal string - target-currency units per one source unit, all-in except for any amount_deducted (it already carries any spread_bps you added). Indicative on a floating quote, which is every quote today: it re-derives at execution. On the quote, source.amount x rate gives target.amount (with amount_deducted present, (source.amount - amount_deducted) x rate).

expires_atstring date-time nullable required

When the quote expires (RFC 3339 / ISO 8601, UTC).

null on a floating quote is the normal answer, not a missing value, and it does not mean the quote is valid forever. A floating rate is indicative: it re-derives at execution, so there is no window to "accept" it within. Quote as close to execution as you can, and read the rate you are given at execution as the one that applies.

A timestamp appears only when the rate is held: a locked quote, which expires at this instant and is refused after it.

created_atstring date-time required

When the quote was created (RFC 3339 / ISO 8601, UTC).

Example response

{
  "source": {
    "amount": "1250.00"
  },
  "target": {
    "amount": "1250.00"
  },
  "legs": [
    {
      "source": {
        "amount": "1250.00"
      },
      "target": {
        "amount": "1250.00"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.