Revertir una Transacción

curl --request POST \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/revert

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentTransactionId": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "route": "<string>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "amount": "<string>",
  "assetCode": "<string>",
  "chartOfAccountsGroupName": "<string>",
  "source": [
    "<string>"
  ],
  "destination": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "operations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountAlias": "<string>",
      "balanceId": "<string>",
      "balanceKey": "<string>",
      "description": "<string>",
      "type": "CREDIT",
      "assetCode": "<string>",
      "route": "<string>",
      "amount": {
        "value": "<string>"
      },
      "balance": {
        "available": "<string>",
        "onHold": "<string>",
        "version": 123
      },
      "balanceAfter": {
        "available": "<string>",
        "onHold": "<string>",
        "version": 123
      },
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "balanceAffected": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "metadata": {}
}

Revertir una Transacción

Utiliza este endpoint para revertir una transacción existente generando automáticamente una nueva en la dirección opuesta a la original. La nueva transacción se vincula a la original mediante el campo parentTransactionId, garantizando la trazabilidad completa entre ambas operaciones.

Importante: Solo las transacciones con estado APPROVED pueden ser revertidas. Si la transacción original ya tiene un padre (es decir, ya fue revertida) la solicitud será rechazada. En caso de éxito, este endpoint crea la transacción de reversión y devuelve 201 Created con la carga útil de la transacción creada.

POST

organizations

{organization_id}

ledgers

{ledger_id}

transactions

{transaction_id}

revert

Revertir una Transacción

curl --request POST \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/{transaction_id}/revert

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "parentTransactionId": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "route": "<string>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "amount": "<string>",
  "assetCode": "<string>",
  "chartOfAccountsGroupName": "<string>",
  "source": [
    "<string>"
  ],
  "destination": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "operations": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "accountAlias": "<string>",
      "balanceId": "<string>",
      "balanceKey": "<string>",
      "description": "<string>",
      "type": "CREDIT",
      "assetCode": "<string>",
      "route": "<string>",
      "amount": {
        "value": "<string>"
      },
      "balance": {
        "available": "<string>",
        "onHold": "<string>",
        "version": 123
      },
      "balanceAfter": {
        "available": "<string>",
        "onHold": "<string>",
        "version": 123
      },
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "balanceAffected": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "metadata": {}
}

Headers

Authorization

string

Token de autorización. Este encabezado es obligatorio si tu entorno tiene habilitado el Access Manager.

X-Request-Id

string

Identificador único usado para rastrear cada solicitud.

Path Parameters

organization_id

string

required

Identificador único de la organización asociada al ledger.

ledger_id

string

required

Identificador único del ledger asociado.

transaction_id

string

required

Identificador único de la transacción que deseas consultar.

Response

Indica que el recurso se creó correctamente y que la operación se completó según lo esperado.

string<uuid>

Identificador único de la transacción.

parentTransactionId

string

Identificador único de la transacción padre/original para reversiones. Este campo es poblado por el servidor cuando una transacción es revertida y debe ser tratado como solo lectura por los clientes.

organizationId

string<uuid>

Identificador único de la organización.

ledgerId

string<uuid>

Identificador único del ledger.

description

string

Descripción de la transacción.

route

string

Especifica la ruta de transacción asociada con la transacción.

status

object

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

Mostrar atributos secundarios

status.code

string

Código de estado de la transacción.

status.description

string

Descripción del estado de la transacción.

amount

string

Monto enviado.

assetCode

string

Nombre del activo utilizado en la operación.

chartOfAccountsGroupName

string

Nombre del grupo del plan de cuentas.

source

string[]

Lista de cuentas utilizadas como origen.

destination

string[]

Lista de cuentas utilizadas como destino.

createdAt

string<date-time>

Marca de tiempo de creación (UTC).

updatedAt

string<date-time>

Marca de tiempo de la última actualización (UTC).

deletedAt

string<date-time> | null

Marca de tiempo de eliminación lógica, si aplica (UTC).

operations

object[]

Mostrar atributos secundarios

operations.id

string<uuid>

Identificador único de la operación.

operations.transactionId

string<uuid>

Identificador único de la transacción.

operations.organizationId

string<uuid>

Identificador único de la organización.

operations.ledgerId

string<uuid>

Identificador único del ledger.

operations.accountId

string<uuid>

Identificador único de la cuenta.

operations.accountAlias

string

Alias de la cuenta usado en la operación.

operations.balanceId

string

Identificador único del saldo.

operations.balanceKey

string

Clave que identifica el saldo.

operations.description

string

Descripción de la operación.

operations.type

enum<string>

Tipo de la operación.

Opciones disponibles:

CREDIT,

DEBIT,

ON_HOLD,

RELEASE

operations.assetCode

string

Código que identifica el activo enviado.

operations.route

string

Especifica la ruta de operación para cada operación individual de débito o crédito.

operations.amount

object

Objeto que contiene información sobre el monto utilizado en la operación.

Mostrar atributos secundarios

operations.amount.value

string

Monto que se enviará.

operations.balance

object

Objeto que contiene información sobre el saldo antes de la operación.

Mostrar atributos secundarios

operations.balance.available

string

Saldo disponible previo.

operations.balance.onHold

string

Monto retenido/reservado.

operations.balance.version

integer

Versión de saldo, que se actualiza con cada transacción.

operations.balanceAfter

object

Objeto que contiene información sobre el saldo después de la operación.

Mostrar atributos secundarios

operations.balanceAfter.available

string

Current available balance.

operations.balanceAfter.onHold

string

Monto retenido/reservado.

operations.balanceAfter.version

integer

Versión de saldo, que se actualiza con cada transacción.

operations.status

object

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

Mostrar atributos secundarios

operations.status.code

string

Código del estado de la transacción.

operations.status.description

string | null

Descripción del estado de la transacción.

operations.balanceAffected

boolean

Indicates whether the operation had an impact on the account balance.

operations.createdAt

string<date-time>

Marca de tiempo de creación (UTC).

operations.updatedAt

string<date-time>

Marca de tiempo de la última actualización (UTC).

operations.deletedAt

string<date-time> | null

Marca de tiempo de la eliminación lógica, si aplica (UTC).

operations.metadata

object

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 costos, usa 'costCenter': 'BR_11101997'.

Mostrar atributos secundarios

operations.metadata.{key}

string

metadata

object

Mostrar atributos secundarios

metadata.{key}

string

Actualizar una Transacción

Crear una Transacción de Entrada

⌘I

Organizations API

Ledgers API

Assets API

Account Types API

Accounts API

Portfolios API

Segments API

Balances API

Transactions API

Operations API

Operation Routes API

Transaction Routes API

Manejo de errores

Revertir una Transacción

Headers

Path Parameters

Response