Flychain Engineering
Overview
Read-only financial reporting for Flychain partners.
Flychain Reporting API 1.0.0
Section titled “Flychain Reporting API 1.0.0”Read-only access to the books Flychain keeps for the providers in your partner relationship, so your platform can source financial figures directly from us instead of from each provider’s accounting system.
Two levels. A provider is the business as a client of Flychain. A business entity is a legal entity whose books we keep, and reports are produced at that level, because that is the level a set of books exists at. Most providers are a single legal entity; the distinction exists so a figure is never an accidental blend of two. Both identifiers are stable UUIDs for the life of the account.
Scope comes from the key. A partner API key is scoped to your relationship, so no
partner or organization identifier appears in any path. Every endpoint is a GET;
there is nothing in this API that can modify data on our side.
Amounts are integers in cents (USD). We hold monetary values in cents internally to avoid floating-point rounding in financial calculations, and expose them the same way so no precision is lost in transit.
Read the guides alongside this reference. data-semantics in particular carries the
things a schema cannot state: what is_closed means versus is_complete, why
accounting basis is a property of the entity rather than a request parameter, and how
requested ranges are clamped to the date an entity’s books begin.
Authentication
Section titled “Authentication”PartnerApiKey
Section titled “PartnerApiKey”A partner API key, sent as Authorization: Bearer <api_key>.
The key is scoped to your partner relationship: it can read only the providers in that relationship, and a request for anything outside it is rejected. Keys are read-only and there is no OAuth flow, no token refresh and no per-provider consent step.
You issue, rotate and revoke your own keys from your Flychain partner dashboard —
see guides/authentication, which also covers rotating without downtime.
Security scheme type: http