OpenAPI Specification

The Prahsys Payments API is fully documented using the OpenAPI 3.0 specification, providing you with a comprehensive and machine-readable description of our API endpoints, request parameters, response objects, and authentication methods.

Direct Access

You can access our OpenAPI specification directly at:

https://api.prahsys.com/payments/openapi.json

This endpoint always provides the latest version of our API specification.

Benefits of OpenAPI

The OpenAPI specification offers several advantages for developers:

Interactive Documentation: Use tools like Swagger UI or ReDoc to create interactive documentation from the spec
Code Generation: Generate client libraries in multiple programming languages
Automated Testing: Create automated API tests based on the specification
Request Validation: Validate API requests against the schema definitions

Using with API Development Tools

Many popular API development tools support importing OpenAPI specifications:

Postman : Import the specification to create a collection of requests (also see our dedicated Postman collection)
Insomnia : Import the specification to create request templates
VS Code : Use extensions like “OpenAPI (Swagger) Editor” for enhanced editing capabilities

Versioning

The OpenAPI specification follows our API versioning strategy. The specification at the URL above always reflects the latest version of our API.

For more information about our API versioning approach, see the API Versioning Guide.

Additional Resources