> ## 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.

# Sobre o Midaz

> Conheça o serviço Ledger do Midaz, os domínios Onboarding e Transaction e os recursos embutidos de CRM e Fees.

O Midaz é um core ledger (O livro financeiro central que registra todas as transações, saldos e operações de uma organização. É a fonte única de verdade para as finanças de uma unidade de negócio.). Instituições financeiras o usam para construir, operar e escalar as transações delas sobre uma base modular. Você mantém o controle total da sua stack.

O serviço Ledger do Midaz tem dois domínios centrais: **Onboarding** e **Transaction**. Ele também embute o CRM para titulares e instrumentos, e o Fees. Juntos, eles entregam os componentes para configurar, executar e governar fluxos financeiros.

> [!NOTE]
>
> Essa arquitetura orientada a domínios mantém a configuração (Onboarding) e a execução (Transaction) separadas, porém integradas.

## Domínios e APIs

***

### Domínio Onboarding

No **Domínio Onboarding**, as instituições estruturam as operações financeiras delas. Elas configuram as entidades essenciais do ledger. Esse domínio define as regras, contas e relações que governam como o ledger registra e interpreta as transações.

#### Componentes do Domínio Onboarding

* **Organizações**: uma entidade de negócio que roda no Midaz, como um banco, uma fintech ou uma subsidiária. Cada organização tem os próprios ledgers e configurações. Uma única plataforma então atende operações com várias entidades.

* **Ledgers**: o livro financeiro central de uma organização. Ledgers (O livro financeiro central que registra todas as transações, saldos e operações de uma organização. É a fonte única de verdade para as finanças de uma unidade de negócio.) acompanham cada saldo, transação e operação. Eles protegem a integridade de todos os dados financeiros. Pense em um ledger como a fonte única de verdade para as finanças de uma unidade de negócio.

* **Ativos (Uma unidade de valor rastreada no ledger, como moedas tradicionais (BRL, USD), moedas digitais (BTC) ou unidades personalizadas como pontos de fidelidade. Cada conta está vinculada a exatamente um ativo.)**: as unidades de valor que o ledger acompanha, como BRL, USD, BTC ou pontos de fidelidade. Com essa flexibilidade, as instituições administram moedas tradicionais, ativos digitais e programas de recompensa personalizados no mesmo sistema.

* **Tipos de Conta (Uma classificação que define a natureza e a finalidade de uma conta, como conta corrente, poupança, custódia ou liquidação. Os tipos de conta permitem o roteamento correto das transações.)**: classificações que definem a natureza e a finalidade das contas, por exemplo corrente, poupança, escrow ou liquidação. Com `validateAccountType` habilitado, o `type` de uma nova Conta não externa deve corresponder a um valor registrado. As Rotas de Operação validam as contas separadamente durante o processamento da rota.

* **Contas**: as unidades fundamentais de guarda de valor, onde o dinheiro ou qualquer ativo fica. Cada conta sempre se liga a um Ativo. Você pode agrupar contas em segmentos ou portfólios para refletir a estrutura do seu negócio.

* **Portfólios (Um agrupamento de contas pertencentes ao mesmo titular, unidade de negócio ou finalidade. Reúne contas correntes, de poupança e de investimento em uma visão unificada.)**: um grupo de contas que pertencem ao mesmo cliente, unidade de negócio ou finalidade. Por exemplo, um cliente pode ter contas corrente, poupança e de investimento em moedas diferentes. Um portfólio amarra essas contas em uma visão unificada.

* **Segmentos (Uma classificação aplicada a contas que compartilham características, como níveis de titular (VIP, Estudante) ou divisões regionais. Regras e precificação podem variar por segmento.)**: grupos de contas que compartilham características, como faixas de clientes ou divisões regionais, por exemplo VIP ou Estudante. Segmentos ajudam você a aplicar regras, preços ou benefícios diferentes na sua base de clientes.

> [!TIP]
>
> O Domínio Onboarding configura como o seu mundo financeiro é estruturado. Ele dá consistência antes de qualquer transação acontecer.

### Domínio Transaction

Depois que você configura o Domínio Onboarding, o **Domínio Transaction** assume. Ele cuida da execução e da movimentação de recursos em tempo real.

#### Componentes do Domínio Transaction

* **Saldos**: o saldo atual de qualquer conta, incluindo o saldo disponível e o valor retido dela. Esse retrato em tempo real sustenta validações, verificações antes da transação e telas voltadas ao cliente.

* **Rotas de Operação (Um template reutilizável que define as regras para uma perna de uma transação financeira: quais contas participam, em qual direção e sob qual anotação contábil.)**: templates reutilizáveis que definem as regras de cada perna de uma transação financeira. Uma rota especifica quais contas participam, em qual direção (origem, destino ou bidirecional) e sob qual anotação contábil. Cada tipo de transação então segue regras de negócio consistentes.

* **Operações (A unidade atômica de movimentação no ledger, um único débito ou crédito. Toda transação é composta por uma ou mais operações. As operações tornam as transações rastreáveis com precisão para conformidade e relatórios.)**: a unidade atômica de movimentação no ledger, um único débito ou crédito. O ledger quebra cada movimentação financeira em operações. Isso dá uma trilha de auditoria (Um registro cronológico e imutável de cada ação e transação no sistema, essencial para conformidade regulatória e resolução de disputas.) completa e rastreabilidade precisa para compliance e relatórios.

* **Rotas Contábeis (Um modelo completo de transação composto por várias Rotas de Operação. Define todos os débitos e créditos envolvidos em um tipo de transação, de modo que cada transação desse tipo segue as regras de partidas dobradas. Exposto como transactionRoute na API.)**: plantas completas de transação que combinam várias Rotas de Operação. Por exemplo, uma rota de Transferência Pix define as regras de origem e de destino dela. Quando você habilita a validação de Rota Contábil, o Midaz valida a rota de transação e as Rotas de Operação dela para esse tipo de transação. A API expõe isso como o recurso `transactionRoute`.

* **Transações**: a movimentação efetiva de valor entre contas. Uma transação pode envolver várias **Operações**, como tarifas, impostos ou divisões. Isso atende fluxos financeiros complexos, como repasses de marketplace ou liquidações com várias partes, em um único evento atômico.

> [!TIP]
>
> O Domínio Transaction processa cada movimentação em conformidade com as regras de negócio e contábeis que você configura antes.

## Referência de domínios

***

O Midaz é uma plataforma de ledger orientada a domínios.

| Domínio | Finalidade | APIs principais |
| :- | :- | :- |
| **Onboarding** | Estrutura e configuração do ecossistema financeiro. | Organizations, Ledgers, Assets, Account Types, Accounts, Portfolios, Segments |
| **Transaction** | Execução, movimentação e contabilização das operações financeiras. | Balances, Accounting Routes (`transactionRoute`), Transactions, Operation Routes, Operations |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.