Skip to main content
Enterprise feature. Contact us for access.

​
Introduction

In this quickstart you’ll learn how to accept credit card payments (including Apple and Google Pay) using Crossmint’s headless APIs to purchase an NFT on the polygon-amoy testnet

​
Prerequisites

​
From Crossmint

  1. Create a developer account in the Staging Console.
  2. Create a new collection or import yours into the console, and have your collectionId ready.
    • Make sure you follow the maximum prices for collections set in staging outlined here.
  3. Create a server-side API key with the orders.create, orders.update, and orders.read scopes enabled. More info on creating API keys here.
This Quickstart assumes that you'll be using the API Playground or cURL requests to make the API calls. This approach requires the use of a server-side API key.If you would rather follow the quickstart while building a client-side app that makes requests to Crossmint directly from the browser, you must use a client-side API key. For client-side usage, you don't need the orders.read scope - use the clientSecret from order creation for subsequent operations. See the Server or Client Guide for more information.
To integrate in production/mainnet, you'll also need to complete account and collection verification. More information in the production launch guide.

​
Integration Steps

This quickstart will focus on the API calls to Crossmint necessary to implement headless checkout in your project, as well as the usage of Crossmint Embedded Checkout component to collect the user's payment.
This guide assumes you are using React, however Crossmint's checkout can be used in all platforms such as Web, iOS, Android, and React Native.

​
1. Create an Order

The first step in the headless checkout process is to create an order. An order is an object datastructure, that represents an intent to purchase in Crossmint's systems. This guide will create a basic order, and then update it with required info step-by-step.
You can also create the entire order in one API call if the necessary information is available at the time of order creation. This can be used for custom "one-click-checkout" experiences, should you wish to make them.
POST https://staging.crossmint.com/api/2022-06-09/orders Refer to the complete create order API reference here. 
{
    "payment": {
        "method": "card",
    },
    "lineItems": [
        {
            "collectionLocator": "crossmint:<collectionId>", // Use the collectionId you created in the Prerequisites section
            "callData": {
                "totalPrice": "0.0001"
            }
        }
    ]
}

{
  "clientSecret": "_removed_",
  "order": {
    "orderId": "cc40e6af-f8dc-4ac2-8e26-d91a32f271cf",
    "phase": "quote",
    "locale": "en-US",
    "lineItems": [
      {
        "chain": "polygon-amoy",
        "quantity": 1,
        "callData": {
          "quantity": 1
        },
        "metadata": {
          "name": "Headless Demo",
          "description": "NFT Checkout Demo",
          "imageUrl": "https://utfs.io/f/cd8545b7-3410-4fcd-988d-cd11951ed53c-g287ok.png"
        },
        "quote": {
          "status": "requires-recipient",
          "charges": {
            "unit": {
              "amount": "0.000169004",
              "currency": "eth"
            }
          },
          "totalPrice": {
            "amount": "0.000169004",
            "currency": "eth"
          }
        },
        "delivery": {
          "status": "awaiting-payment"
        }
      }
    ],
    "quote": {
      "status": "requires-recipient",
      "quotedAt": "_DATE_",
      "expiresAt": "_DATE_",
      "totalPrice": {
        "amount": "0.000169004",
        "currency": "eth"
      }
    },
    "payment": {
      "status": "requires-quote",
      "method": "basis-theory",
      "preparation": {},
    }
  }
}
For the comprehensive list of supported currencies and chains, view the Supported Currencies page.
At this point you have successfully created an Order in the Crossmint system! The order is currently in the quote phase and is awaiting a recipient to be set. Setting a recipient does not mean that we are sending the NFT to them; it is merely used to verify that the intended recipient is a valid address, before beginning gathering payment info.

​
Optional - View the Order in the Console

Congratulations! You've made your first contact with Crossmint's systems. You can see your request show up in the developer console. Navigate to the Orders tab for your collection in the Staging Console and enter the orderId returned from your API response to find your incomplete order object and status. Crossmint Headless Checkout - view order

​
2. Update the Order with Recipient

Next, you will set who's the intended recipient of the order by specifying a wallet address or email. When a recipient is passed as an email, Crossmint will automatically create a custodial wallet associated with this email, that can be accessed by logging in to the (staging) Crossmint Wallet or from your website if you're using whitelabel wallets. PATCH https://staging.crossmint.com/api/2022-06-09/orders/<orderId>
Remember to ensure you're using the right type of API key! See the Server or Client Guide for more info.
Refer to the complete edit order API reference here.
Legally, for card payments, an email must be specified in order to deliver a receipt to your user, either in recipient.email or in payment.receiptEmail. If one is not specified, the API will not return the fields necessary to collect the user’s payment.
{
    "recipient": {
        "email": "[email protected]"
    }
}

​
3. Render the Crossmint Embedded Component

After creating an order, you’ll need to render the Crossmint Embedded Component to collect payment information. 
import { CrossmintEmbeddedCheckout, CrossmintProvider } from "@crossmint/client-sdk-react-ui";

export function MyCheckoutPage({ clientSecret, order, recipientWalletAddress }) {
  return (
      <CrossmintProvider apiKey="<YOUR CLIENT SIDE KEY>">
        <CrossmintEmbeddedCheckout 
          recipient={{ walletAddress: recipientWalletAddress}}
          clientSecret={clientSecret}
          orderId={order.orderId}
          payment={{
            crypto: {
                enabled: true,
            },
            fiat: {
                enabled: true,
            },
            defaultMethod: "fiat",
          }} />
      </CrossmintProvider>
    );
}
The CrossmintEmbeddedCheckout component is highly customizable. You can adjust colors, styling, layout, and behavior to match your brand. Learn more in our UI customization guide.

​
4. Poll for Status Updates

After making the payment via whichever payment method, you'll need to poll the Get Order API to check on the delivery status and present this info to your user. Refer to the complete get order API reference here. GET https://staging.crossmint.com/api/2022-06-09/orders/<orderId>

​
Next Steps

You can now receive payments for anything on the blockchain, and display it in whatever UI you choose to build. Headless checkout is gated in production. To get started, contact us.