Reserve quote

Request fields:

  • sourceCurrency - The currency being sold.
  • targetCurrency - The currency being bought.
  • amount - The source amount to reserve the quote for.

Response fields:

  • quoteId - The ID of the reserved quote. Use this value as quoteId when creating the exchange transaction.
  • sourceCurrency - The source currency of the quote.
  • targetCurrency - The target currency of the quote.
  • amount - The reserved exchange rate.
  • quantity - The reserved source amount. This must match the exchange transaction amount.
  • maxSellLimit - The maximum sell amount allowed for the currency pair.
  • validUntil - The time until which the quote is valid.

USING A RESERVED QUOTE IN AN EXCHANGE

A reserved quote can be used when creating an exchange transaction (https://apidocs.op-digital.com/update/reference/create-exchange-transaction#/).

Requirements:

  • Include the reserved quote ID as quoteId in the exchange request.
  • The exchange transaction amount must equal the reserved quote quantity.
  • The source account currency must equal the reserved quote sourceCurrency.
  • The destination account currency must equal the reserved quote targetCurrency.
  • The quote must still be valid when the exchange is processed.

When a reserved quote is used, the exchange is submitted as a fill-or-kill order. It will either be filled immediately using the reserved quote or fail if the quote is no longer valid.

LIST RESERVED QUOTES

The list reserved quotes endpoint returns active reserved quotes for the merchant.

Available filters:

  • sourceCurrency - Filter by source currency.
  • targetCurrency - Filter by target currency.
  • quoteId - Filter by a specific reserved quote ID.


Did this page help you?