30 de marzo de 2026 Actualización de documentación Acción requeridaDocumentation Index
Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
Use this file to discover all available pages before exploring further.
Afecta
Equipos que usan APIs de Midaz afectadas o planifican cambios de integración del Cycle 6. Esta actualización aplica al portal público de documentación. No cambia el comportamiento de la API en tiempo de ejecución a menos que la documentación del producto enlazada indique lo contrario.
Qué cambió
La documentación de la API de Midaz se actualizó para reflejar todos los cambios entregados en el Cycle 6. Esto incluye nuevos endpoints, schemas actualizados, filtros de consulta adicionales y nuevos códigos de error, todo localizado en inglés, portugués y español.
Nuevos endpoints
Ledger Settings
Dos nuevos endpoints permiten gestionar las reglas de validación por Ledger a través de la API:- Retrieve Ledger Settings:
GET /organizations/{id}/ledgers/{id}/settings - Update Ledger Settings:
PATCH /organizations/{id}/ledgers/{id}/settings
Balance History
Dos nuevos endpoints soportan consultas de saldo en un momento determinado para auditoría, conciliación y reportes históricos:- Retrieve Balance History: obtiene el estado de un saldo específico en un timestamp dado.
- Retrieve Balance History by Account: obtiene el estado de todos los saldos de una cuenta en un timestamp dado.
Schemas actualizados
Transaction Routing
- Operation Routes ahora incluyen
accountingEntriesy soportan un tipo de rutabidirectional - Transaction Routes usan un nuevo formato de objeto
operationRoutes - Operations incluyen nuevos campos:
direction,routeIdyrouteCode
Nuevos filtros de consulta
| Endpoint | Nuevos filtros |
|---|---|
| List Organizations | legal_name, doing_business_as |
| List Ledgers | name |
| List Operations | direction, route_id |
Nuevos códigos de error
Se agregaron los códigos de error 0140–0158 a la referencia de errores, cubriendo fallos de validación para las nuevas funcionalidades de Ledger Settings y enrutamiento.
Alineación de spec OpenAPI
Todas las specs de OpenAPI publicadas se alinearon con las versiones reales de la base de código:
| Spec | Actualizada a |
|---|---|
| Ledger | v3.5.0 |
| CRM | última estable |
| Fees Engine | última estable |
| Access Manager | última estable |
Impacto
Esta actualización de documentación incluye información que los equipos deben revisar antes de cambiar la integración o el despliegue afectados.