Full OpenAPI Specification
The complete FiscalAPI OpenAPI 3.0 specification, including all endpoints (public, internal, and admin-tagged).
Download
- openapi.yaml — raw YAML spec file
Included endpoint groups
| Group | Description | Public? |
|---|---|---|
| Health | Health check and version | Yes |
| Accounts | Account creation | Yes |
| Locations | Location CRUD and country config | Yes |
| Transactions | Transaction create, list, cancel | Yes |
| Certificates | X.509 certificate management | Yes |
| Webhooks | Webhook subscription management | Yes |
| Retry Queue | Failed transaction retry | Yes |
| Subscriptions | Billing subscription management | Yes |
| Stripe | Stripe billing event processing | No |
| Translations | Error translation service | Yes |
| License | License status and enforcement | No |
| Admin | Batch processing and operations | No |
Viewing the spec
You can view the spec interactively using:
- Swagger Editor — paste the YAML content
- Redocly — point to the hosted URL
- Local tools:
npx @redocly/cli preview-docs openapi.yaml
Source
The spec is maintained at docs/openapi.yaml in the repository. Changes to the spec are reflected here on every deploy.