Atualizações da API do Midaz no Ciclo 6

30 de março de 2026 Atualização de documentação Ação necessária

​

Afeta

---

Times usando APIs Midaz afetadas ou planejando mudanças de integração para o Ciclo 6. Esta atualização se aplica ao portal de documentação pública. Não altera o comportamento da API em runtime, a menos que a documentação do produto vinculada indique o contrário.

​

O que mudou

---

A documentação da API do Midaz foi atualizada para refletir todas as mudanças entregues no Ciclo 6. Isso inclui novos endpoints, schemas atualizados, filtros de query adicionais e novos códigos de erro — todos localizados em inglês, português e espanhol.

​

Novos endpoints

---

​

Ledger Settings

Dois novos endpoints permitem gerenciar regras de validação por Ledger via API:

• Retrieve Ledger Settings — GET /organizations/{id}/ledgers/{id}/settings
• Update Ledger Settings — PATCH /organizations/{id}/ledgers/{id}/settings

Esses endpoints controlam se a validação de Account Type e a validação de Route são aplicadas para um Ledger específico.

​

Balance History

Dois novos endpoints suportam consultas de saldo point-in-time para auditoria, reconciliação e relatórios históricos:

• Retrieve Balance History — Obtém o estado de um saldo específico em um determinado timestamp.
• Retrieve Balance History by Account — Obtém o estado de todos os saldos de uma conta em um determinado timestamp.

​

Schemas atualizados

---

​

Transaction Routing

• Operation Routes agora incluem accountingEntries e suportam um tipo de rota bidirectional
• Transaction Routes usam um novo formato de objeto operationRoutes
• Operations incluem novos campos: direction, routeId e routeCode

O guia Transaction Routing foi atualizado para refletir a nova estrutura e comportamento.

​

Novos filtros de query

---

​

Novos códigos de erro

---

Os códigos de erro 0140–0158 foram adicionados à referência de erros, cobrindo falhas de validação para as novas funcionalidades de Ledger Settings e routing.

​

Alinhamento da spec OpenAPI

---

Todas as specs OpenAPI publicadas foram alinhadas com as versões reais do codebase:

​

Impacto

---

Esta atualização de documentação inclui informações que os times devem revisar antes de alterar a integração ou deploy afetados.

​

O que você precisa fazer

---

​

Prazo

Antes da sua próxima mudança relacionada de integração, deploy ou upgrade.

​

Por quê

A documentação pública foi atualizada para refletir o comportamento da API e a cobertura de endpoints do Ciclo 6.