Crear una Anotación de Transacción
Utilice este endpoint para crear una transacción sin impacto financiero, para incluir operaciones en el ledger, pero sin afectar los saldos de las cuentas.
Autorizaciones
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Encabezados
El token de autorización. Este encabezado es requerido si su entorno tiene Access Manager habilitado.
El tipo de medio del recurso. El valor recomendado es application/json.
Un identificador único utilizado para rastrear y seguir cada solicitud.
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
An object containing information about the transaction that will be sent.
The chart of accounts group name which categorizes this transaction under a specific group.
256"FUNDING"
A description for the transaction.
256Transaction code for reference.
100"TR12345"
Whether the transaction should be created in pending state.
Specifies the Transaction Route associated with the transaction. Important: When Transaction Routing validation is enabled for your Ledger, this field becomes mandatory and must match an existing id from your configured Transaction Routes. However, when validation is disabled (default behavior), this field is optional and accepts any free-form string.
The time when the transaction was made. Used to add past transactions. Must be a date in the past.
An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.
Respuesta
Indica que la solicitud fue exitosa y la respuesta contiene los datos esperados.
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.
The unique identifier of the transaction.
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.
The unique identifier of the Organization.
El identificador único del Ledger.
Description of the transaction.
Specifies the Transaction Route associated with the transaction.
The transaction status (pending, completed, reversed).
The sent amount.
The name of the asset used in the operation.
The name of the chart-of-accounts group.
The list of accounts used as source.
The list of accounts used as destination.
Timestamp of creation (UTC).
Timestamp of last update (UTC).
Timestamp of soft deletion, if applicable (UTC).
An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.