- Las Rutas de Transacción definen la estructura completa de una transacción — la secuencia requerida de operaciones y cómo encajan para formar un evento financiero válido.
- Las Rutas de Operación definen las reglas para cada operación individual (o “tramo”) de esa transacción, incluyendo el tipo de cuenta esperado o cuenta específica, la anotación contable y si es un débito o crédito.
Usted define los patrones de validación a través de las Rutas de Operación y Rutas de Transacción. Midaz asegura que sus transacciones cumplan con estas reglas antes de procesarlas.
¿Para qué sirve el Enrutamiento de Transacciones?
El Enrutamiento de Transacciones proporciona control estructurado sobre sus operaciones financieras al separar la lógica de transacción del código de negocio. En lugar de codificar reglas de validación en su aplicación, usted configura patrones reutilizables que aseguran que cada movimiento financiero siga los requisitos de su organización. Estas entidades están dedicadas a vincular Transacciones y Operaciones del libro contable de Midaz con abstracciones de nivel superior que facilitan la integración con plugins especializados y sistemas externos, especialmente para abstracciones de contabilidad y tesorería. Las anotaciones estructuradas y clasificaciones crean un vocabulario estandarizado que otros componentes pueden entender y aprovechar. Este enfoque ofrece:
- Consistencia: Todas las transacciones siguen estructuras predefinidas independientemente de dónde se originen.
- Flexibilidad: Adapte el diseño de su libro contable para que coincida con las necesidades de su negocio sin cambios de código.
- Integridad: La validación automática previene que transacciones mal formadas afecten su libro contable.
- Mantenibilidad: La configuración centralizada facilita la actualización de reglas financieras a medida que su negocio evoluciona.
- Interoperabilidad: Los campos con semántica de negocio permiten una integración perfecta con plugins contables y sistemas financieros externos.
Trabajando con el Enrutamiento de Transacciones
Para usar el Enrutamiento de Transacciones, debe completar la configuración inicial seguida de la ejecución continua de transacciones. Aquí está su proceso paso a paso:
Configuración Inicial
1. Configurar Ledger para validación de ruta de transacción
Para activar la validación de ruta de transacción para un Ledger específico, habilite las configuraciones de validación a través de la API de Configuraciones del Ledger. Esto controla si las transacciones en ese Ledger deben cumplir con sus rutas configuradas.validateRoutes: Cuando está habilitada, cada transacción debe hacer referencia a una ruta de transacción válida.validateAccountType: Cuando está habilitada, los tipos de cuenta se validan contra las reglas de las rutas de operación.
2. Crear Rutas de Operación
Cree rutas de operación que definan reglas de validación y comportamiento para componentes individuales de transacción. Campos clave:- title: Etiqueta breve que identifica la ruta de operación.
- description: Explicación detallada opcional.
- metadata: Pares clave-valor para contexto de negocio y categorización personalizada.
-
operationType: La dirección contable para esta ruta —
source,destinationobidirectional.source— Identifica cuentas donde se originan los fondos (lado débito).destination— Identifica cuentas donde se envían los fondos (lado crédito).bidirectional— Se aplica a ambos lados de la transacción, actuando como origen y destino.
-
account: Reglas de validación opcionales que especifican el tipo de cuenta requerido o cuenta específica.
- ruleType: Tipo de regla de validación de cuenta (
account_type,alias). - validIf: El valor esperado que debe coincidir para que la validación pase.
- ruleType: Tipo de regla de validación de cuenta (
- accountingEntries: Asientos contables opcionales para cada tipo de acción. Consulte Asientos Contables a continuación.
- Apuntar a Cuenta Específica
- Apuntar a Tipo de Cuenta
accountingEntries mapea cada etapa a los códigos contables de partida doble correctos automáticamente.
Configure los asientos contables para cada tipo de acción:
direct, hold, commit, cancel, revert) se mapea a un par contable de partida doble — permitiendo que su ledger anote automáticamente las operaciones con los códigos contables correctos según la etapa del ciclo de vida de la transacción.
El campo
operationType ahora también admite bidirectional, lo que permite que la ruta opere en ambas direcciones — útil para rutas que manejan tanto envío como recepción, o para operaciones que pueden necesitar ser revertidas.Matriz de validación de entradas contables
No toda combinación deoperationType y acción es válida. Midaz aplica una matriz de validación estricta cuando creas o actualizas una Ruta de Operación — si las reglas no se cumplen, la solicitud se rechaza antes de persistirse.
Comprender esta matriz es crítico para los integradores: enviar una combinación inválida devuelve el error 0166 (campo requerido) o 0162/0165 (escenario no permitido para la dirección).
source
| Acción | Débito | Crédito | Notas |
|---|---|---|---|
direct | Requerido | Opcional | Transacción estándar de un paso en el origen |
hold | Requerido | Requerido | Reserva fondos — mueve available → on_hold |
commit | Requerido | Opcional | Finaliza una transacción de dos fases |
cancel | Requerido | Requerido | Libera los fondos reservados — mueve on_hold → available |
revert | — | — | No permitido (error 0165). Usa bidirectional en su lugar |
| Acción | Débito | Crédito | Notas |
|---|---|---|---|
direct | Opcional | Requerido | Transacción estándar de un paso en el destino |
hold | — | — | No permitido (error 0162) |
commit | Opcional | Requerido | Finaliza una transacción de dos fases |
cancel | — | — | No permitido (error 0162) |
revert | — | — | No permitido (error 0165). Usa bidirectional en su lugar |
| Acción | Débito | Crédito | Notas |
|---|---|---|---|
direct | Requerido | Requerido | Ambos lados de la partida doble |
hold | Requerido | Requerido | Ambos lados de la partida doble |
commit | Requerido | Requerido | Ambos lados de la partida doble |
cancel | Requerido | Requerido | Ambos lados de la partida doble |
revert | Requerido | Requerido | Única dirección que admite revert |
Una entrada sin
debit ni credit siempre es rechazada, independientemente del tipo de operación o acción.- Atomicidad del grupo de reserva: Si defines
hold, también debes definircommitycancel(y viceversa). Estas tres acciones forman un grupo atómico — no puedes configurar una sin las otras. directes obligatorio: Si se define cualquier otra acción (hold,commit,cancel,revert),directtambién debe estar presente. Sirve como la entrada base para la ruta de operación.
3. Construir Rutas de Transacción
Complete su configuración combinando Rutas de Operación en Rutas de Transacción. Estas definen sus patrones de transacción completos, mapeando cómo diferentes operaciones trabajan juntas para formar eventos financieros equilibrados que coinciden con sus procesos de negocio.4. Configurar Asientos Contables (Acciones)
Cada Ruta de Operación puede incluir Asientos Contables — rúbricas estructuradas que definen cómo se registran los asientos de débito y crédito para cada tipo de evento transaccional. Cuando un Ledger está configurado para validar rutas, solo se permiten los eventos con asientos registrados. Esto garantiza consistencia en sus reportes contables.Tipos de acción
Cada acción representa un evento transaccional. Usted configura asientos contables por acción en cada Ruta de Operación:| Acción | Identificador | Descripción |
|---|---|---|
| Transacción Directa | direct | Transacción estándar de un solo paso entre dos cuentas, sin etapas intermedias. |
| Hold (Reserva de Valor) | hold | Primer paso de una Transacción en Dos Fases: mueve el valor del saldo available al on_hold en la cuenta de origen. |
| Commit (Confirmación) | commit | Confirma una Transacción en Dos Fases pendiente, transfiriendo el valor on_hold de la cuenta de origen al saldo available en la cuenta de destino. |
| Cancel | cancel | Cancela una Transacción en Dos Fases pendiente, devolviendo el valor on_hold al saldo available en la cuenta de origen. |
| Revert | revert | Crea una transacción inversa que deshace la operación original. |
Estructura del asiento contable
Cada entrada de acción contiene una rúbrica de débito y/o crédito, dependiendo del tipo de operación:- Las rutas Source requieren la rúbrica de débito.
- Las rutas Destination requieren la rúbrica de crédito.
- Las rutas Bidirectional requieren ambas rúbricas de débito y crédito.
- code — El código del plan de cuentas (ej.,
1.1.1.001). - description — Una descripción legible del asiento (ej.,
Customer checking — outbound).
Comportamiento de validación
Cuando la validación de rutas está habilitada para un Ledger y los asientos contables están configurados:- Solo se permiten los eventos con asientos registrados. Si un cliente registra solo la acción
directen una ruta, cualquier intento de ejecutar una Transacción en Dos Fases (que requierehold) será rechazado automáticamente. - Las operaciones exitosas tendrán los detalles de la rúbrica registrados en los campos
routeCodeyrouteDescriptionde cada operación.
Ejemplo práctico: rechazo por acción faltante
Ejemplo práctico: rechazo por acción faltante
Escenario: Un cliente crea una Ruta de Operación con solo la acción
direct configurada.Si ese cliente intenta una Transacción en Dos Fases (enviando pending: true), la transacción es rechazada automáticamente porque no hay un asiento hold registrado.Esto asegura que sus reportes contables permanezcan consistentes — todas las etapas de una operación deben estar mapeadas antes de poder ser ejecutadas.Operaciones Continuas
5. Ejecutar Transacciones Validadas
Con su configuración de enrutamiento en su lugar, ahora puede enviar transacciones con confianza incluyendo el ID de la Ruta de Transacción previamente creada en su solicitud de transacción. Midaz validará automáticamente la transacción contra sus patrones de enrutamiento definidos, asegurando consistencia e integridad en todas las operaciones financieras. Para los ejemplos de Ruta de Transacción y Rutas de Operación previamente configurados, el sistema compone la siguiente estructura de validación:@user/wallet_123 coincida con la regla de tipo de cuenta user_wallet, y que @external/BRL coincida con el requisito de alias exacto, asegurando que la transacción siga sus patrones de enrutamiento configurados.
Campos de ruta en operaciones
Cuando la validación de rutas está habilitada y los asientos contables están configurados, cada operación procesada exitosamente incluirá dos campos adicionales poblados a partir de la rúbrica coincidente:- routeCode — El código del plan de cuentas de la rúbrica del asiento contable coincidente.
- routeDescription — La descripción de la rúbrica del asiento contable coincidente.
Gestión de Rutas de Operación y Transacción
Para configurar sus Rutas de Operación, use los siguientes endpoints:
- Crear una Ruta de Operación — Definir una nueva regla contable para sus operaciones.
- Listar Rutas de Operación — Ver todas las Rutas de Operación configuradas.
- Recuperar una Ruta de Operación — Obtener información detallada sobre una Ruta de Operación específica.
- Actualizar una Ruta de Operación — Modificar reglas contables existentes.
- Eliminar una Ruta de Operación — Eliminar una Ruta de Operación obsoleta o no utilizada.
- Crear una Ruta de Transacción — Definir nueva lógica de enrutamiento para conectar transacciones con operaciones contables.
- Listar Rutas de Transacción — Ver todas las Rutas de Transacción configuradas.
- Recuperar una Ruta de Transacción — Obtener detalles de una Ruta de Transacción específica.
- Actualizar una Ruta de Transacción — Modificar criterios de enrutamiento existentes.
- Eliminar una Ruta de Transacción — Eliminar rutas que ya no sean aplicables.

