Rainforest is committed to ensuring your integration with our API and Components is reliable and stable while providing new features and capabilities to better enable your platform's payment processing. Some changes are backwards-compatible and will not break your integration. Other changes are backwards-incompatible and will require you to integrate with a new API version. Adding a new API version requires platforms to make changes to upgrade their integration with Rainforest, and therefore, we do our best to add new API versions as sparingly as possible.

API

Backwards-compatible changes

Rainforest considers the following changes to the API to be backwards-compatible:

Adding new endpoints
Adding new, optional, parameters to existing endpoints
Adding new fields to response payloads
Changing the order of fields in response payloads
Adding new webhook event types
Adding new resources*
Adding new statuses to entities*

*New resources (examples of a resource include merchants, payins, and refunds) and statuses can be added to an existing API version if they will not impact your integration and do not require you to make any immediate changes to your integration with Rainforest.

Rainforest reserves the right to make changes that are backwards-compatible without notifying the platform.

Some best practices for ensuring your integration does not break when we make backwards-compatible changes include:

Not requiring specific field order in response or webhook payloads
Using a default handler (possibly with developer-facing notification) upon receiving new fields in response or webhook payloads

Backwards-incompatible changes

Rainforest considers the following changes to be backwards-incompatible and will require a new version:

Removing existing endpoints
Adding required parameters to existing endpoints, or changing existing optional params to required
Removing fields from response or webhook payloads
Updating the field types in response or webhook payloads
Replacing statuses on a resource with new statuses

Changelog

Rainforest provides the following changelogs for updates to the Rainforest integration:

API and component changelog - backwards-compatible API additions and updates to the Rainforest API
Product changelog - product releases to the Rainforest integration

Deprecating API versions

Rainforest will periodically deprecate old API versions. Platforms on these versions will be notified and have at least six months to update to a newer version. After the specified date, Rainforest will disable requests to the deprecated version.

Components

UI and features

Rainforest understands making changes to embedded components could impact the quality or functionality of your integration. As such, any new features will be behind optional component props, which will require you to enable the feature at your discretion. For example, adding the "Dispute" button and modal to the Chargeback Details Component.

Rainforest reserves the right to make UI changes within the components. We will notify the platform before the release of any updates to ensure any support materials and communications are updated accordingly.

Rainforest makes no guarantee about the internal underlying technical implementation (e.g. divs defined, class names, etc.) of components. Any introspection or manipulation is at the platform's risk, and is very strongly discouraged.

API

Some component features will require you to update your API to a newer version, if you are not on the latest version. See the API version upgrades guide to upgrade the API version used in your integration with Rainforest Components.

We highly encourage the use of session permission groups (introduced in version 2023-12-01) so you do not need to make changes to your session keys when new resources and actions are required for new features in the Rainforest Components.

Portal

Rainforest can make minor changes to the Platform Portal without notifying the platform if they will not impact the platform's support or operation teams that utilize the Portal.

Rainforest will notify platforms before the release of any significant changes that may impact the platform's support and operation teams, to ensure any support materials and communications are updated accordingly.