This domain-driven architecture keeps configuration (Onboarding) and execution (Transaction) separate but integrated.
Domains and APIs
Onboarding domain
In the Onboarding Domain, institutions structure their financial operations. They configure the essential entities of their ledger. This domain sets the rules, accounts, and relationships that govern how the ledger records and interprets transactions.Components of the Onboarding Domain
- Organizations: A business entity that runs on Midaz, such as a bank, fintech, or subsidiary. Each organization holds its own ledgers, configurations, and access controls. One platform then supports multi-entity operations.
- Ledgers: The core financial book of an organization. track every balance, transaction, and operation. They protect the integrity of all financial data. Think of a ledger as the single source of truth for a business unit’s finances.
- : The units of value that the ledger tracks, such as BRL, USD, BTC, or loyalty points. With this flexibility, institutions manage traditional currencies, digital assets, and custom reward programs in the same system.
-
: Classifications that define the nature and purpose of accounts, for example checking, savings, escrow, or settlement. With
validateAccountTypeenabled, a new non-external Account’stypemust match a registered value. Operation Routes separately validate accounts during route processing. - Accounts: The fundamental units of value storage, where money or any asset lives. Each account always links to an Asset. You can group accounts into segments or portfolios to reflect your business structure.
- : A group of accounts that belong to the same customer, business unit, or purpose. For example, one client may hold checking, savings, and investment accounts in different currencies. A portfolio ties them together for a unified view.
- : Groups of accounts that share traits, such as customer tiers or regional divisions, for example VIP or Student. Segments help you enforce different rules, prices, or benefits across your customer base.
Transaction Domain
After you configure the Onboarding Domain, the Transaction Domain takes over. It powers the real-time execution, movement, and reconciliation of funds.Components of the Transaction Domain
- Balances: The current balance of any account, including its available and on-hold amounts. This real-time snapshot supports validations, pre-transaction checks, and customer-facing displays.
- : Reusable templates that define the rules for each leg of a financial transaction. A route specifies which accounts participate, in what direction (source or destination), and under what accounting annotation. Every transaction type then follows consistent business rules.
- : The atomic unit of movement in the ledger, a single debit or credit. The ledger breaks every financial movement into operations. This gives a complete and precise traceability for compliance and reporting.
-
: Complete transaction blueprints that combine multiple Operation Routes. For example, a Pix Transfer route defines its source and destination rules. When you enable Accounting Route validation, Midaz validates the transaction route and its Operation Routes for that transaction type. The API exposes this as the
transactionRouteresource. - Transactions: The actual movement of value between accounts. A transaction can involve multiple Operations, such as fees, taxes, or splits. This supports complex financial flows, like marketplace payouts or multi-party settlements, in a single atomic event.
Domain reference
Midaz is a domain-driven ledger platform.