Create Order

curl --request POST \
  --url https://staging.crossmint.com/api/2022-06-09/orders \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "payment": {
    "method": "arbitrum-sepolia",
    "currency": "eth",
    "receiptEmail": "[email protected]",
    "payerAddress": "<string>"
  },
  "lineItems": {
    "collectionLocator": "crossmint:<collectionId>",
    "callData": {
      "totalPrice": "<string>"
    }
  },
  "recipient": {
    "email": "[email protected]",
    "physicalAddress": {
      "name": "<string>",
      "line1": "<string>",
      "city": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "line2": "<string>",
      "state": "<string>"
    }
  },
  "locale": "en-US"
}
'

{
  "clientSecret": "_removed_",
  "order": {
    "orderId": "b2959ca5-65e4-466a-bd26-1bd05cb4f837",
    "phase": "payment",
    "locale": "en-US",
    "lineItems": [
      {
        "chain": "polygon-amoy",
        "quantity": 1,
        "callData": {
          "quantity": 1,
          "ADDITIONAL_PROPERTIES": "Your other mint function arguments"
        },
        "metadata": {
          "name": "Headless Checkout Demo",
          "description": "NFT Description",
          "imageUrl": "https://cdn.io/image.png"
        },
        "quote": {
          "status": "valid",
          "charges": {
            "unit": {
              "amount": "0.0001",
              "currency": "eth"
            },
            "salesTax": {
              "amount": "0.34",
              "currency": "usdc"
            },
            "shipping": {
              "amount": "0",
              "currency": "usdc"
            }
          },
          "totalPrice": {
            "amount": "0.0001",
            "currency": "eth"
          }
        },
        "delivery": {
          "status": "awaiting-payment",
          "recipient": {
            "locator": "email:<email_address>:<chain>",
            "email": "[email protected]",
            "walletAddress": "0x1234abcd..."
          }
        }
      }
    ],
    "quote": {
      "status": "valid",
      "quotedAt": "2024-06-07T16:55:44.653Z",
      "expiresAt": "2024-06-07T17:55:44.653Z",
      "totalPrice": {
        "amount": "0.0001375741",
        "currency": "eth"
      }
    },
    "payment": {
      "status": "awaiting-payment",
      "method": "base-sepolia",
      "currency": "eth",
      "preparation": {
        "chain": "base-sepolia",
        "payerAddress": "0x1234abcd...",
        "serializedTransaction": "0x02f90....."
      }
    }
  }
}

POST

2022-06-09

orders

Create Order

curl --request POST \
  --url https://staging.crossmint.com/api/2022-06-09/orders \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "payment": {
    "method": "arbitrum-sepolia",
    "currency": "eth",
    "receiptEmail": "[email protected]",
    "payerAddress": "<string>"
  },
  "lineItems": {
    "collectionLocator": "crossmint:<collectionId>",
    "callData": {
      "totalPrice": "<string>"
    }
  },
  "recipient": {
    "email": "[email protected]",
    "physicalAddress": {
      "name": "<string>",
      "line1": "<string>",
      "city": "<string>",
      "postalCode": "<string>",
      "country": "<string>",
      "line2": "<string>",
      "state": "<string>"
    }
  },
  "locale": "en-US"
}
'

{
  "clientSecret": "_removed_",
  "order": {
    "orderId": "b2959ca5-65e4-466a-bd26-1bd05cb4f837",
    "phase": "payment",
    "locale": "en-US",
    "lineItems": [
      {
        "chain": "polygon-amoy",
        "quantity": 1,
        "callData": {
          "quantity": 1,
          "ADDITIONAL_PROPERTIES": "Your other mint function arguments"
        },
        "metadata": {
          "name": "Headless Checkout Demo",
          "description": "NFT Description",
          "imageUrl": "https://cdn.io/image.png"
        },
        "quote": {
          "status": "valid",
          "charges": {
            "unit": {
              "amount": "0.0001",
              "currency": "eth"
            },
            "salesTax": {
              "amount": "0.34",
              "currency": "usdc"
            },
            "shipping": {
              "amount": "0",
              "currency": "usdc"
            }
          },
          "totalPrice": {
            "amount": "0.0001",
            "currency": "eth"
          }
        },
        "delivery": {
          "status": "awaiting-payment",
          "recipient": {
            "locator": "email:<email_address>:<chain>",
            "email": "[email protected]",
            "walletAddress": "0x1234abcd..."
          }
        }
      }
    ],
    "quote": {
      "status": "valid",
      "quotedAt": "2024-06-07T16:55:44.653Z",
      "expiresAt": "2024-06-07T17:55:44.653Z",
      "totalPrice": {
        "amount": "0.0001375741",
        "currency": "eth"
      }
    },
    "payment": {
      "status": "awaiting-payment",
      "method": "base-sepolia",
      "currency": "eth",
      "preparation": {
        "chain": "base-sepolia",
        "payerAddress": "0x1234abcd...",
        "serializedTransaction": "0x02f90....."
      }
    }
  }
}

Authorizations

X-API-KEY

string

header

required

Body

application/json

payment

EVM · object

required

EVM
Solana
Fiat

Show child attributes

payment.method

enum<string>

required

Available options:

arbitrum-sepolia,

base-sepolia,

ethereum-sepolia,

optimism-sepolia,

arbitrum,

bsc,

ethereum,

optimism

payment.currency

enum<string>

required

Available options:

eth,

usdc,

degen,

brett,

toshi,

usdxm,

credit

payment.receiptEmail

string<email>

Email that the receipt will be sent to.

payment.payerAddress

string

An EVM wallet address.

lineItems

Single Line Item - Collection Locator · object

required

Single Line Item - Collection Locator · object
Single Line Item - Product Locator · object
Single Line Item - Token Locator · object
Multiple Line Items - Collection Locators · object[]
Multiple Line Items - Token Locators · object[]

Show child attributes

lineItems.collectionLocator

string

required

The collection locator of the line item. For example: crossmint:<collectionId>. These fields can be retrieved from the Crossmint console.

Example:

"crossmint:<collectionId>"

lineItems.callData

object

Information that you pass to your contract mint function.

Show child attributes

lineItems.callData.totalPrice

string

The total price of the line item. It must be the same as the contract expects to receive. Read /docs.crossmint.com/payments/advanced/component-properties#mintconfig

lineItems.callData.{key}

any

recipient

Email · object

Recipient of the items being purchased. Crossmint will create a custodial wallet address for the user on the fly, that they can later log in to. If no recipient is passed, an order will be created with the status 'requires-recipient', until you pass one.

Email
Wallet

Show child attributes

recipient.email

string<email>

required

recipient.physicalAddress

object

Physical shipping address for the recipient. Required when purchasing physical products.

Show child attributes

recipient.physicalAddress.name

string

required

Full name of the recipient

recipient.physicalAddress.line1

string

required

Street address, P.O. box, company name, c/o

recipient.physicalAddress.city

string

required

City, district, suburb, town, or village

recipient.physicalAddress.postalCode

string

required

ZIP or postal code

recipient.physicalAddress.country

string

required

Two-letter country code (ISO 3166-1 alpha-2). Currently only US is supported.

recipient.physicalAddress.line2

string

Apartment, suite, unit, building, floor, etc.

recipient.physicalAddress.state

string

State, county, province, or region. Required for US addresses.

locale

enum<string>

default:en-US

Locale for the checkout, in IETF BCP 47. It impacts the email receipt language. Ensure your UI is set to the same language as specified here. Throws an error if passed an invalid language.

Available options:

en-US,

es-ES,

fr-FR,

it-IT,

ko-KR,

pt-PT,

ja-JP,

zh-CN,

zh-TW,

de-DE,

ru-RU,

tr-TR,

uk-UA,

th-TH,

vi-VN,

Klingon

Example:

"en-US"

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

Show child attributes

order.orderId

string

Example:

"b2959ca5-65e4-466a-bd26-1bd05cb4f837"

order.phase

string

Example:

"payment"

order.locale

string

Example:

"en-US"

order.lineItems

object[]

Show child attributes

order.lineItems.chain

string

Example:

"polygon-amoy"

order.lineItems.quantity

number

Example:

1

order.lineItems.callData

object

Show child attributes

order.lineItems.callData.quantity

number

Example:

1

order.lineItems.callData.ADDITIONAL_PROPERTIES

string

Example:

"Your other mint function arguments"

order.lineItems.metadata

object

Show child attributes

order.lineItems.metadata.name

string

Example:

"Headless Checkout Demo"

order.lineItems.metadata.description

string

Example:

"NFT Description"

order.lineItems.metadata.imageUrl

string

Example:

"https://cdn.io/image.png"

order.lineItems.quote

object

Show child attributes

order.lineItems.quote.status

string

Example:

"valid"

order.lineItems.quote.charges

object

Show child attributes

order.lineItems.quote.charges.unit

object

Show child attributes

order.lineItems.quote.charges.unit.amount

string

Example:

"0.0001"

order.lineItems.quote.charges.unit.currency

string

Example:

"eth"

order.lineItems.quote.charges.salesTax

object

Sales tax applied to physical product purchases

Show child attributes

order.lineItems.quote.charges.salesTax.amount

string

Example:

"0.34"

order.lineItems.quote.charges.salesTax.currency

string

Example:

"usdc"

order.lineItems.quote.charges.shipping

object

Shipping costs for physical product purchases

Show child attributes

order.lineItems.quote.charges.shipping.amount

string

Example:

"0"

order.lineItems.quote.charges.shipping.currency

string

Example:

"usdc"

order.lineItems.quote.totalPrice

object

Show child attributes

order.lineItems.quote.totalPrice.amount

string

Example:

"0.0001"

order.lineItems.quote.totalPrice.currency

string

Example:

"eth"

order.lineItems.delivery

object

Show child attributes

order.lineItems.delivery.status

enum<string>

Status of the delivery. 'awaiting-payment': Initial state before payment is made. 'in-progress': Payment received, transaction submitted but not yet completed. 'completed': Successfully delivered with transaction ID and tokens. 'failed': Delivery failed, typically for refunded transactions.

Available options:

awaiting-payment,

in-progress,

completed,

failed

Example:

"awaiting-payment"

order.lineItems.delivery.recipient

object

Show child attributes

order.lineItems.delivery.recipient.locator

string

Example:

"email:<email_address>:<chain>"

order.lineItems.delivery.recipient.email

string

Example:

"[email protected]"

order.lineItems.delivery.recipient.walletAddress

string

Example:

"0x1234abcd..."

order.quote

object

Show child attributes

order.quote.status

enum<string>

Status of the quote. 'requires-physical-address' indicates that a shipping address is required for physical products.

Available options:

valid,

expired,

all-line-items-unavailable,

requires-physical-address

Example:

"valid"

order.quote.quotedAt

string

Example:

"2024-06-07T16:55:44.653Z"

order.quote.expiresAt

string

Example:

"2024-06-07T17:55:44.653Z"

order.quote.totalPrice

object

Show child attributes

order.quote.totalPrice.amount

string

Example:

"0.0001375741"

order.quote.totalPrice.currency

string

Example:

"eth"

order.payment

object

Show child attributes

order.payment.status

enum<string>

Status of the payment. View the status codes for more information.

Available options:

requires-kyc,

failed-kyc,

manual-kyc,

awaiting-payment,

requires-recipient,

requires-crypto-payer-address,

failed,

in-progress,

completed

Example:

"awaiting-payment"

order.payment.method

string

Example:

"base-sepolia"

order.payment.currency

string

Example:

"eth"

order.payment.preparation

object

Show child attributes

order.payment.preparation.chain

string

Example:

"base-sepolia"

order.payment.preparation.payerAddress

string

Example:

"0x1234abcd..."

order.payment.preparation.serializedTransaction

string

Example:

"0x02f90....."

Status Codes Get Order

Introduction

Hosted (pop-up)

Embedded

Headless (API)

Advanced Guides

API Reference

Create Order

Authorizations

Body

Response