Saltar al contenido principal
POST
Revertir una Transacción

Encabezados

X-Request-Id
string<uuid>

Un identificador único utilizado para rastrear y seguir cada solicitud.

Authorization
string

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>

X-Idempotency
string

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.

X-TTL
integer

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

organization_id
string<uuid>
requerido

El identificador único de la Organización asociada al Ledger.

ledger_id
string<uuid>
requerido

El identificador único del Ledger asociado.

transaction_id
string<uuid>
requerido

El identificador único de la transacción que desea recuperar.

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.

id
string<uuid>

El identificador único de la transacción.

parentTransactionId
string

El identificador único de la transacción matriz/original para reversiones. Este campo es completado por el servidor cuando se revierte una transacción y los clientes deben tratarlo como de solo lectura.

organizationId
string<uuid>

El identificador único de la Organización.

ledgerId
string<uuid>

El identificador único del Ledger.

description
string

Descripción de la transacción.

route
string

Especifica la Ruta de Transacción asociada a la transacción.

status
object

El estado de la transacción (pendiente, completada, revertida).

amount
string

El monto enviado.

assetCode
string

El nombre del activo utilizado en la operación.

chartOfAccountsGroupName
string

El nombre del grupo del plan de cuentas.

source
string[]

La lista de cuentas utilizadas como origen.

destination
string[]

La lista de cuentas utilizadas como destino.

createdAt
string<date-time>

Fecha y hora de creación (UTC).

updatedAt
string<date-time>

Fecha y hora de la última actualización (UTC).

deletedAt
string<date-time> | null

Fecha y hora de la eliminación lógica, si aplica (UTC).

operations
object[]
metadata
object

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.