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"] E --> F["6 · Going live"]
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.
2 · Build your catalog
The order to set up taxes, fees, discounts and products.
Products and their types: single payment, instalment, subscription and metered.
Taxes, discounts and fees you attach to products.
Sort products into groups and set how they're measured.
3 · Create customers & orders
4 · Collect payment
Checkout, payment links and stored cards, then capture or refund.
Take the payment in a form on your own website.
Send a payment link by email or SMS, or show it as a QR code.
Charge a saved card, or move the order to another saved card.
Capture or reverse pre-authorisations, refund payments, and see payment history.
5 · Recurring billing & recovery
6 · Going live
How customers pay
Customers don't call the API. You send them a payment link by email, SMS or QR, and they pay on the page it opens. See Payment Links.