These docs are for v2023-01-01. Click to read the latest docs for v2024-10-16.
deprecated

Deprecating API versions 2023-01-01 and 2023-12-01

Rainforest will be fully depcrating API versions 2023-01-01 and 2023-12-01 on November 12th, 2025. After this date, requests to these versions will no longer be supported.

You should have received emails from Support and communications from your Platform Success Manager if you are currently on API version 2023-01-01 or 2023-12-01.

New version benefits

Upgrading to API version 2024-10-16 offers enhancements to improve your integration’s performance, including:

  • Expanded statuses for chargebacks for more granular tracking and response handling
  • New chargeback status webhooks
  • New billable merchant ID field that enables fee pass-through for products such as Card Account Updater
  • Additional payin statuses to better represent ACH returns and authorizations

Before you update

Before upgrading your minimum API version, you should update your code to integrate to the latest API version to ensure any backwards-incompatible changes will not break your integration.

Your platform is on 2023-01-01

If your platform is on 2023-01-01, then you'll need to see 2023-12-01 and 2024-10-16 for all breaking changes you'll need to make to support the latest version.

Your platform is on 2023-12-01

If your platform is on 2023-12-01, then you'll need to see 2024-10-16 for all breaking changes you'll need to make to support the latest version.

Upgrade sandbox

We recommend updating your sandbox environment first to test your integration against the new version before making any changes in production. Submit a request to [email protected] to have your platform's minimum API version upgraded on Sandbox.

Upgrade production

Once your sandbox environment has been upgraded and all functionality in your integration is confirmed working, then submit a request to [email protected] to have your platform's minimum API version upgraded on Production.

📘

Upgrade before November 12, 2025

Your platform's minimum API version must be upgraded before November 12, 2025.