Authentication
Authentication
Clearway merchant APIs authenticate with API keys prefixed with clwy_.
Headers
Send your key using either:
Authorization: Bearer {docsEnv.keyPrefixExample}(recommended)x-clearway-api-key: {docsEnv.keyPrefixExample}
Use Sandbox or test keys for integrations against this environment. Live keys (clwy_live_…) move real money on write operations.
Security: Use sandbox or test keys only in the browser API Reference playground. Live keys belong in server-side integrations only.
API base URL
All new merchant integrations use POST calls to the Clearway HTTP API gateway:
Code
Each path segment is the operation name (for example CREATE_PAYMENT_LINK, LIST_ORDERS).
Do not call legacy gcf-* hosts for new integrations — use api-* only. See Dashboard vs API.
Scopes
Each key carries scopes (for example read:orders, create:payment_link). The API returns 403 FORBIDDEN when the key lacks the required scope.
Create, scope, and rotate keys in the dashboard under Developer → API → Keys at https://app-dev.clearway.to/developer/api/keys.
For sandbox vs live keys, scope templates, and origin allowlists, see API keys and scopes.
Next steps
- Getting started — first API call
- API keys and scopes
- API Reference