Copy page

Guides

Getting started

Getting started

This guide walks through your first server-to-server merchant API integration on {docsEnv.apiBaseUrl}.

Before you begin

1. Sign in to the Clearway dashboard at https://app-dev.clearway.to.
2. Complete onboarding until charges are enabled (Express path is fastest on dev).
3. Verify your email — monetization features stay locked until verified.

Create a sandbox API key

1. Open Developer → API → Keys at https://app-dev.clearway.to/developer/api/keys.
2. Create a Backend integration or General key.
3. Copy the plain key once — it is shown only at creation. Store it in your server secrets manager.

Use Sandbox or test keys ({docsEnv.keyPrefixExample}) in this environment.

Make your first call

List products is a safe, read-only wired operation:

Code
curl -s -X POST "{docsEnv.apiBaseUrl}/LIST_PRODUCTS" \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit": 5}'

Replace YOUR_KEY with your sandbox key. A successful response includes "success": true and a products array.

If you receive 403 FORBIDDEN with a dashboard-only message, you may have called an operation marked x-clearway-status: dashboard-only in the API Reference. See Dashboard vs API.

Interactive API Reference

Open API Reference to explore request bodies and try calls in the playground.

Important: The playground runs in your browser. Use sandbox or test keys only — never live keys (clwy_live_…) in the playground.

The dashboard API Sandbox (Arena) is a separate session-backed testing surface — not the same as calling {docsEnv.apiBaseUrl} directly.

Environment

This site documents the {docsEnv.deployTarget} integration target. Examples use {docsEnv.apiHost}, {docsEnv.dashboardUrl}, and {docsEnv.paySiteUrl} with Sandbox or test keys ({docsEnv.keyPrefixExample}).

Production documentation will be published at docs.clearway.to when available.

API key rate limits are per operation (60 requests / 60 seconds) — see Rate limits.

Next steps

• Authentication — headers and URL format
• API keys and scopes — rotation and allowlists
• Idempotency — before money-moving calls
• API Reference — all wired operations