Onramp Quickstart

All Quickstarts | Onramp Docs

Introduction

Create and fund a crypto wallet using Crossmint Onramp. This quickstart walks through creating an order, completing KYC (Persona) when required, collecting payment via Checkout.com Flow, and tracking delivery to the recipient wallet.

Learn how to:

• Create an onramp order
• Handle KYC via Persona when required
• Collect payment with Checkout.com Web Components (Flow)
• Track delivery status and show the resulting transaction id

Deploy

Easily deploy the template to Vercel with the button below. You will need to set the required environment variables in the Vercel dashboard.

Setup

1. Clone the repository and navigate to the project folder:

git clone https://github.com/crossmint/onramp-quickstart.git && cd onramp-quickstart

2. Install all dependencies:

npm install
# or
yarn install
# or
pnpm install
# or
bun install

3. Set up the environment variables:

cp .env.template .env

4. Get a Crossmint server API key from here and add it to the .env file. Ensure it has the scopes: orders.read and orders.create. The following variables are used by the API routes in this project:

CROSSMINT_SERVER_SIDE_API_KEY=your_server_api_key

# staging | production
CROSSMINT_ENV=staging

5. Run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev

Using in production

1. Create a production server-side API key key and set CROSSMINT_ENV=production.