This domain-driven architecture ensures that configuration (Onboarding) and execution (Transaction) remain clearly separated yet fully integrated — enabling performance, traceability, and business agility.
Domains and APIs
Onboarding domain
The Onboarding Domain is where institutions structure their financial operations by configuring the essential entities of their ledger. This domain establishes the rules, accounts, and relationships that govern how transactions will be recorded and interpreted.Components of the Onboarding Domain
- Organizations: Represent a business entity — such as a bank, fintech, or subsidiary — operating within Midaz. Each organization holds its own ledgers, configurations, and access controls, enabling multi-entity operations under one platform.
- Ledgers: The core financial book of an organization. track every balance, transaction, and operation, ensuring integrity across all financial data. Think of a ledger as the single source of truth for a business unit’s finances.
- : Define the units of value tracked in the ledger — such as BRL, USD, BTC, or loyalty points. This flexibility allows institutions to manage traditional currencies, digital assets, and custom reward programs within the same system.
- : Classifications that define the nature and purpose of accounts (e.g., checking, savings, escrow, settlement). These types enable proper transaction routing and ensure that business rules are applied consistently across account categories.
- Accounts: The fundamental units of value storage — where money (or any asset) actually lives. Accounts are always linked to an Asset and can be organized further into segments or portfolios to reflect your business structure.
- : Group multiple accounts belonging to the same customer, business unit, or purpose. For example, a single client may hold checking, savings, and investment accounts across different currencies — a portfolio ties them together for a unified view.
- : Enable the grouping of accounts under shared characteristics, like customer tiers (e.g., VIP, Student) or regional divisions. Segments help enforce differentiated rules, pricing, or benefits across your customer base.
Transaction Domain
Once the Onboarding Domain is configured, the Transaction Domain takes over — powering the real-time execution, movement, and reconciliation of funds.Components of the Transaction Domain
- Balances: Retrieve the current balance of any account, including its available, on-hold, and reserved amounts. This is the real-time financial snapshot that supports validations, pre-transaction checks, and customer-facing displays.
- : Reusable templates that define the rules for each “leg” of a financial transaction — specifying which accounts participate, in what direction (source/destination), and under what accounting annotation. They ensure every transaction type follows consistent business rules.
- : The atomic unit of movement in the ledger — a single debit or credit. Every financial movement is broken down into operations, providing a complete and precise traceability for compliance and reporting.
- : Complete transaction blueprints composed of multiple Operation Routes. For example, a “Pix Transfer” route defines all the debits and credits involved, ensuring compliance every time that transaction type is executed.
- Transactions: The actual movement of value between accounts. Transactions can involve multiple Operations (e.g., fees, taxes, splits), enabling complex financial flows like marketplace payouts or multi-party settlements in a single atomic event.
In short
Midaz is a domain-driven ledger platform designed for reliability, flexibility, and governance.
| Domain | Purpose | Key APIs |
|---|---|---|
| Onboarding | Structure and configuration of the financial ecosystem. | Organizations, Ledgers, Assets, Account Types, Accounts, Portfolios, Segments |
| Transaction | Execution, movement, and accounting of financial operations. | Balances, Transaction Routes, Transactions, Operation Routes, Operations |