Overview

Every endpoint is in the sidebar and in search (⌘K). This page groups them by where you are in the journey.

flowchart LR
  A["1 · Authenticate"] --> B["2 · Build
  your catalog"]
  B --> C["3 · Customers
  & orders"]
  C --> D["4 · Collect
  payment"]
  D --> E["5 · Recurring
  & recovery"]

New to the API? Start with the Introduction. Each stage below has a short guide.

1 · Authenticate

Every request uses an API token, sent as a Bearer token, and your profile ID. Customers don't need either.

Guide: 1 · Authenticate

Where to find your API token and profile ID, and how to keep the token safe.

2 · Build your catalog

Guide: 2 · Build your catalog

The order to set up taxes, fees, discounts and products.

Products

Products and their types: single payment, instalment, subscription and metered.

Taxes, discounts & fees

Taxes, discounts and fees you attach to products.

Groups & units

Sort products into groups and set how they're measured.

3 · Create customers & orders

Guide: 3 · Create customers & orders

Create a customer, preview and create an order.

Customers

Customer records, notes and tags.

Orders

Create, preview, update, save as draft and cancel orders.

4 · Collect payment

Guide: 4 · Collect payment

Checkout, payment links and stored cards, then capture or refund.

Payment Links

Checkout, charging or replacing a stored card, and payment links by email, SMS or QR.

Payments

Capture or reverse pre-authorisations, refund payments, and see payment history.

5 · Recurring billing & recovery

Guide: 5 · Recurring billing & recovery

What to do when a scheduled payment is declined or a card expires.

Billing Events and Scheduled Payments

Declined payments, retry, charge now, skip, merge and reschedule.

How customers pay

Customers don't call the API. You send them a payment link by email, SMS or QR, and they pay or update their card on the page it opens. See Payment Links.