Afecta a
Equipos que usan las APIs de Midaz afectadas o que planifican cambios de integración del Ciclo 6. Esta actualización aplica al portal de documentación pública. No cambia el comportamiento de la API en tiempo de ejecución, a menos que la documentación de 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 Ciclo 6. Esto incluye nuevos endpoints, esquemas actualizados, filtros de consulta adicionales y nuevos códigos de error — todo localizado en inglés, portugués y español.
Endpoints nuevos
Ledger Settings
Dos endpoints nuevos permiten gestionar reglas de validación por Ledger a través de la API:- Recuperar Ledger Settings —
GET /organizations/{id}/ledgers/{id}/settings - Actualizar Ledger Settings —
PATCH /organizations/{id}/ledgers/{id}/settings
Balance History
Dos endpoints nuevos admiten consultas de saldo en un momento determinado para auditoría, conciliación e informes históricos:- Recuperar Balance History — Obtén el estado de un saldo específico en un timestamp dado.
- Recuperar Balance History por cuenta — Obtén el estado de todos los saldos de una cuenta en un timestamp dado.
Esquemas actualizados
Transaction Routing
- Operation Routes ahora incluyen
accountingEntriesy admiten un tipo de rutabidirectional - Transaction Routes usan un nuevo formato de objeto
operationRoutes - Operations incluyen nuevos campos:
direction,routeIdyrouteCode
Filtros de consulta nuevos
Códigos de error nuevos
Los códigos de error 0140–0158 se agregaron a la referencia de errores y cubren las fallas de validación de las nuevas funciones de Ledger Settings y de enrutamiento.
Alineación de las specs de OpenAPI
Todas las specs de OpenAPI publicadas se alinearon con las versiones reales del código:
Impacto
Esta actualización de documentación incluye información que se recomienda que los equipos revisen antes de cambiar la integración o el despliegue afectados.
Qué debes hacer
1
Revisa la documentación nueva de Ledger Settings, Balance History, Transaction Routing, filtros y errores antes de tu próximo cambio de integración con Midaz.