Downloads

All OpenWave spec files are OpenAPI 3.0.3 and fully machine-readable. Import them into any compatible tool in seconds.

OpenAPI Spec Files

Payments API — `openwave-payments-v1.yaml`

Covers payment sessions, NPT alias routing, recurring mandates, webhooks, and bank partner callbacks.

Download YAML View on GitHub Open in Swagger Editor ↗

Key endpoints:

Method	Path	Description
`POST`	`/payments/initiate`	Create a payment session
`GET`	`/payments/{id}/status`	Poll payment status
`POST`	`/session/{id}/resolve-payer`	Resolve payer alias or IBAN
`POST`	`/session/{id}/confirm-otp`	Confirm OTP auth
`POST`	`/aliases/register`	Register an NPT alias
`GET`	`/aliases/{alias}`	Look up an alias
`POST`	`/mandates/create`	Create recurring mandate
`POST`	`/bank/callback/execute-transaction`	Bank executes unified debit+route
`POST`	`/bank/callback/notify-credit`	Bank confirms credit to merchant

Open Banking API — `openwave-open-banking-v1.0.yaml`

Covers OAuth 2.0 + PKCE consent, AISP (account data), PISP (payment initiation), and SCA.

Download YAML View on GitHub Open in Swagger Editor ↗

Key endpoints:

Method	Path	Description
`POST`	`/ob/consent`	Create an account access consent
`GET`	`/ob/accounts`	List customer accounts (AISP)
`GET`	`/ob/accounts/{id}/balances`	Get account balances
`GET`	`/ob/accounts/{id}/transactions`	Get transaction history
`POST`	`/ob/payment-orders`	Initiate a PISP payment
`GET`	`/ob/payment-orders/{id}`	Poll payment order status

Identity Registry API — `openwave-identity-v1.0.yaml`

Covers NPT handle ownership, multi-bank account linking, public alias resolution, and bank directory.

Download YAML View on GitHub Open in Swagger Editor ↗

Key endpoints:

Method	Path	Description
`POST`	`/identity/handles`	Register an NPT handle
`GET`	`/identity/resolve/{alias}`	Resolve alias → IBAN + bank
`GET`	`/identity/banks`	List all registered banks
`POST`	`/identity/banks/{handle}/accounts`	Link an account to a handle
`DELETE`	`/identity/handles/{alias}`	Deactivate a handle

Gateway Interconnect API — `openwave-gateway-interconnect-v1.yaml`

Covers gateway discovery, remote alias resolution, cross-gateway routing, health checks, settlement batches, and gateway-to-gateway authentication.

Download YAML View on GitHub Open in Swagger Editor ↗

Key endpoints:

Method	Path	Description
`GET`	`/gateway-info`	Read gateway capabilities, banks, rails, regions, and fees
`POST`	`/gateway-register`	Register or update gateway metadata
`GET`	`/gateway-health`	Check peer gateway health and degraded modes
`POST`	`/resolve-alias-remote`	Resolve an alias through a remote gateway
`POST`	`/route-payment`	Route a cross-gateway payment
`POST`	`/route-status`	Read cross-gateway route status
`POST`	`/settlement-batch`	Submit settlement batch details
`GET`	`/settlement-status`	Read settlement batch state

Postman Collections

Import any spec file directly into Postman to get a pre-built collection with all endpoints, example payloads, and environment variables.

Method 1 — Import by URL (recommended)

Open Postman
Click Import → Link
Paste one of these raw URLs:

# Payments
https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml

# Open Banking
https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-open-banking-v1.0.yaml

# Identity Registry
https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-identity-v1.0.yaml

# Gateway Interconnect
https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-gateway-interconnect-v1.yaml

Postman generates the full collection automatically. Set your environment variables:

GATEWAY_URL    = https://your-gateway.example.com
MERCHANT_KEY   = your-merchant-api-key
BANK_KEY       = your-bank-api-key
ADMIN_KEY      = your-admin-api-key
GATEWAY_KEY    = your-peer-gateway-key

Method 2 — Download YAML then import as file

Download the YAML above → in Postman click Import → File → select the downloaded file.

Variable	Used by	Example
`GATEWAY_URL`	Payments, Open Banking	`https://sandbox.gateway.example.com`
`IDENTITY_URL`	Identity Registry	`https://identity.example.com`
`MERCHANT_KEY`	Merchant payment APIs	`mk_test_...`
`BANK_KEY`	Bank-to-registry APIs	`owbk_...`
`INTERNAL_KEY`	Gateway-to-bank callbacks	`ow_cbk_...`
`GATEWAY_KEY`	Gateway interconnect	`owgw_...`
`WEBHOOK_SECRET`	Signature verification tests	`whsec_...`

Swagger / OpenAPI Tools

Swagger UI (online)

Click any "Open in Swagger Editor" button above, or paste a raw URL into editor.swagger.io.

Run Swagger UI locally

bash

docker run -p 8080:8080 \
  -e SWAGGER_JSON_URL=https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml \
  swaggerapi/swagger-ui

Open http://localhost:8080 — full interactive docs with live try-it-out (point it at your gateway).

Redocly

bash

npx @redocly/cli preview-docs openwave-payments-v1.yaml

Insomnia

Use Create → Import from URL and paste any raw OpenAPI URL from this page. Create separate environments for sandbox and production so merchant, bank, and gateway credentials do not mix.

Hoppscotch

Use Collections → Import → OpenAPI for quick browser-based exploration. Keep production credentials out of shared browser sessions.

Stoplight Elements

Teams that want an internal branded API portal can render the same YAML files with Stoplight Elements or any OpenAPI 3.0 compatible documentation renderer.

Code Generation

Generate a type-safe client in any language using openapi-generator:

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml \
  -g typescript-fetch \
  -o ./openwave-client-ts

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml \
  -g typescript-axios \
  -o ./openwave-client-ts-axios

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml \
  -g kotlin \
  -o ./openwave-client-kotlin

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml \
  -g python \
  -o ./openwave-client-python

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml \
  -g go \
  -o ./openwave-client-go

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml \
  -g java \
  -o ./openwave-client-java

bash

npx @openapitools/openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml \
  -g csharp \
  -o ./openwave-client-dotnet

TypeScript schema-first clients

For frontend and backend teams that prefer lightweight generated types:

bash

npx openapi-typescript \
  https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml \
  -o ./src/openwave-payments.d.ts

For typed fetch clients:

bash

npx openapi-fetch \
  https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-payments-v1.yaml \
  -o ./src/openwave-payments-client.ts

Microsoft Kiota

Kiota can generate clients for .NET, Java, Go, PHP, Python, Ruby, and TypeScript:

bash

kiota generate \
  --openapi https://raw.githubusercontent.com/neptune-ly/openwave-spec/main/openwave-open-banking-v1.0.yaml \
  --language typescript \
  --output ./openwave-ob-kiota

Native SDKs

OpenWave-compatible gateway operators may publish hand-crafted SDKs for their own products. For the standard itself, generated clients from the OpenAPI files remain the portable baseline.

Direct GitHub Access

Clone the full spec repository for offline use or CI/CD validation:

bash

git clone https://github.com/neptune-ly/openwave-spec.git
cd openwave-spec

# Validate specs with Redocly CLI
npx @redocly/cli lint openwave-payments-v1.yaml
npx @redocly/cli lint openwave-open-banking-v1.0.yaml
npx @redocly/cli lint openwave-identity-v1.0.yaml
npx @redocly/cli lint openwave-gateway-interconnect-v1.yaml

Versioning

OpenWave follows Semantic Versioning:

Change	Version bump
Breaking change to an existing endpoint	`MAJOR` (1.x → 2.0)
New endpoint or optional field	`MINOR` (1.0 → 1.1)
Clarification, fix, or example update	`PATCH` (1.0.0 → 1.0.1)

The api_version field in every webhook envelope and the info.version in each spec always reflect the current module version. All changes are logged in CHANGELOG.md.

Downloads ​

OpenAPI Spec Files ​

Payments API — openwave-payments-v1.yaml ​

Open Banking API — openwave-open-banking-v1.0.yaml ​

Identity Registry API — openwave-identity-v1.0.yaml ​

Gateway Interconnect API — openwave-gateway-interconnect-v1.yaml ​

Postman Collections ​

Method 1 — Import by URL (recommended) ​

Method 2 — Download YAML then import as file ​

Suggested Postman environments ​

Swagger / OpenAPI Tools ​

Swagger UI (online) ​

Run Swagger UI locally ​

Redocly ​

Insomnia ​

Hoppscotch ​

Stoplight Elements ​

Code Generation ​

TypeScript schema-first clients ​

Microsoft Kiota ​

Direct GitHub Access ​

Versioning ​

Downloads

OpenAPI Spec Files

Payments API — `openwave-payments-v1.yaml`

Open Banking API — `openwave-open-banking-v1.0.yaml`

Identity Registry API — `openwave-identity-v1.0.yaml`

Gateway Interconnect API — `openwave-gateway-interconnect-v1.yaml`

Postman Collections

Method 1 — Import by URL (recommended)

Method 2 — Download YAML then import as file

Suggested Postman environments

Swagger / OpenAPI Tools

Swagger UI (online)

Run Swagger UI locally

Redocly

Insomnia

Hoppscotch

Stoplight Elements

Code Generation

TypeScript schema-first clients

Microsoft Kiota

Direct GitHub Access

Versioning