Skip to main content
The Bouclay API is a JSON API over HTTPS. Every page in this section is generated from the API’s OpenAPI contract, so it is always in step with what the API accepts.

​
The basics

Authentication

Secret keys, restricted keys and scopes.

Making requests

Idempotency keys, pagination, money in major units, rate limits.

Errors

The error shape, the codes, and which ones to retry.

Webhooks

Verifying signatures and the full event list.

​
Try it in the browser

Each endpoint page has a playground. Paste a test key (sk_test_…) into the authorization field and send real requests. Never paste a live key into a web page.

​
Early access

Endpoints and fields marked Early access are documented ahead of their release, so you can build against them now. Until a feature is turned on for your account, its endpoints answer 404 not_found and its fields are refused with a 422. Write to hello@bouclay.com to have one turned on.

​
Download the contract

The OpenAPI file is public at bouclay.com/docs/api/openapi.yaml. Use it to generate a client, or import it into Postman or Insomnia.