OpenAPI
Flint Pay publishes the public /v1 HTTP API schema at /v1/openapi.json.
GET
/v1/openapi.jsonRetrieve the OpenAPI 3.0.3 specification for the public /v1 HTTP API.
What It Includes#
- Every documented
/v1path - Request and response schemas
- Error envelope schemas
- Auth and idempotency header definitions
- Enum values and pagination parameters
Auth#
GET /v1/openapi.json does not require an API key.
Download The Spec#
Bash
curl -s https://api.withflintpay.com/v1/openapi.json
Common Uses#
- SDK and client generation
- Contract inspection in CI
- Agent tooling that prefers structured API schemas over prose
- Comparing deployed
/v1behavior with your integration assumptions
The OpenAPI document is the best machine-readable view of the public REST surface. For workflow guidance and integration patterns, use the guides alongside it.
