# Clara API

**Canonical:** https://apis.io/apis/clara-com-mx/clara-com-mx-api/  
**Provider:** Clara — https://apis.io/providers/clara-com-mx/  
**Base URL:** https://public-api.mx.clara.com  
**Documentation:** https://developers.clara.team/v1/webhooks

Clara API is one of 2 APIs that [Clara](https://apis.io/providers/clara-com-mx/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Clara API as documented publicly: 28 operations. Contract generated from the documentation by API Evangelist (2026-10-24); not the provider's own document.

## Operations (28)

| Method | Path | Summary |
|---|---|---|
| GET | `/api-test/v3/transactions` | GET /api-test/v3/transactions |
| POST | `/api-test/v3/webhooks/events` | Submit an event with POST /api-test/v3/webhooks/events (scope write:subscribers , Content-Type: application/json ). |
| POST | `/api-test/v3/webhooks/subscriptions` | Create a sandbox subscription with POST /api-test/v3/webhooks/subscriptions (same body as production ; environment is SANDBOX ). |
| POST | `/api/v1/subscribers` | POST /api/v1/subscribers with an events array |
| GET | `/api/v1/vcn` | Retrieve VCN templates and related identifiers. |
| POST | `/api/v1/vcn/card` | Create a new Virtual Card Number (VCN). |
| PUT | `/api/v1/vcn/card/{id}` | Update an existing VCN. |
| POST | `/api/v1/vcn/card/{id}/cancel` | Cancel a VCN. |
| POST | `/api/v2/cards/{uuid}/configurations` | Create or update card configuration settings. |
| POST | `/api/v2/payments` | Create a boleto payment (Brazil only). |
| GET | `/api/v3/accounts-payable` | List Pix payments with optional filters and sorting. |
| POST | `/api/v3/accounts-payable/pix` | Accounts Payable API v3 — Pix payments (Brazil only) POST /api/v3/accounts-payable/pix creates a Pix payment asynchronously |
| DELETE | `/api/v3/accounts-payable/pix/{externalid}` | Cancel a scheduled Pix payment. |
| GET | `/api/v3/accounts-payable/{externalid}` | GET /api/v3/accounts-payable/{externalId} — poll until PAID, FAILED, or CANCELLED |
| GET | `/api/v3/billing-statements` | Billing Statements API v3 — GET /api/v3/billing-statements |
| GET | `/api/v3/billing-statements/{uuid}/transactions` | Get statement transactions: GET /api/v3/billing-statements/{uuid}/transactions |
| GET | `/api/v3/cards` | Cards API v3 — GET /api/v3/cards |
| POST | `/api/v3/cards` | Cards API v3 — POST /api/v3/cards |
| PATCH | `/api/v3/cards/{uuid}/lock` | Lock/unlock: PATCH /api/v3/cards/{uuid}/lock with body { "lockCode": 16 } |
| GET | `/api/v3/digital-accounts` | Digital Account API v3 — GET /api/v3/digital-accounts (Brazil only) |
| GET | `/api/v3/digital-accounts/balance` | Balance: GET /api/v3/digital-accounts/balance — no parameters; returns checkingAccount.available and collateralAccount.available |
| GET | `/api/v3/transactions` | GET https://public-api.mx.clara.com/api/v3/transactions |
| GET | `/api/v3/transactions/{uuid}/documents` | Get pre‑signed download links for transaction documents. |
| GET | `/api/v3/transactions/{uuid}/extracted-documents` | Retrieve structured fiscal data extracted from transaction documents. |
| GET | `/api/v3/users` | Users API v3 — GET /api/v3/users |
| POST | `/api/v3/webhooks/subscriptions` | POST /api/v3/webhooks/subscriptions with entity + statuses |
| POST | `/api/v3/webhooks/{entity}/resend` | Resend stored webhook events for a given entity. |
| POST | `/oauth/token` | Token endpoint: POST /oauth/token with Authorization: Basic base64(CLIENT_ID:CLIENT_SECRET) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/clara-com-mx/openapi/_ae-authored/clara-com-mx-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/clara-com-mx/json-schema/clara-com-mx-post-api-v2-cards-uuid-configurations-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/clara-com-mx/json-schema/clara-com-mx-post-api-test-v3-webhooks-events-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/clara-com-mx/json-schema/clara-com-mx-post-api-test-v3-webhooks-events-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/clara-com-mx/json-schema/clara-com-mx-post-api-v3-cards-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/clara-com-mx/json-schema/clara-com-mx-post-api-test-v3-webhooks-subscriptions-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/clara-com-mx/json-schema/clara-com-mx-post-api-v1-vcn-card-request-schema.json

## Other Clara APIs (1)

- [Clara API](https://apis.io/apis/clara-com-mx/clara-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/clara-com-mx/clara-com-mx-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/clara-com-mx/.