Business Rules
Configuration Levels (Scopes)
Merchants can configure markup at three different levels of priority:Global (Merchant Level)
The merchant defines a markup that will be applied to all charges from all submerchants.By Submerchant
The merchant can define specific markups for each individual submerchant.Inline in Request (By Charge or Payment)
When creating a charge or payment, the merchant can send a specificmarkup object.
Priority Rule: The inline markup configuration takes priority over all other markup settings.
If there is no specific configuration → the global markup is applied when merchant has the markup feature enabled.
Markup Types
Fixed
The same fixed markup value is applied to all charges/payments, regardless of the transaction amount.Percentage
The markup value is calculated as a percentage of the charge/payment amount. This type includes delimiter fields to define a valid range for the final markup amount:-
min_charge_value: The minimum markup amount to be charged. -
max_charge_value: The maximum markup amount to be charged.
Percentage Calculation Logic
- The system calculates the raw percentage value (transaction_amount * percentage).
- If the calculated value is less than min_charge_value, the min_charge_value is applied.
- Else if the calculated value is greater than max_charge_value, the max_charge_value is applied.
- Otherwise, the exact calculated value is applied.
| Transaction | Markup % | Min Value | Max Value | Calculation | Applied | Reason |
|---|---|---|---|---|---|---|
| R$ 10.00 | 0.3% | R$ 0.05 | R$ 0.15 | R$ 0.03 | R$ 0.05 | Uses min_charge_value (0.03 < 0.05) |
| R$ 10.00 | 1.7% | R$ 0.05 | R$ 0.15 | R$ 0.17 | R$ 0.15 | Uses max_charge_value (0.17 > 0.15) |
| R$ 10.00 | 1.2% | R$ 0.05 | R$ 0.15 | R$ 0.12 | R$ 0.12 | Uses calculated value (0.05 < 0.12 < 0.15) |