On this page

Versioning & Changelog

Make upgrades predictable.

Review the API contract and release notes together before changing a client.

Versioned API

The current API namespace is /v1. Use the published OpenAPI document for supported operations and validation rules.

Release changes

Before updating your client, review changes to endpoints, required fields and permissions. Run your integration tests against the new version.

Plan your migration

Agree the supported version and migration schedule with the team before activating a production integration.

Use test credentials and data during development. Request production access after integration review; financial integrations also need provider approval.

Review the current API