API documentation
Two API versions, side by side
Which version
API v1
The current production API. Form-encoded, EPRO-style endpoints under /v1.
API v2
JSON, snake_case, idempotency keys, hosted fields and payment links under /v2.
v1 is what integrations run on today. It stays supported.
v2 is the current design: one JSON contract, X-Api-Key authentication,
Idempotency-Key on every mutation, a hosted-fields SDK for SAQ A-EP
integrations and a hosted page for SAQ A.
Starting fresh? Use v2. Already on v1? See the migration guide.
Not an API
Environments — Live and Sandbox behind one login: what each routes to, the test cards, and how to test before going live. Applies to both versions, and to merchants with no integration at all.
No integration at all? A payment link takes a payment with one API call — or one click in the dashboard.