✔️

Feature requirements

🔐 Rainforest must enable the platform to access this feature

⬆️ Only available on the API version 2024-10-16

Rainforest supports processing payments with stored deposit methods. Deposit methods are collected when onboarding your merchants and determines where the merchant's deposits will be deposited to.

The most common use case for processing payments from your merchants deposit methods is to bill your merchants for fees owed to your platform. Instead of having to re-collect the merchant's bank account information as a payment method to process a payin, Rainforest will handle the conversion of the merchant's deposit method to a payment method for you.

Enable process payins from deposit methods

If you are interested in processing payins from merchant deposit methods, please reach out to your Platform Success Manager or support to enable this feature.

Onboard an internal merchant

In order to process payments to move funds from your merchants to your platform's bank account, you'll need to create an internal merchant that represents your platform.

You can onboard your internal merchant in the Platform Portal. Please provide the information of your platform and the bank account where you'd like to receive the funds for these payments. Work with your Platform Success Manager or support to approve this merchant for processing.

Once the internal merchant is Active, you will use this merchant to process the payments in the next step.

How to process a payin

There are two steps to process a payin from a deposit method:

1. Create a payin config to configure details such as the amount and metadata.
2. Process a payin from a deposit method given the payin config ID and deposit method ID.

Create a payin config

create a payin config to configure a payin with information, such as the amount and metadata.

Merchant

The payin should be processed on the internal merchant, onboarded in the above step by passing the internal merchant's merchant_id in the payin config request.

Billing contact

By default, the billing contact will be duplicated from the merchant's deposit method when processing the payin. It is highly recommended to use the billing contact details associated to the merchant's deposit method.

However, the billing contact can be defined in the payin config. If setting the billing contact in the payin config, Rainforest requires the name of the account holder of the bank account, which must be the merchant's business legal name, to process a payin from a deposit method.

Process a payin

Get the deposit method ID

To process a payin on a merchant's deposit method, use the get merchant endpoint to look up the merchant's deposit method. The deposit method ID is returned in the deposit_routes object:

{
    "merchant_id": "sbx_mid_34NEyRTRPYfne8b4X8uMXTCI7k4",
    // ...
+   "deposit_routes": {
+       "PAYMENTS": {
+           "deposit_method_id": "sbx_dmt_2boWzao2Sk5uUSnA1GXjdkmVm35"
+       }
+   }
    // ...
}

The deposit route for the PAYMENTS key represents the deposit method for the merchant's funding deposits.

Process a payin from the deposit method

When processing a payin from a deposit method, Rainforest will duplicate the deposit method details (i.e bank account number and billing contact) to a new payment method and then process the payin against the newly created payment method. Each payin processed will create a new payment method on every request.

It is highly encouraged to always process against the merchant's deposit method instead of the newly created payment method for future payments. This will ensure the most up to date bank account information is utilized when processing the payment.