Skip to main content
The reference documents every endpoint on both surfaces, generated from the OpenAPI 3.1 specification. Each page shows request and response schemas, per-field documentation, generated code examples, and an interactive playground.

Base URLs

Authentication

Send your API key on every request:
Each endpoint requires a key scope — the required scope is noted on the endpoint page. In the playground, paste your key into the X-API-Key field.

How the reference is organized

  • B2B groups (/b2b/*) — prepaid ordering: orders, products, balance and account, deposits, refunds.
  • Retailer groups (/retailer/v1/*) — reseller checkouts: catalog, checkouts and payments, refunds, webhook management, account.
  • Webhook payloads — the messages Wizzgift sends to your server, documented from the spec’s webhooks section.

Conventions in the schemas

  • Timestamps are epoch milliseconds (UTC).
  • Nullable fields are typed as string | null (and similar) in the schemas.
  • 404 is returned both for unknown ids and for resources owned by another account.
  • The 429 rate-limit response uses a flat body, not the standard error envelope — see errors.