Skip to content

Postman collection

There is no hand-maintained collection file to download, and deliberately so — a static export goes stale. Import the live spec instead and you get a collection that matches the API exactly.

Import

  1. Fetch the spec: 
    GET https://<your-gateway-host>/v1/api/integrations/openapi.json
    It is public; no key needed.
  2. In Postman: Import → Link and paste that URL, or import the saved file.
  3. Postman builds a collection with every endpoint, its parameters and its schemas.

Re-import when you want to pick up changes. The URL is the source of truth.

Set up the environment

Create a Postman environment with two variables:

Variable Value
baseUrl Your gateway host including /v1
apiKey clix_A7bQ2xK_…

Set apiKey as a secret variable so it is not stored in plain text or shared with the collection.

Set up authorisation once

On the collection, set Authorization to:

  • Type: Bearer Token
  • Token: {{apiKey}}

Leave every request as "Inherit auth from parent". That way the key lives in one place and cannot be forgotten on a new request.

Check it works

Send GET {{baseUrl}}/api/usage/current/. A 200 with your plan and invoice counters means the environment, the key and the plan are all correct.

A sensible request order

  1. GET /api/usage/current/ — confirm the key
  2. GET /api/invoices/vat-categories/ — confirm reference data
  3. GET /api/devices/ — confirm a signing device exists
  4. POST /api/invoices/preview/ — check a payload without creating anything
  5. POST /api/invoices/ — create, then poll the location it returns

Two warnings for Postman specifically

Do not use the Runner to retry invoice creation

Identical invoice payloads are rejected for five minutes, and a retry after a timeout can create a duplicate you cannot delete. Poll the location before resending. See Quickstart.

Do not export an environment containing a live key

Postman exports include variable values unless they are marked secret. Share collections, never environments.