API and component changelog

The following changelog lists all changes to the Rainforest API and Components, in chronological order, on all supported API versions. For product releases see the product changelog.

October 27, 2025

• Added new endpoint Create payin from deposit method. For more information, see the changelog for process payins from deposit methods.

October 14, 2025

• Added new field merchant_id to create payment method domain.

October 1, 2025

• Updates to the Payment Component and Merchant Onboarding Component. For more information, see the changelog for component updates effective October 1st.
  • Always display the Postal Code field Account Holder Name field in the Payment Component.
  • Added support for ACH account type in the Payment Component.
  • Automatically enable the Validated ACH flow in the Merchant Onboarding Component.

September 23, 2025

• Added new prop allowed-deposit-methods to Merchant Onboarding Component.

September 22, 2025

• Added a Detailed Refusal Reason to the API and Refund Details Component. For more information, see the changelog for detailed refusal reason for failed refunds.
  • Added new fields detailed_refusal_code and detailed_refusal_desc to get refund and to the refunds object in get payin.
  • Added a Refusal Reason and Detailed Refusal Reason to the Refund Details Component in the "Related info" section.

August 27, 2025

• Added new field deposit_frequency to create merchant and update merchant request body params. For more information, see the changelog for merchant deposit frequencies.

August 7, 2025

• Added new field deposit_routes to get merchant and list merchants.

August 5, 2025

• Added new field merchant_billing to create payin config.
• Added new field merchant_billing to void or refund payin.

July 31, 2025

• Added new field payment_method_id to create payment method request body params.

July 9, 2025

• Added new column merchant_fees to the Payment Report Component.

July 2, 2025

• Added new field risk_data to create payin config.

June 24, 2025

• Added new field shipping_address to create payin config.

June 17, 2025

• Added new fields unit_of_measure, total_amount, discount_rate, and discount_amount to the level_2_3.line_items object in create payin config.

June 13, 2025

• Added new endpoint deactivate payment method.
• Added new endpoint update payment method.

June 9, 2025

• Added support for international postal codes in the Payment Component. For more information, see the changelog for international postal codes supported.

June 5, 2025

• Added new endpoint get refund.
• Added new fields ach_return and has_ach_return to refunds object in get payin.

June 4, 2025

• Added new endpoint list payment methods.

May 16, 2025

• Added new endpoint cancel merchant.
• Added new endpoint create BIN lookup.
• Added new field allow_bin_lookup to create payin config and create payment method config.
• Added new event bin_lookup to the Payment Component.

April 25, 2025

• Added new props style-container-max-width and style-container-padding to the Payment Component.
• Add new fields card_release_delay_days, ach_release_delay_days, validated_ach_release_delay_days, balance_checked_ach_release_delay_days to the create merchant endpoint.
• Added new endpoint update merchant.

March 12, 2025

• Added new field deposit_fee_amount to get deposit and list deposits endpoints.

March 11, 2025

• Added new fields billing_frequency and billing_type to create merchant request body params.

February 27, 2025

• Added support for balance checking validated ACH payments. For more information, see the changelog for balance-checked ACH payments.
  • Added new field ach_balance_check_modeto create payin config endpoint.
  • Added new fields validated_ach_release_delay_days and balance_checked_ach_release_delay_days to the following endpoints:
    • List merchants
    • Get merchant
    • List merchant applications
    • Get merchant application
    • Update merchant application
  • Added new field ach_balance_check_fee to the following endpoints:
    • Create billing profile
    • List billing profiles
    • Get billing profile
• Added support for an Expected Deposit Date on payments. For more information, see the changelog for payment expected deposit date.
  • Added Expected Deposit Date to the Related Info section of the Payin Details Component.
  • Added new field expected_deposit_date object to the following endpoints:
    • List payments
    • List payins
    • Get payin
    • Get chargeback
    • Get ACH return

January 13, 2025

• Updated the phone number language in the Merchant Onboarding Component. For more information, see the changelog for phone number language in onboarding.

January 9, 2025

• Added support for Validated ACH payment methods. For more information, see the changelog for Pay by Bank with Validated ACH.
  • Added VALIDATED_ACH to the allowed-methods prop in the Payment Component.
  • Added new prop validated-ach-view to the Payment Component.
  • Added Validated ACH to the Method filter in Payment Report Component.
  • Added ACH Validation to the Related Info section of the Payin Details Component.
  • Added new value PLAID_ACH to the method_type parameter in list payments and list payins endpoints.
  • Added new value PLAID_ACH to the method_type field and new field plaid_ach object to the following endpoints:
    • List payments
    • List payins
    • Get payin
    • Get payment method
    • Create payin from stored payment method
    • Create payin
  • Added new field ach_validation_fee to the following endpoints:
    • Create billing profile
    • List billing profiles
    • Get billing profile

January 6, 2025

• Added the ability to view an application in Read-only mode in the Merchant Onboarding Component. For more information, see the changelog for merchant application read-only view.
  • Updated the UI of the review page of the Merchant Onboarding Component to be a single page when an application is not in an editable status, such as Completed.
  • Added a new prop read-only to the Merchant Onboarding Component to display the application information in a read-only single page view.

December 4, 2024

• Added new underwriting review reasons to the additional verification for merchant onboarding flow. For more information, see the changelog for new review reasons in merchant onboarding verification.
  • Added new steps, Business Verification and Financial Review, to the Merchant Onboarding Component when the merchant application is in the Needs Information status.
  • Added new objects business_verification, financial_1, financial_2 to the underwriting_reviews field in get merchant application endpoint.

December 3, 2024

• Added support for signature collection when processing payments on a terminal device. For more information, see the changelog for signature collection on a device.
  • Added new field device_signature_mode to create payin config endpoint.
  • Added new fields signature and verification_type to the device_data object in get payin endpoint.
  • Added new prop show-signature to Payin Details Component and Payin Receipt Component.
  • Added new prop show-payin-signature to the following reporting components:
    • Chargeback Report Component
    • Deposit Report Component
    • Payment Report Component

November 22, 2024

• Removed the requirement of Date of Birth and Social Security Number for Public Corporation and Government representatives within the Merchant Onboarding flow. For more information, see the changelog for Merchant onboarding representative updates.
  • Updated owner_1.dob and owner_1.ssn to be optional when the merchant_type is PUBLIC_CORPORATION or GOVERNMENT. This is reflected in the validation_errors in g\et merchant application and submit merchant application endpoints.
  • The Representative step within the Merchant Onboarding Component no longer collects Date of Birth or Social Security Number if the merchant type is Public Corporation or Government.

November 20, 2024

• Added new field due_date to the list payments endpoint for chargebacks.
• Added new query params due_date.start and due_date.end to the list payments endpoint for chargebacks.
• Added new default column for Due Date to the Chargeback Report Component.
• Added Due Date to the Chargeback Details Component in the "Related Info" section.

November 19, 2024

• Increased the max value for the ach_fee field in the create billing profile endpoint from 500 to 1000 (i.e $5 to $10).

November 8, 2024

• Added a Detailed Refusal Reason to the API and Payin Details Component. For more information, see the changelog for detailed refusal reason for failed payins.
  • Added detailed_refusal_code and detailed_refusal_desc to the list payments, list payins, and get payin endpoints.
  • Added a Detailed Refusal Reason to the Payin Details Component in the "Related info" section.

November 5, 2024

• Added ability to simulate a deposit status change from Processing to Succeeded in Sandbox.

November 4, 2024

• Added chargeback management via API and Reporting Components. For more information, see the changelog for chargeback management in components.
  • Added new chargeback statuses INQUIRY_ACTION_REQUIRED, DISPUTE_ACTION_REQUIRED, INQUIRY_RESPONDED, CHARGEBACK_PROCESSING, PRE_ARBITRATION_PROCESSING, PROVISIONAL_WIN and ARBITRATION to the get chargeback and list payments endpoints.
  • Added new fields method_type, card, apple_pay, reason_code, reason_desc, acquirer_ref, due_date, chargeback_evidence, and validation_errors to the get chargeback endpoint.
  • Added new fieldacquirer_ref to the list payments endpoint.
  • Added the following endpoints:
    • Accept chargeback
    • Submit chargeback
    • Update chargeback evidence
    • Simulate a chargeback against a payin
    • Simulate chargeback status change
  • Added Chargeback Details Component
  • Added Chargeback Report Component
• Added new payin status Returned to payins. For more information, see the changelog for API version 2024-10-16.
  • Added new payin status RETURNED in list payments, list payins, and get payin endpoints.
  • Added new payin status to the Payin Details Component, Payin Receipt Component, Payment Report Component, Deposit Report Component, and Deposit Details Component.
• Partial refunds on payins with amount splits is now supported in the API and the refund modal in the Payin Details Component.

October 17, 2024

• Added a new prop show-record-count-selector to the following components to configure the number of records to display per page (options: 15, 30, 60 or 100).
  • Payment Report Component
  • Deposit Report Component
  • Chargeback Report Component

October 1, 2024

• Added validation to prevent 15-16 digit numbers from being passed in the billing contact fields on create payin config and create payment method config endpoints. For more information, see the changelog for billing contact validation.
• Added a new enum value RESTRICTED_CARD_TYPE torefusal_code on the payin and payment resources.

September 26, 2024

• Added partial authorization indicators to the Payin Details Component:
  • Added "Partially Authorized" tag to the right of the payin status.
  • Added "Amount Requested" to the Related Info section.

September 21, 2024

• Added new event loading to the Payment Component.
• Added new event loaded to the Payment Component.
• Added new prop hide-card-brand-logos to the Payment Component.
• Added new prop hide-error-message to the Payment Component.

September 18, 2024

• Added new field billable_merchant_id to the payment method config resource and the payment method resource to enable billing for processes such as Card Account Updater.

September 13, 2024

• Added ability to process partial authorizations:
  • Added new field allow_partial_authorization to the payin config resource.
  • Added new fields is_partially_authorized and payin_config to the payin resource.

August 20, 2024

• 3DS payments require billing contact fields. For more information, see the changelog for new 3DS requirements for Visa.

August 9, 2024

• Added ability to update a merchant's billing profile via API and the Rainforest Portal.

August 8, 2024

• Updated the Deposit Method step in the Needs Information flow (in the Merchant Onboarding Component) to include language for "voided check".

August 6, 2024

• Added event method-updated to the Payment Component.

August 2, 2024

• Updated empty string fields in billing_contact payloads to store as null.

August 1, 2024

• Updated Plaid deposit methods to return the actual account number last_4 instead of the virtual account number (VAN) provided by some banks (e.g. Chase).
• Updated the card_rate maximum value from 10% to 25% on billing profile resource.
• Added ability to disable Users in the Rainforest Portal.

Changelog documents all changes after August 1, 2024.