- 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 Libro Contable para Validación de Ruta de Transacción
Para activar la validación de ruta de transacción para un libro contable específico, debe configurarlo en el servicio de Transacción. Esto significa actualizar las variables de Transacción en el archivo.env
del servicio Midaz Transaction donde desea usar la validación de ruta.
Su configuración debería verse así:
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:
source
odestination
indicando el flujo direccional de la operación. - 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 (
- Apuntar a Cuenta Específica
- Apuntar a Tipo de Cuenta
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.Operaciones Continuas
4. 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.
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.