2024-10-16
How to upgrade to the Rainforest API version 2024-10-16
The following changelog will explain the backwards-incompatible changes you'll need to make to your integration with the Rainforest API before upgrading to the 2024-10-16 version.
See the guide for API version upgrades on how to upgrade to this version.
Changelog
- [MAJOR] The chargeback status
PENDING
has been replaced with the following statuses. For more information, see the guides for understanding chargebacks.INQUIRY_ACTION_REQUIRED
INQUIRY_RESPONDED
DISPUTE_ACTION_REQUIRED
CHARGEBACK_PROCESSING
PREARBITRATION_PROCESSING
ARBITRATION
PROVISIONAL_WIN
- [MAJOR] In create payment method config endpoint, a new field
billable_merchant_id
is required.- Setting a billable merchant ID on each payment method will allow the platform to pass on the fees for running processes such as Card Account Updater.
- New payin statuses:
- [MAJOR]
RETURNED
for when ACH payins are returned before being available for deposits. For more information, see the guides for understanding ACH returns. AUTHORIZED
for visibility on authorization prior to processing.
- [MAJOR]
- The following endpoints on API keys have been updated from
PUT
toPOST
:- Enable API key endpoint
- Disable API key endpoint
- The deprecated field
level_2_3.mcc_code
has been removed from the payin config resource. The fieldlevel_2_3.commodity_code
should be used instead. - The deprecated field
supported_capabilities
has been removed from the following:- Payin config resource
- Payment method config resource
- The deprecated field
result_code
has been removed from the following resource and endpoints. The fieldrefusal_code
should be used instead.- Payin resource
- Void or refund payin endpoint
- List payments endpoint
- The deprecated params
start_time
andend_time
have been removed from the following endpoints. The fieldscreated_at.start
andcreated_at.end
should be used instead.- List payins endpoint
- List payments endpoint
- The deprecated params
created_at_start
,created_at_end
,updated_at_start
, andupdated_at_end
have been removed from the following endpoints. The fieldscreated_at.start
,created_at.end
,updated_at.start
, andupdated_at.end
should be used instead.- List merchants endpoint
- List merchant applications endpoint
- The undocumented field
rainforest_internal_state
has been removed from the following resources:- Merchant resource
- Merchant application resource
- The undocumented fields
merchant_application_state
andmerchant_state
have been removed from the create merchant endpoint.
Updated about 1 month ago