API versioning

The current API version is 2026-10-18. Every /v1 response includes it:

TeePay-Version: 2026-10-18

You may send the same header on requests to pin the version you built against. If you send a version the API does not support, the request is rejected before anything happens:

{
  "error": {
    "code": "unsupported_api_version",
    "message": "This API version is not supported. Use the version listed in TeePay-Version.",
    "request_id": "6f1c0a2b9d3e4f51"
  }
}

CompatibilityCopy Anchor Link

Within a version TeePay may add endpoints, optional request fields, response fields and new enum values. Make your parser tolerate unknown fields and unknown enum values. Removing a field or changing its meaning requires a new version and is announced in the changelog.