Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

The Fees Engine is an optional plugin for the Midaz Module that lets operators model transaction fees from the Console. Once enabled, it adds two pages to the Midaz Module sidebar:
  • Fee Packages: create and edit packages and their rules.
  • Calculator: estimate what a package would charge before applying it to a real Transaction.
The Fees Engine builds on the same Ledgers, Segments, Transaction Routes, and Accounts already defined in Midaz Core. Packages use that existing structure to determine scope and are automatically applied whenever matching Transactions are processed.

Key concepts


  • Fee Package — Container that groups one or more fee rules and the conditions under which they apply (transaction route, segment, ledger, amount range).
  • Fee Rule — An individual fee inside a package, with its own calculation method.
  • Application Rule — How a single fee is calculated: flat, percentage, or maximum between both.
  • Reference Amount — Whether a percentage fee is calculated on the original Transaction amount or after other fees.
  • Priority — Order in which multiple fees inside the same package are applied.
  • Waiver — A source account exempted from a given package.

Enabling the plugin


The Fees Engine only appears in the sidebar after it is enabled. What is shown in Plugin settings depends on your organization license — if you do not see the Fees Engine there, contact the Lerian team.
1

Open Plugin settings

From the Midaz Module sidebar, go to Settings > Plugins.
2

Enable Fees Engine

Toggle Fees Engine on. The Fees Engine menu item appears in the sidebar with Fee Packages and Calculator sub-items.
Disabling the plugin later hides its menu but does not delete any Fee Package you have created.

Where to go next


Manage Fee Packages

Create, edit, and delete packages — define rules, scope by ledger or segment, and set waivers.

Fee Calculator

Estimate what a package would charge for a sample Transaction without running a real one.