Where can I find the API documentation?

The NextPay API documentation is available in two forms:

Interactive API reference: Visit the Developer Documentation section of this site for comprehensive API guides, authentication setup, and endpoint reference.

OpenAPI specification: The machine-readable OpenAPI spec is available at:

• Development: https://unique-hare-768.convex.site/openapi/v1
• Production: https://bright-greyhound-311.convex.site/openapi/v1

Interactive explorer: You can test API endpoints directly in your browser using the Scalar UI:

• Development: https://unique-hare-768.convex.site/reference/v1
• Production: https://bright-greyhound-311.convex.site/reference/v1

The API uses standard REST conventions with JSON request and response bodies. Authentication is via API key passed in the Authorization header as a Bearer token.

If you prefer working from the command line, the NextPay CLI provides the same capabilities with a simpler interface. The CLI is especially useful for scripting and AI agent integrations.