Quickstart

Two paths on this page. The hosted path takes five minutes and needs no code. The API path takes about thirty minutes and needs a workspace API key. To put buying and selling on your own website, go to Add the widget instead.

Before you start

A dashboard account at https://dashboard.onstacks.io. Sign-up is self-serve and sandbox is open immediately. Live access opens after business verification.
For the API path, create a sandbox API key under Developer. The full key is shown once.
For webhooks, a publicly reachable HTTPS URL. Localhost is not supported.

export ONSTACKS_API_URL="https://api.onstacks.io"
export ONSTACKS_API_KEY="ostk_live_..."   # sandbox and live keys share the prefix; scope is set by environment

Ramp Checkout (5 minutes)
White-Label API (30 minutes)

Open the Ramp Checkout

Go to https://ramp.onstacks.io. For a sell flow use https://ramp.onstacks.io/?tab=offramp.

Get a quote

Choose a stablecoin and network (for example USDC on Base), pick a local currency (for example NGN), and enter an amount. The rate and fees appear before you continue.

Complete onboarding

Enter an email, confirm the one-time code, then complete identity verification when prompted.

Finish the transaction

Follow the payment or send instructions on the page and watch the status update.

Next: Ramp Checkout for link parameters and the full user flow.

Confirm the service is up

curl "$ONSTACKS_API_URL/readyz"

See what you can offer

curl "$ONSTACKS_API_URL/v1/ramp/routes?environment=sandbox&direction=off_ramp&destination_asset=NGN" \
  -H "Authorization: Bearer $ONSTACKS_API_KEY"

Request a quote

curl -X POST "$ONSTACKS_API_URL/v1/ramp/quote?environment=sandbox" \
  -H "Authorization: Bearer $ONSTACKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "direction": "off_ramp",
    "source_asset": "USDC",
    "source_amount": "1000000",
    "destination_asset": "NGN",
    "country_code": "NG",
    "rail": "bank"
  }'

The response lists one quote per provider with rate, fees, and an expiry. Confirm within two minutes.

Confirm and track

curl -X POST "$ONSTACKS_API_URL/v1/ramp/quote/$QUOTE_REFERENCE?environment=sandbox" \
  -H "Authorization: Bearer $ONSTACKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "destination": { "bank_account": { "account_name": "Mason Emma", "account_number": "0234247896", "bank_code": "058" } }, "idempotency_key": "demo-1" }'

Then read GET /v1/ramp/payments/{reference}?environment=sandbox, or register a webhook. See Status tracking.

Next: White-Label API for the full lifecycle.

Sandbox test data

Item	Value
Test bank	Code `058` (GTBank sandbox)
Test account number	`0234247896`, resolves to a test account holder
Test identity number (Nigeria sandbox BVN)	`22222222222`
Source network	`ethereum_sepolia` with test USDC

See Sandbox testing for how sandbox differs from live.

Welcome

API basics

Ramp

Orchestration

Wallets

Agentic Payments

Before you start

Sandbox test data

​Before you start

​Sandbox test data

Before you start

Sandbox test data