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

> Visão geral de alto nível da arquitetura e componentes principais do Midaz

export const GAccountType = ({children}) => <Tooltip headline="Tipo de conta" tip="Uma classificação que define a natureza e propósito de uma conta — como corrente, poupança, custódia ou liquidação — permitindo o roteamento adequado de transações." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

export const GAuditTrail = ({children}) => <Tooltip headline="Trilha de auditoria" tip="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." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

export const GOperation = ({children}) => <Tooltip headline="Operação" tip="A unidade atômica de movimento no ledger — um único débito ou crédito. Cada transação é composta por uma ou mais operações, proporcionando rastreabilidade precisa para compliance e relatórios." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

export const GOperationRoute = ({children}) => <Tooltip headline="Operation Route" tip="Um template reutilizável que define as regras para uma etapa de uma transação financeira — especificando quais contas participam, em qual direção e sob qual anotação contábil." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

export const GTransactionRoute = ({children}) => <Tooltip headline="Rota Contábil" tip="Um modelo completo de transação composto por múltiplas Operation Routes — definindo todos os débitos e créditos envolvidos em um tipo de transação, garantindo conformidade com partidas dobradas." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

export const GSegment = ({children}) => <Tooltip headline="Segmento" tip="Uma classificação aplicada a contas que compartilham características — como níveis de clientes (VIP, Estudante) ou divisões regionais — permitindo regras e preços diferenciados." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

export const GPortfolio = ({children}) => <Tooltip headline="Portfolio" tip="Um agrupamento de contas pertencentes ao mesmo cliente, unidade de negócio ou finalidade — unindo contas correntes, poupança e investimento em uma visão unificada." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

export const GAsset = ({children}) => <Tooltip headline="Asset" tip="Uma unidade de valor rastreada no ledger — moedas tradicionais (BRL, USD), moedas digitais (BTC) ou unidades customizadas como pontos de fidelidade. Cada conta está vinculada a exatamente um asset." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

export const GSourceAvailable = ({children}) => <Tooltip headline="Source-available" tip="Um modelo de licenciamento onde o código-fonte é publicamente acessível para inspeção, modificação e auto-hospedagem, enquanto certos usos comerciais podem exigir uma licença." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

export const GDoubleEntry = ({children}) => <Tooltip headline="Partidas dobradas" tip="Cada movimentação financeira é registrada como pelo menos duas operações: um débito de uma conta e um crédito em outra, garantindo que o sistema esteja sempre balanceado." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

export const GLedger = ({children}) => <Tooltip headline="Ledger" tip="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." cta="Ver glossário" href="/pt/glossary">
    {children}
  </Tooltip>;

O Midaz é a espinha dorsal de infraestruturas financeiras modernas, projetado para ajudar instituições a construir, operar e escalar ecossistemas transacionais com agilidade e precisão. Como um <GLedger>ledger</GLedger> central <GSourceAvailable>source-available</GSourceAvailable>, o Midaz oferece uma base modular e extensível, capacitando clientes a moldar suas operações financeiras com independência.

Em seu núcleo, o Midaz é estruturado em torno de dois domínios essenciais: **Onboarding** e **Transação**. Juntos, eles fornecem um framework completo para configurar, executar e governar fluxos financeiros em escala.

<Note>
  Essa arquitetura orientada a domínios garante que configuração (Onboarding) e execução (Transação) permaneçam claramente separadas, porém totalmente integradas — possibilitando performance, rastreabilidade e agilidade nos negócios.
</Note>

## Domínios e APIs

***

### Domínio de Onboarding

O **Domínio de Onboarding** é onde as instituições estruturam suas operações financeiras configurando as entidades essenciais do seu ledger. Este domínio estabelece as regras, contas e relacionamentos que governam como as transações serão registradas e interpretadas.

#### Componentes do Domínio de Onboarding

* **Organizações**: Representa uma entidade de negócio — como um banco, fintech ou subsidiária — operando dentro do Midaz. Cada organização possui seus próprios ledgers, configurações e controles de acesso, possibilitando operações multi-entidade em uma única plataforma.
* **Ledgers**: O livro financeiro central de uma organização. <GLedger>Ledgers</GLedger> rastreiam cada saldo, transação e operação, garantindo integridade em todos os dados financeiros. Pense em um ledger como a fonte única da verdade para as finanças de uma unidade de negócio.
* **<GAsset>Ativos</GAsset>**: Definem as unidades de valor rastreadas no ledger — como BRL, USD, BTC ou pontos de fidelidade. Essa flexibilidade permite que instituições gerenciem moedas tradicionais, ativos digitais e programas de recompensa personalizados dentro do mesmo sistema.
* **<GAccountType>Tipos de Conta</GAccountType>**: Classificações que definem a natureza e o propósito das contas (ex.: conta corrente, poupança, escrow, liquidação). Esses tipos permitem o roteamento adequado de transações e garantem que as regras de negócio sejam aplicadas de forma consistente entre as categorias de conta.
* **Contas**: As unidades fundamentais de armazenamento de valor — onde o dinheiro (ou qualquer ativo) efetivamente reside. Contas estão sempre vinculadas a um Ativo e podem ser organizadas em segmentos ou Portfólios para refletir a estrutura do seu negócio.
* **<GPortfolio>Portfólios</GPortfolio>**: Agrupam múltiplas contas pertencentes ao mesmo cliente, unidade de negócio ou propósito. Por exemplo, um único cliente pode ter conta corrente, poupança e investimentos em diferentes moedas — um portfólio une tudo em uma visão unificada.
* **<GSegment>Segmentos</GSegment>**: Permitem o agrupamento de contas sob características compartilhadas, como categorias de clientes (ex.: VIP, Estudante) ou divisões regionais. Segmentos ajudam a aplicar regras, precificação ou benefícios diferenciados em toda a sua base de clientes.

<Tip>
  O Domínio de Onboarding configura como o seu mundo financeiro é estruturado, garantindo consistência antes que qualquer transação ocorra.
</Tip>

### Domínio de Transação

Uma vez que o Domínio de Onboarding está configurado, o **Domínio de Transação** assume — impulsionando a execução, movimentação e reconciliação de fundos em tempo real.

#### Componentes do Domínio de Transação

* **Saldos**: Recuperam o saldo atual de qualquer conta, incluindo seus valores disponíveis, bloqueados e reservados. Este é o snapshot financeiro em tempo real que suporta validações, verificações pré-transação e exibições voltadas ao cliente.
* **<GOperationRoute>Rotas de Operação</GOperationRoute>**: Templates reutilizáveis que definem as regras para cada "perna" de uma transação financeira — especificando quais contas participam, em qual direção (origem/destino) e sob qual anotação contábil. Elas garantem que cada tipo de transação siga regras de negócio consistentes.
* **<GOperation>Operações</GOperation>**: A unidade atômica de movimentação no ledger — um único débito ou crédito. Cada movimentação financeira é decomposta em operações, fornecendo uma <GAuditTrail>trilha de auditoria</GAuditTrail> completa e rastreabilidade precisa para conformidade e relatórios.
* **<GTransactionRoute>Rotas Contábeis</GTransactionRoute>**: Blueprints completos de transação compostos por múltiplas Rotas de Operação. Por exemplo, uma rota "Transferência Pix" define todos os débitos e créditos envolvidos, garantindo conformidade com <GDoubleEntry>double-entry</GDoubleEntry> toda vez que esse tipo de transação é executado. (Exposta como o recurso `transactionRoute` na API.)
* **Transações**: A movimentação real de valor entre contas. Transações podem envolver múltiplas **Operações** (ex.: taxas, impostos, splits), possibilitando fluxos financeiros complexos como pagamentos de marketplace ou liquidações multi-parte em um único evento atômico.

<Tip>
  O Domínio de Transação garante que cada movimentação seja processada com precisão, transparência e em conformidade com as regras de negócio e contabilidade configuradas previamente.
</Tip>

## Resumo

***

O Midaz é uma plataforma de ledger orientada a domínios, projetada para confiabilidade, flexibilidade e governança.

| Domínio        | Propósito                                                        | APIs principais                                                                            |
| :------------- | :--------------------------------------------------------------- | :----------------------------------------------------------------------------------------- |
| **Onboarding** | Estruturação e configuração do ecossistema financeiro.           | Organizations, Ledgers, Assets, Account Types, Accounts, Portfólios, Segments              |
| **Transação**  | Execução, movimentação e contabilidade de operações financeiras. | Balances, Rotas Contábeis (`transactionRoute`), Transactions, Operation Routes, Operations |

Com essa arquitetura, o Midaz permite que instituições financeiras estruturem seus dados com precisão e operem em escala, mantendo total controle e transparência sobre seu ecossistema financeiro.
