Skip to main content
POST

Order type

The type field sets the order type: on-ramp to buy crypto with fiat, or off-ramp to sell crypto for fiat. It defines the shape of the rest of the request, including the node types allowed as origin and destination.

Origin and destination

The origin and destination objects identify the source and destination of funds respectively for the order. Read more about the Anatomy of a quote request to understand the different types of nodes you can use as origin and destination for each order type. Refer to the API spec below to see how each node type is expressed in the request.

Denomination

The denomination object defines what is being moved, how much, and which side of the order the amount applies to precisely.
  • asset: The currency or asset in which amount is expressed — for example, USD or BTC. Does not need to match the asset of the origin or the destination; Uphold will convert as needed.
  • amount: The amount of the order, expressed as a decimal string (e.g. "100.00").
  • target: Controls which side of the order has the exact amount:
    • origin — The origin pays exactly amount. Fees are deducted before the destination receives funds.
    • destination — The destination receives exactly amount. Fees are added on top of what the origin pays.

Example: How target affects fee handling

Consider an on-ramp of 500 USD to BTC with a 2% fee: Use origin when you want to control exactly how much the user pays. Use destination when you want to control exactly how much the user receives. For a more comprehensive explanation of the denomination concept, see the Core API introduction page.

Pricing and fees

The pricing field in the response says whether the rate is locked for the order or estimated, in which case the final amounts may differ. Quotes for orders whose deposit the user pushes, such as crypto from an external wallet, are always estimated. The fees field lists each fee charged on the order. Read more about pricing and fees.

Quote expiry

A quote is valid for a limited time. The expiresAt field in the response indicates the exact time when the quote expires, after which it can no longer be used to create an order. The refreshAt field indicates the recommended time to refresh the quote. There is no endpoint to refresh a quote: to refresh it, create a new one. Use it to drive quote refresh logic in your UI: if the user hasn’t confirmed by then, create a new quote. The quote’s expiresAt is equal to or later than refreshAt, to give the user time to complete an external action needed to proceed, such as authorizing an APM payment. A quote can only be used once. See Creating a quote-based order for the error returned when an order is created from an expired or already used quote.

Requirements

Some quotes require additional information before the order can be created. The requirements array in the response lists what is needed — if it’s empty, no extra information is needed and you can proceed to create the order directly. Read more about requirements.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication

Scopes

on-off-ramp.orders.quotes:create

Grants access to create order quotes.

Body

application/json
type
enum<string>
required

The type of the quote.

Available options:
on-ramp
origin
External account · object
required
destination
Crypto address · object
required
denomination
object
required

Response

Quote created.

quote
On-ramp · object
required