Documentation

Everything needed to route a real order

Guides for the people installing the plugins, and a complete reference for the people writing against the API and the shop-to-shop protocol. If something here is wrong or missing, tell us and we will fix the page.

Start here API reference Test cards

Start here

Getting started

From an empty account to a routed test order in about twenty minutes.

Read →

How routing works

Rules, candidates, availability, caps, strategies and the decision trace.

Read →

Consent and shop terms

What the customer must agree to, and what evidence is kept.

Read →

Store plugins

WooCommerce plugin

Install, connect, seller setup, charger setup, Stripe keys, testing.

Read →

Magento 2 module

Install, enable, configure, connect and test on Magento 2.4.x.

Read →

Shopify app

Offsite payments app — status, scope and current workaround.

Read →

Reference

API reference

Every endpoint of the v1 API, its body and its response.

Read →

Protocol v1

Keys, grants, signatures, charger endpoints, embed and pay pages.

Read →

Test cards

Deterministic card numbers and amounts for every outcome.

Read →

Help

Frequently asked questions

The questions merchants ask before they connect a second shop.

Read →

Changelog

What changed in the platform, the protocol and the plugins.

Read →

Can't find it?

The specification documents behind these pages — architecture, protocol, API, data model and the plugin specs — are the source these docs are written from. Ask us for anything that is not covered yet and we will publish it rather than answer once in an email.

Ask a question