Skip to main content

Versioning

The Merchant API is versioned in the URL path. The current version is v1, and every endpoint lives under it:

https://api.sandbox.upprove.com/v1/checkout/sessions

Compatibility​

Within v1, Orchestr aims to make only backward-compatible changes. Treat the following as expected and build your integration to tolerate them:

  • New fields added to responses and webhook payloads.
  • New event types and new enum values.
  • New optional request fields.

To stay compatible:

  • Ignore unknown fields rather than rejecting them.
  • Tolerate unknown enum values (e.g. a new transaction status) without crashing.
  • Do not depend on the ordering of object keys, or on human-readable message text.

Breaking changes would be introduced under a new version path (e.g. v2), not by mutating v1.

note

The signing scheme uses a v1= label inside the X-Signature header. That version is independent of the API path version — it identifies the signature scheme, not the API.