Versioning and Deprecation Policy
Versioning
- REST APIs
- SDKs
Our REST APIs incorporate version information directly into the URL, facilitating easy tracking and identification of updates (e.g. https://api.paysafe.com/digitalwallets/v1/xxx). Each version change signifies modifications requiring adjustments in existing integrations, ensuring partners are aware of potential compatibility issues.
Our SDKs follow semantic versioning principles. Given a version number MAJOR.MINOR.PATCH, the MAJOR version is incremented for incompatible changes, the MINOR version for backward-compatible functionality additions, and the PATCH version for backward-compatible bug fixes. Major version increments indicate that existing integrations may require updates to work with the newest version.
Managing Changes
- Nonbreaking Changes
- Breaking Changes
We carefully introduce new methods, parameters, error codes, webhooks and values to enhance functionality without disrupting existing integrations.
Changes that may impact existing integrations, such as deletions to the end-points, parameters, error codes, adding new required parameters or security updates requiring code adjustments are communicated transparently to our developer community.
Support and Deprecation Policies
The following deprecation policies is implemented:
- Major Versions (APIs & SDKs)
- Minor Versions (only SDKs)
- Patch Versions (only SDKs)
- Two Major Versions - Concurrent support for two major versions most of the time, allowing users flexibility in upgrading while ensuring support for older versions.
- Frequent Major Versions - If more major versions are released within a short period, support may extend to more than two major versions to provide predictability for partners.
- Single (Latest) Minor Version - Supporting only a single minor version ensures backward compatibility and allows users to upgrade smoothly.
- Single (Latest) Patch Version - Supporting a single patch version and releasing new ones only for bug fixes maintains software stability while addressing important issues promptly.
Status Categories
REST APIs and client SDKs can have one of the following statuses (based only on the MAJOR version):
-
Active- The most current and fully supported version, recommended for all clients. It receives new features, security updates, and bug fixes. -
Inactive- Becomes inactive after a deprecation date, with support provided for one year thereafter to allow partners to upgrade. It receives only security updates and bug fixes. -
Unsupported- A retired version no longer supported by us.