HNN Biller. APIs

Composite OpenAPI 3.0 specifications — one per feature group. Import into Postman, Insomnia, Swagger UI, or generate a client.

How to use these

Pick only the groups you need — each spec stands alone. Every client runs on an edition: non_commercial covers billing, payer routing and patient payments; commercial adds the revenue engine, financing, the NHIS ClaimIt tracker, agnostic payer tabs and the audit ledger. Commercial-only endpoints return 402 upgrade_required otherwise. Check your own entitlement with GET /api/v1/bills/edition; move a client between editions with the Master Control API.

Authentication at a glance

HeaderWhoScope
x-api-keyClinic / hospital (EMR)Their own bills, payments, claims
x-payer-keyInsurer / corporate payerClaims addressed to them
x-console-keyIT leadTheir own organisation only
x-platform-keySaaS ownerWhole deployment

Send Idempotency-Key on authorise and financing calls so a retry never double-executes.