Skip to main content

Fees

Overview​

During an Operation, fees might be applied. Fees are a portion of the Operation amount that will be forwarded to one o more specific beneficiaries. Beneficiaries, debtors and rules can be configued via APIs.

A Back Office User associated with a Dealer, Partner or Flowe can use the Fees APIs to configure the fees applied to any kind of operations.

How to configure the rules​

The Back Office User can manage the rules using the following APIs: Fee Rules.

When a Fee Rule is created, this will be applied for the Operation of the given type only if all specified conditions are matched:

  • ParterKey, DealerKey and (if configured) StoreId match the ones in the Operation
  • The Operation execution date is between the Start/End dates of the rule (if configured)
  • Operation amount is between the min/max limits (if configured)

The Rules will be applied following their priority using an ascending order.

The calculation of each Rule depends on the defined CalculationType, of which there are four:

  • SumToFeesFixedAmount. Add a fixed Amount to the Total Fees amount
  • SumToFeesPercentageOfOperationAmount, Add a percentage based on Operation Amount to Total Fees amount
  • OverrideFeesWithFixedAmount, Override Total Fees amount with a Fixed Amount
  • OverrideFeesWithPercentageOfOperationAmount, Override the Total Fees amount with a percentage base on Operation Amount

How to test Fee Rules​

After completing the configuration of fee rules, the ExplainCalculation Api can be used to simulate which rules will be applied and which will be skipped, along with the reason for skipping. This allows simulating different scenarios and ensures everything runs as expected.