The Unified Payments API release notes contain minor updates to the current version. These notes detail what’s been added, changed, and removed regarding our products and features. 

The API version that you first integrate with determines how you interact with the REST API—for example, the format of the data you’re sending and how the information is returned to you. We constantly maintain and update the API and, in some cases, breaking changes may be made. To prevent any interruptions to your existing integration, new API versions will be introduced. 

We’ve categorized API changes as breaking (ones that will require a new version) and backwards compatible. Below, you’ll find our definitions for these categories.

Any new versions or updates to existing versions will contain a release notes entry to inform you of the changes and additions.

Breaking changes [MAJOR]

Breaking changes involve changes that can break an existing integration, such as modifying or removing certain parts of the API. Examples include:

• Adding new mandatory request fields
• Removing a resource
• Changing an action associated with an existing resource
• Removing an existing request field
• Removing an existing response field

Backwards-compatible changes [MINOR]

Backwards-compatible changes involve additions to the API that do not affect existing integrations, such as adding new optional fields or resources. Examples include:

• Adding a resource 
• Adding a new action
• Adding a new response field
• Adding a new optional query parameter
• Adding a new optional request field
• Adding a new optional Enum value to an existing field
• Certain fields in the API that return data directly from a third-party system

REST API release notes

The REST API release notes contain both major and minor updates to the API. When a new version of the API is released, the heading “API Version” will contain a prefix of [MAJOR].