Understanding deposits

Understanding deposits in the Rainforest ecosystem

In the Rainforest ecosystem, a Deposit is the movement of funds to or from a Merchant. The merchant provides where they want their funds to be deposited to in merchant onboarding.

A merchant will receive a deposit on each US banking day, consisting of all payments that are available for deposits. Deposit timing is dependent on the payment method type and merchant configuration.

Statuses


The deposit status is the descriptor of the current status in the life cycle of the deposit.

StatusDescription
PROCESSINGDeposit is processing and funds have been initiated.
IN_REVIEWDeposit has been flagged for risk review.
SUCCEEDEDDeposit has completed processing and the funds were deposited to the merchant.
FAILEDDeposit unsuccessfully attempted to process.

Sandbox simulation


In Production, deposits are automatically processed for your merchants. Deposits will include payments that are ready to be released to your merchant based on deposit timing per payment type. In the Sandbox environment, payments and deposits do not move on an automatic schedule, which allows you to have move control over testing.

In Sandbox, you can simulate the processing of a merchant deposit via the simulate merchant deposit endpoint. Simulating a deposit will do the following:

  1. Transition all the merchant's payments with the status of Processing to Succeeded.
  2. Create a deposit with the status of Processing.

Once the payments are in the Succeeded status, actions such as refunding can be taken on the payins.

You can also simulate the deposit status change from Processing to Succeeded via the simulate deposit status change endpoint. This will allow you to test all webhooks for payments and deposits that you will receive in Production.