Docs/Public API/OpenAPI

OpenAPI

Import the public Loyfin HTTP surface into Postman or another OpenAPI-compatible tool.

Spec URL#

Use this as the import source for HTTP tooling.

OpenAPIplaintext

https://api.loyfin.com/openapi.json

Local development serves the same document at http://127.0.0.1:8788/openapi.json. The spec inventories public, API-key, and account-authenticated routes, including checkout sessions, balances, webhooks, receipts, issuer aggregates, tokens, transfers, health, and status.

Postman#

In Postman, choose Import, paste the OpenAPI URL, and create a collection.
Set the API URL to production or local depending on your environment.
Use the request examples in Issuances API and Redemptions API for signed payload shape.

Scope#

This is an HTTP contract, not the upcoming SDK. Use it for request discovery, Postman collections, contract tests, and internal tooling. Authentication schemes and core integration payloads are described, but teams should validate any generated client against the concrete request and response examples in these docs.