Download the Payclave API schema
The public OpenAPI 3.1.1 JSON document is available at /openapi.json without authentication. Its server URL is https://api.payclave.com, and the API operations use the /v1 prefix. The document includes unique operation IDs, typed input and response schemas, authentication schemes, and typed error responses. It can be imported into API tooling or used to describe tools to an AI agent.
Coverage and compatibility
The specification covers eight core operations: creating and retrieving checkout sessions, creating and retrieving invoices, retrieving payments, creating webhook endpoints, creating test webhook deliveries, and listing webhook deliveries. The complete human-readable HTTP reference also covers invoice actions, payment links, reconciliation, and diagnostics. Use that reference for operations outside the current schema.
Payclave versions breaking API contracts through major URL prefixes. Compatible optional response fields and new error codes can be added within a version. Clients should tolerate these additions, retain request IDs for support, and use the documented idempotency behavior before retrying a mutation.