Braintree makes regular updates to our server SDKs and follows semantic versioning guidelines with these updates. Whenever we need to make a change that will break existing integrations, we will increase the major version number of the SDK to indicate that your integration will likely need to be updated for it to work with the newest version.
Examples of changes that would require a major version update:
- Adding support for a new server language version released by its core development community
- Dropping support for a server language version that is no longer receiving security updates by its core development community
- Adding support for newer protocols that make server integrations more performant (i.e. HTTP keep-alive, HTTP2)
Server SDKs can have one of the following statuses:
|Status||Description||State of development|
|Active||An active SDK version is the most current and fully supported SDK. It is the recommended version to be used by everyone. Only 1 exists at a time.||This version will receive new features.|
|Inactive||An SDK becomes inactive once assigned a deprecation date. Any number can exist at a time.||No new features will be added, only security updates.|
|Deprecated||Processing will be supported for 1 year after the deprecation date, but you should upgrade immediately to avoid any disruption. Any number can exist at a time.||Deprecated SDKs will not receive updates.|
|Unsupported||A retired SDK version is no longer supported by Braintree developers or Braintree Support. Any number can exist at a time.||Processing for these SDKs can be suspended at any time.|
Here is a visual representation of how server SDK major version statuses can change over time:
The README for each server SDK includes the status and deprecation dates for all major versions, and we will update these statuses as we release new major versions.
We recommend watching the SDK on Github to stay informed about the latest version of the server SDK you're using.
In addition, we may occasionally contact you if there are upcoming changes that require updating your server SDK.
Github repository links: