Crear una Transacción de Bloqueo
Utilice este endpoint para crear una transacción cuyas operaciones resultantes son del tipo BLOCK. Midaz es agnóstico respecto al motivo de negocio para bloquear fondos: utilice el campo metadata para registrarlo.
Este endpoint siempre crea una transacción confirmada de inmediato y no pendiente: el campo pending del cuerpo de la solicitud se ignora (se sobrescribe a false); las transacciones de bloqueo nunca están pendientes. El endpoint acepta el mismo cuerpo que el endpoint de creación JSON.
Encabezados
El tipo de medio del recurso. El valor recomendado es application/json.
Un identificador único utilizado para rastrear y seguir cada solicitud.
Token JWT bearer para autenticación.
Requerido cuando PLUGIN_AUTH_ENABLED=true (obligatorio en despliegues multiinquilino).
Opcional en el modo OSS de inquilino único predeterminado.
Formato: Bearer <token>
Una clave única que garantiza la idempotencia de la transacción. Si no se proporciona, el sistema genera automáticamente un hash SHA-256 basado en el cuerpo de la solicitud. Las claves están delimitadas por organización y ledger.
Siempre valide el header de respuesta X-Idempotency-Replayed para distinguir transacciones nuevas de reproducciones en caché.
Consulte Reintentos e idempotencia para mejores prácticas.
El tiempo de vida (TTL) de la clave de idempotencia, definido en segundos. Si no se proporciona, el valor predeterminado es 300 segundos (5 minutos). Solo se usa el TTL de la primera solicitud; cambiarlo en reintentos no tiene efecto.
Consulte Reintentos e idempotencia para más detalles.
Parámetros de ruta
El identificador único de la Organización asociada al Ledger.
El identificador único del Ledger asociado.
Cuerpo
El nombre del grupo del plan de cuentas asociado a la transacción.
256Una descripción para la transacción.
256Indica si la transacción debe seguir un proceso de dos pasos: autorización seguida de ejecución. Cuando se establece en true, la transacción se crea en estado pendiente, reservando fondos (on_hold) sin moverlos de inmediato. Se requiere una confirmación posterior para finalizar la transferencia.
Código de transacción para referencia.
100Obsoleto. Use routeId en su lugar. Identificador heredado de la ruta mantenido por compatibilidad; se acepta pero no se utiliza en la validación de enrutamiento.
El identificador único (UUID) de la Ruta de Transacción asociada a esta transacción.
Importante: Cuando la validación de Enrutamiento de Transacciones está habilitada para su Ledger, este campo se vuelve obligatorio y debe coincidir con un id existente de sus Rutas de Transacción configuradas. Sin embargo, cuando la validación está deshabilitada (comportamiento predeterminado), este campo es opcional.
La fecha y hora en que se realizó la transacción. Se utiliza para agregar transacciones pasadas. Debe ser una fecha en el pasado.
Un objeto que contiene información sobre la transacción que se enviará.
Un objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un Centro de Costo, use 'costCenter': 'BR_11101997'.
Restricciones: las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves.
Respuesta
Indica que el recurso fue creado exitosamente y la operación se completó como se esperaba.
La respuesta incluye el header X-Idempotency-Replayed.
Si el valor es false, la transacción fue recién procesada. Si el valor es true, la respuesta es una repetición de una solicitud procesada anteriormente.
Consulte Reintentos e idempotencia para más detalles.
El identificador único de la transacción.
El identificador único de la transacción padre/original para reversiones. Este campo es completado por el servidor cuando una transacción es revertida y debe ser tratado como solo lectura por los clientes.
El identificador único de la Organización.
El identificador único del Ledger.
Descripción de la transacción.
Especifica la Ruta de Transacción asociada a la transacción.
El identificador único de la Ruta de Transacción aplicada a esta transacción.
El estado de la transacción (pendiente, completada, revertida).
El monto enviado.
El nombre del activo utilizado en la operación.
El nombre del grupo del plan de cuentas.
La lista de cuentas utilizadas como origen.
La lista de cuentas utilizadas como destino.
Fecha y hora de creación (UTC).
Fecha y hora de la última actualización (UTC).
Fecha y hora de la eliminación lógica, si aplica (UTC).
Un objeto que contiene pares clave-valor para agregar como metadatos, donde el campo name es la clave y el campo value es el valor. Por ejemplo, para agregar un Centro de Costo, use 'costCenter': 'BR_11101997'.
Restricciones: las claves deben tener como máximo 100 caracteres; los valores de cadena de texto, como máximo 2000 caracteres. No se permiten objetos anidados (los valores deben ser cadena de texto, número o booleano), la estructura no puede exceder una profundidad máxima de 10, y se permite un máximo de 100 claves.