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

Deposit summary update effective March 3rd

Rainforest will be updating the Deposit Report Component and Deposit Details Component on March 3rd, 2026 to better enhance your merchants experience when viewing their deposits.

Embedded component

The Deposit Details Component will update to display a deposit summary table above the deposit activity table. This summary table replaces the subtotal table that displayed below the deposit activity table.

Deposit summary

The new table will provide a summary of each payment type in the deposit that can include the following columns:

  • Count - the total count for the payment type deposited
  • Gross Amount - the gross amount for the payment type deposited
  • Billing Fees Amount - the total amount of the billing fees for the payment type deposited
  • Split Remainder Amount - the total amount of the amount splits for the billing type deposited
  • Net Amount - the total amount for the payment type deposited

Payment types

Each row represents a payment type in the deposit, which includes ACH Returns, Adjustments, Chargebacks, Deposits, Payins, and Refunds. The summary table will only include payment types that are included in the deposit.

Columns

The displayed amount columns will match the columns defined in the activity table by the activity-columns prop. This includes the order and title of the columns. This ensures the activity table will always be aligned with the summary table.


Preview feature

Rainforest will automatically update the Deposit Report Component on March 3rd, 2026 to display the new summary table.

You can also update your embedded Deposit Report Component to display the new summary table prior to March 3rd by enabling this feature with the preview-features prop and passing DEPOSIT_SUMMARY:

<rainforest-deposit-report
	session-key='REPLACE_ME'
+	preview-features='ALLOWED_METHOD_BUTTONS'
	...
></rainforest-payment>

Deposit report in Portal

The new summary table has been automatically added to the Deposit Report in the Rainforest Portal.


API

The following new fields, used to display the summary table, are available on the get deposit endpoint:

Field

Description

total_payment_billing_fees_amount

The total amount of the billing fees for all the deposit activity.

total_split_remainder_amount

The total amount of the amount splits for all the deposit activity.

total_fees_amount

The total amount of the billing fees and the amount splits for all the deposit activity.

Equal to total_payment_billing_fees_amount + total_split_remainder_amount

gross_amount

The gross amount of all the deposit activity

payment_totals

The total count and amount summaries (Gross Amount, Billing Fees Amount, Split Remainder Amount, and Net Amount) for each payment type in the deposit. Payment types include Payins, Refunds, Chargebacks, ACH Returns, Adjustments, and Deposits.

Please contact support if you have any questions.