Dynamic payment billing fees
Configure the billing fees per payment request to enable dynamic billing models on your merchants
In a standard model, billing fees are defined by the merchant's billing profile and Rainforest automatically calculates the billing fees when processing a payin or refund.
Rainforest supports defining the billing fee on each payin and refund, which will override the merchant's billing profile. This allows for your platform integration to handle complex billing configurations that the merchant's single billing profile model does not support.
Billing fee requirements
Payin billing fee
The defined billing rate and fee can only be set to the values of:
- Rate: >= 0% and <= 25%
- Rate Cap: >= $0 and <= $100,000
- Fee: >= $0 and <= $10 (or less than the payin amount)
The following validation must be met:
- If the rate is greater than 0%, then the rate cap must be greater than $0. For example, to bill a rate of 1% up to $100 set the value to 10000.
- If the rate is 0%, then the rate cap must be $0.
- The fee can be up to $10, regardless of the amount of the payin. However, if the fee is greater than $10, then the fee cannot be greater than the amount field.
Partial authorization
The payin rate is applied to the authorized amount of the payin. If your integration supports partial authorizations, then the billing rate is calculated on the authorized amount and the fee is applied. For example, given a 3% rate and $2 fee, for a $100 payment that only authorizes for $50 there would be a billing fee of $3.50 [($50 * 3%) + $2]. Note: this requires the Payin Config has partial authorization set to allowed.
Refund billing fee
The defined billing rate and fee can only be set to the values of:
- Rate: >= -25% and <= 25%
- Rate Cap: >= -$100,000 and <= $100,000
- Fee: >= -$10 and <= $10 (or less than the amount of the refund)
The following validation must be met:
- If the rate is greater than 0%, then the rate cap must be greater than $0. For example, to bill a rate of 1% up to $100 set the value to 10000.
- If the rate is less than 0%, then the rate cap must be less than $0. For example, to bill a rate of -1% up to -$100 set the value to -10000.
- If the rate is 0%, then the rate cap must be $0.
- The absolute value of the fee can be up to $10, regardless of the amount of the refund. However, if the absolute value of the fee is greater than $10, then the absolute value of the fee cannot be greater than the amount field.
Negative rate and fee
The billing rate and fee can be set to negative values to return the billing fees to the merchant. For example, if your integration preferred to give the fees from the originating payin back to the merchant when processing a refund, then the refund billing rate and fee can be set to -3% and -$2.00 to reverse the payin's billing fee of 3% and $2.00.
Merchant deposits
Rainforest will automatically allocate the billing fee to the Platform's residuals that will be deposited to the platform at the beginning of the next month. In this example, the merchant's deposit will include a payin with the net amount of $98 and a refund with the net amount of -$102.

Deposit flow diagram of the $100 payin with $2 billing fee

Payment details
The billing fee will appear in the same context as if the merchant's billing profile was used to calculate the fee.

Payin details

Refund details
Updated 2 days ago