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

# Atualizações da API do Midaz no Ciclo 6

> Novos endpoints do Ciclo 6 do Midaz para Ledger Settings, Balance History e Transaction Routes bidirecionais, com códigos de erro atualizados e alinhamento do OpenAPI.

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

## Afeta

***

Equipes que usam as APIs do Midaz afetadas ou que planejam mudanças de integração no Ciclo 6.

Esta atualização se aplica ao portal público de documentação. Ela não muda o comportamento da API em runtime, a menos que a documentação do produto vinculada diga 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 consulta adicionais e novos códigos de erro, tudo localizado em inglês, português e espanhol.

### Novos endpoints

***

### Ledger Settings

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

* [**Recuperar Ledger Settings**](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-ledger-settings.md): `GET /organizations/{id}/ledgers/{id}/settings`
* [**Atualizar Ledger Settings**](https://docs.lerian.studio/pt/reference/products/midaz/v2/update-ledger-settings.md): `PATCH /organizations/{id}/ledgers/{id}/settings`

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

### Balance History

Dois novos endpoints aceitam consultas de saldo em um instante no tempo para auditoria, conciliação e relatórios históricos:

* [**Recuperar Balance History**](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-balance-at-timestamp.md): Obtenha o estado de um saldo específico em um timestamp dado.
* [**Recuperar Balance History por conta**](https://docs.lerian.studio/pt/reference/products/midaz/v2/get-account-balances-at-timestamp.md): Obtenha o estado de todos os saldos de uma conta em um timestamp dado.

> [!WARNING]
>
> O parâmetro `date` é obrigatório e deve seguir o formato `yyyy-mm-dd hh:mm:ss`. Se não houver dados de saldo para o timestamp informado, um erro `404` é retornado.

### Schemas atualizados

***

### Transaction Routing

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

O guia [Transaction Routing](https://docs.lerian.studio/pt/products/midaz/transaction-routing-entities.md) foi atualizado para refletir a nova estrutura e o novo comportamento.

### Novos filtros de consulta

***

| Endpoint | Novos filtros |
| - | - |
| Listar Organizations | `legal_name`, `doing_business_as` |
| Listar Ledgers | `name` |
| Listar Operations | `direction`, `route_id` |

### Novos códigos de erro

***

Os códigos de erro **0140–0158** foram adicionados à [referência de erros](https://docs.lerian.studio/pt/reference/products/midaz/error-list.md), cobrindo falhas de validação dos novos recursos de Ledger Settings e de roteamento.

### Alinhamento da spec OpenAPI

***

Todas as specs OpenAPI publicadas foram alinhadas com as versões reais do código:

| Spec | Atualizada para |
| - | - |
| Ledger | v3.5.0 |
| CRM | última estável |
| Fees Engine | última estável |
| Access Manager | última estável |

## Impacto

***

Recomenda-se que as equipes revisem as informações desta atualização de documentação antes de mudar a integração ou o deploy afetado.

## O que você precisa fazer

***

**Step 1**

Revise a documentação nova de Ledger Settings, Balance History, Transaction Routing, filtros e erros antes da sua próxima mudança de integração com o Midaz.

### Prazo

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

### Por quê

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


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