Skip to main content
POST
The order ID will be the same as the quote ID to allow for easy tracking and correlation.

Requirements

If the quote lists requirements, provide the data for each of them in params.requirements, such as authorize:3ds with a returnUrl. A travel-rule requirement must be resolved before creating the order. When the user must confirm the payment, such as with a 3DS challenge, the origin node of the created order carries a confirmationUrl to send the user to.
Orders that send the authorize:3ds requirement need the user context headers, X-Uphold-User-Ip and X-Uphold-User-Agent.

Metadata

You can optionally include custom entity metadata in the metadata field to store your own business data (e.g., reference numbers, categorization, reconciliation data), which needs the on-off-ramp.orders.metadata:write scope. If not provided during creation, you can add it later using Set metadata.
If saving the metadata fails, the order is still created and the response includes an errors.metadata property. See Entity metadata for details.

Authorizations

Authorization
string
header
required

OAuth 2.0 authentication

Scopes

on-off-ramp.orders:create

Grants access to create orders.

Body

application/json
quoteId
string<uuid>
required

The id of the quote to create the order from.

params
object

Additional parameters required to create the order.

metadata
object

Additional data for the order.

Response

Order created.

order
On-ramp · object
required
errors
object

Additional contextual errors that occurred while processing the request.