> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bouclay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> Every endpoint, field and response in the Bouclay API

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.

```text theme={null}
https://bouclay.com/api/v1
```

## The basics

> [card] [Authentication](https://docs.bouclay.com/integrate/authentication.md)
>
> Secret keys, restricted keys and scopes.

> [card] [Making requests](https://docs.bouclay.com/integrate/requests.md)
>
> Idempotency keys, pagination, money in major units, rate limits.

> [card] [Errors](https://docs.bouclay.com/integrate/errors.md)
>
> The error shape, the codes, and which ones to retry.

> [card] [Webhooks](https://docs.bouclay.com/integrate/webhooks.md)
>
> 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](mailto:hello@bouclay.com) to have one turned on.

## Download the contract

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.