Integration Quick Start (panel)
In the panel Developers → Quick Start you get an interactive integration guide: REST API operation links, sample requests/responses, and shortcuts to API keys, Webhooks and Checkout sessions. Static full version: Integration Quick Start in docs. Access: Basic+ for Developers; interactive Quick Start in panel - from Enterprise (or ADMIN/OWNER per product config).
Typical integration flow
- 1. API key - create under API keys, store secret, use
Authorization: Bearer. - 2. Offer (qrId) - create in panel or
POST /api/v1/qr. - 3. Customer payment - hosted link (
POST /payments) or checkout session (POST /checkout-sessions/{qrId}) withembedLink. - 4. Webhooks - register URL, verify signature, handle
payment.succeeded,payment.failed,refund.*, subscription events. - 5. Sandbox → Production - separate keys, offers and webhooks; test full cycle before go-live.
What is in panel Quick Start
- Step list with links to REST API operation docs.
- Sample payloads for payments and checkout sessions.
- postMessage info (
CHECKOUT_*) for iframe embed. - Links to Error codes and Stripe when enabled.
Sandbox vs production
Each environment has its own API host, keys and data. The header switch does not copy config - migrate manually. See Environments and Switching environments.
Team members (MEMBER) do not see Developers. Integration is configured by owner or org admin.
Minimal checkout session
POST /api/v1/checkout-sessions/{qrId} with embedLink, optional URLs, lineItems, metadata. Returns sessionId, embedUrl, expiresAt.
Common integration errors
- 401 wrong key/environment.
- 403 Free plan.
- 409 session already COMPLETED.
- CSP embedLink not allowed.