Versioning and changelog

Current version

The current contract is version 1.0.0 and uses OpenAPI 3.1. Routes live below an environment-specific LuxPay prefix. Do not build a client that assumes the prefix is absent or that the placeholder host in the file is a real environment.

Compatible changes

Adding an optional field, a new endpoint, or non-required response data is usually compatible, but clients should ignore fields they do not understand. Avoid strict JSON matching that rejects every new property.

Breaking changes

Removing a field, changing its type, making an optional field required, changing state meaning, or moving an idempotency key is breaking. Such changes require a major version or a documented deprecation period. Financial behavior must not change silently under the same contract version.

Drift monitoring

This repository validates operation IDs, routes, schemas, and references. When LuxApi changes, update OpenAPI, guidance, and tests in the same or a linked pull request. Never declare the developer portal green while the runtime contract differs.

Client policy

Pin the major version your integration supports and use operationId in telemetry rather than only raw URLs. Monitor the changelog, validate in sandbox before production promotion, and retain rollback capability for client libraries and provider configuration.