Skip to main content

​
API Reference Overview

The BLIPS API Reference is generated from a single public OpenAPI 3.1 document and then organized into business families inside docs.json.

​
Current API families

  • Platform Setup / Credentials
  • Customers
  • Accounts
  • Same-Currency Transfers
  • Cross-Currency Transfers
  • Transactions

​
Why this structure

This navigation mirrors the public integration flow more closely than a flat endpoint dump:
  1. establish platform configuration
  2. manage credentials and support verification
  3. create and manage customers
  4. attach accounts
  5. run same-currency or cross-currency flows
  6. inspect and act on transaction outcomes
Only the approved first-release endpoints appear in the primary navigation. That means this first public surface intentionally excludes adjunct or retained reference-only routes that are not part of the approved launch set.

​
Source of truth

Every generated endpoint page in this section comes from: 
openapi/blips-public-reference.yaml
That means changes to summaries, descriptions, schemas, examples, servers, auth, and webhook definitions should happen in OpenAPI first.