​
Typical usage

Here’s how the process works, from configuring fees to seeing the results.

​
Step 1 - Create your fee packages

Start by setting up fee packages that define how fees are applied. To do so, use the Create a Package endpoint. These packages can be customized for different account groups or customer segments, with key parameters such as:
  • Chart of Accounts – Specifies which accounts are impacted.
  • Segment ID – Identifies the relevant customer or business group.
  • Ledger ID – Ties the fee structure to a specific ledger.
  • Min/Max Ranges – Optional thresholds that control fee application.
This flexibility ensures that fees are applied exactly as needed for each unique scenario.
The following endpoints are also available for you to manage the packages:

​
(optional) Step 2 - Create a simulation

If you want to verify the fees before creating the actual transaction, you can use the Simulate Transaction Fees endpoint. It helps you validate expected charges before processing.

​
Step 3 - Create a transaction

Once your fee packages are in place, create a transaction.

​
Step 4 - The Fee Engine kicks In

The system automatically sends a call to the Calculate Fees for a Package endpoint to evaluate and apply the fee rules. The Fee Engine checks for matching fee packages based on the following:
  • Chart of Accounts
  • Segment ID
  • Ledger ID
  • Min/Max Value Conditions
Only packages that meet the criteria will be considered for applying fees.

​
Step 5 - Fee-free scenarios

The system checks if the transaction qualifies for a fee exemption:
  • Exempt: If the transaction qualifies for fee-free status, the system returns a message, and no fees are applied. The transaction proceeds unchanged.
  • Not Exempt: If there’s no exemption, the system moves forward with calculating and applying the fees.

​
Step 6 - Fee calculation and application

When fees are applied, the system:
  • Calculates the applicable fee amounts.
  • Applies them according to the rules in your fee package.
  • Returns the transaction details and the fee package ID in the metadata object.
The fees are routed to the designated creditAccount.

​
Step 7 - Ledger updates

The Transactions component takes over, processing debits and credits in the relevant ledger. Every movement—fees included—is recorded for traceability and reporting.

​
Step 8 - Review the transaction

Finally, the user can:
  • View the transaction.
  • Inspect all fee movements.
  • Verify which fees were applied and how they impacted each account.