Everything you need to integrate the platform — from your first request to production webhooks.
Introduction
The API is organised around REST. It has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Base URLAll requests are made to
https://api.example.com/v1 over HTTPS. Calls made over plain HTTP will fail.Authentication
Authenticate with an API key in the Authorization header. Keep your keys secret —
do not embed them in client-side code or public repositories.
curl https://api.example.com/v1/charges \
-H "Authorization: Bearer sk_live_…"Keep keys server-sideA leaked secret key gives full account access. Rotate immediately if exposed.
Errors
The API uses conventional HTTP status codes. Codes in the 2xx range indicate success,
4xx indicate a client error, and 5xx indicate a server error.