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

Percentage-based amount splits

Rainforest now supports percentage-based amount splits by allowing you to specify a rate and rate cap when configuring an amount split. Amount splits are used to apply SaaS fees or service fees, in addition to payment processing fees defined by the merchant billing profile.

Defining the amount split


The amount split rate and rate cap are optional fields. You do not have to set the rate and rate cap fields if you prefer to only use a flat rate amount split.

When rate and rate cap are set, they can only be set to the values of:

  • Rate: >= 0% and <= 25%
  • Rate Cap: >= $0 and <= $100,000

The following validation must be met:

  • If the rate is greater than 0%, then the rate cap must be greater than $0.
  • If the rate is 0%, then the rate cap must be $0.

Payin config request

To define a percentage-based and flat amount split, the create payin config request would look like the following to set a rate of 3%, with a rate cap of $10, and an additional flat rate fee of $5.

 {
    "merchant_id": "{{merchant_id}}",
    "idempotency_key": "{{idempotency_key}}",
    "amount": 10000,
    "currency_code": "USD",
    "amount_splits": [
    {
+       "rate": 3000,
+       "rate_cap": 1000 
        "amount": 500,
        "currency_code": "USD",
        "type": "PLATFORM"
      }
    ]
  }

In this example, the total amount split for this $100 payin would be $8 ($3 from the rate, $5 from the flat fee amount). This would result in $92 (minus billing fees) being deposited to the merchant and $8 being deposited to the platform.

Auth and capture

When utilizing the two-step authorization and capture payment flow, you can now define an amount split with a rate and rate cap. The amount split defined on capture payin, will override the amount split on the payin config.


For more information see the Enable amount splits guide and please contact support if you have any questions.