orders-quotes

Request a Quote

post/orders/quotes

Request body

amountnumber required

asset amount

payoutCurrencystring required

payout currency

paymentChannel'BANK_TRANSFER' | 'MOBILE_MONEY' | 'P2P_WALLET' required

Payment channel a provider is used for

type'BUY' | 'SELL'
paymentMode'DEPOSIT' | 'INTERNAL_TRANSFER'

How the buyer is paying fiat for a BUY order. Chosen at quote time on POST /quotes and persisted on the resulting quote; the BUY order then inherits the value when it references the quote. Clients do not (and cannot) re-specify it on the order request — the quote is the binding contract.

  • DEPOSIT — buyer transfers fiat from an external bank account into the merchant's pay-in account. Every payouts provider supports this and it is the default when the field is omitted.
  • INTERNAL_TRANSFER — buyer pays via an internal transfer routed through a configured override provider (currently onb-nuban for merchants on onb-nuban-collections). Quote generation filters out merchants whose payment account doesn't have providerDetails.supportsCustomPayin=true, or whose provider has no configured internal-transfer override on the order service. If no merchant satisfies the request, quote generation returns NoMatchingQuoteException rather than producing a quote that would later fail at order placement.

Response

Success

Changes

Changed in 1 of the 6 revisions of this API.2

    • the endpoint scheme security HMACAuth was added to the API

      api-security-added

    • the endpoint scheme security authToken was removed from the API

      api-security-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog