Spec Files
Three OpenAPI 3.0.3 files define the complete OpenWave standard. All are machine-readable and compatible with any OpenAPI tooling.
openwave-payments-v1.yaml
Covers: Payment sessions, recurring mandates, NPT alias management, webhooks
bash
# Load in Swagger UI
curl https://raw.githubusercontent.com/Tellesy/openwave-spec/main/openwave-payments-v1.yaml
# Import to Postman
# File → Import → Link → paste URL aboveopenwave-open-banking-v1.0.yaml
Covers: OAuth 2.0 + PKCE consent flow, AISP (accounts, balances, transactions), PISP (payment initiation), SCA, bank capabilities
openwave-identity-v1.0.yaml
Covers: NPT handle ownership, multi-bank account linking, public alias resolution, bank phonebook, governance endpoints
Using the Specs
Swagger UI
html
<SwaggerUI url="https://raw.githubusercontent.com/Tellesy/openwave-spec/main/openwave-payments-v1.yaml" />Swagger Editor
Visit editor.swagger.io and paste the raw URL via File → Import URL.
Postman
- Open Postman
- Click Import
- Paste the raw YAML URL
- Postman generates a full collection with all endpoints
Code Generation (openapi-generator)
bash
# Generate a TypeScript SDK
npx @openapitools/openapi-generator-cli generate \
-i https://raw.githubusercontent.com/Tellesy/openwave-spec/main/openwave-payments-v1.yaml \
-g typescript-fetch \
-o ./generated-client
# Generate a Python client
npx @openapitools/openapi-generator-cli generate \
-i openwave-payments-v1.yaml \
-g python \
-o ./openwave-pythonVersioning
OpenWave follows Semantic Versioning:
| Change | Version bump |
|---|---|
| Breaking change to existing endpoint | MAJOR (1.x → 2.0) |
| New endpoint or optional field | MINOR (1.0 → 1.1) |
| Clarification, fix, example update | PATCH (1.0.0 → 1.0.1) |
The api_version field in webhook envelopes and the info.version in each spec always reflect the module version.
All changes are documented in CHANGELOG.md.