Skip to main content
POST
Create Order

Authorizations

X-API-KEY
string
header
required

Body

application/json
payment
Card · object
required

Payment configuration for the onramp order. Onramp is completed with a card.

lineItems
object[]
required

The tokens to purchase. Provide a single line item identifying the token and the amount to spend.

Required array length: 1 element
recipient
Wallet · object

Recipient of the tokens being purchased. Provide either walletAddress or email, not both. When an email is provided, Crossmint creates a custodial wallet for the user that they can later log in to.

state
enum<string>
default:create

Determines whether an order is officially created or whether it simply returns what an order would look like. Use draft to review the quote prior to committing. Draft orders are not persisted and will not be queryable via APIs. Use create (default) to place the order and proceed to payment.

Available options:
draft,
create

Response

Order successfully created.

clientSecret
string

A token exclusively scoped to a particular order, allowing for the reading or updating of that order.

Example:

"_removed_"

order
object