Listar Transacciones

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

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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": {}
    }
  ],
  "next_cursor": "<string>",
  "limit": 123
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

transactions

Listar Transacciones

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

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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": {}
    }
  ],
  "next_cursor": "<string>",
  "limit": 123
}

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.

Query Parameters

limit

string

required

Número máximo de elementos que se incluirán en la respuesta.

metadata.message

string

required

Mensaje que se usará como metadato.

start_date

string

Inicio del período que deseas recuperar. Debes incluir también el parámetro end_date.

end_date

string

Fin del período que deseas recuperar. Debes incluir también el parámetro start_date.

sort_order

enum<enum>

Orden utilizado para clasificar los resultados.

Opciones disponibles:

asc,

desc

cursor

string

Posición dentro del conjunto de datos donde debe comenzar la siguiente página de resultados.

Response

Indica que la solicitud se realizó correctamente y la respuesta contiene los datos esperados.

items

object[]

Mostrar atributos secundarios

items.id

string<uuid>

Identificador único de la transacción.

items.organizationId

string<uuid>

Identificador único de la organización.

items.ledgerId

string<uuid>

Identificador único del ledger.

items.description

string

Descripción de la transacción.

items.route

string

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

items.status

object

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

Mostrar atributos secundarios

items.status.code

string

Código del estado de la transacción.

items.status.description

string

Descripción del estado de la transacción.

items.amount

string

Monto enviado.

items.assetCode

string

Nombre del activo utilizado en la operación.

items.chartOfAccountsGroupName

string

Nombre del grupo del plan de cuentas.

items.source

string[]

Lista de cuentas usadas como origen.

items.destination

string[]

Lista de cuentas usadas como destino.

items.createdAt

string<date-time>

Marca de tiempo de creación (UTC).

items.updatedAt

string<date-time>

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

items.deletedAt

string<date-time> | null

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

items.operations

object[]

Mostrar atributos secundarios

items.operations.id

string<uuid>

Identificador único de la operación.

items.operations.transactionId

string<uuid>

Identificador único de la transacción.

items.operations.organizationId

string<uuid>

Identificador único de la organización.

items.operations.ledgerId

string<uuid>

Identificador único del ledger.

items.operations.accountId

string<uuid>

Identificador único de la cuenta.

items.operations.accountAlias

string

Alias de la cuenta usado en la operación.

items.operations.balanceId

string

Identificador único del saldo.

items.operations.balanceKey

string

Clave que identifica el saldo.

items.operations.description

string

Descripción de la operación.

items.operations.type

enum<string>

Tipo de la operación.

Opciones disponibles:

CREDIT,

DEBIT,

ON_HOLD,

RELEASE

items.operations.assetCode

string

Código que identifica el activo enviado.

items.operations.route

string

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

items.operations.amount

object

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

Mostrar atributos secundarios

items.operations.amount.value

string

Monto que se enviará.

items.operations.balance

object

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

Mostrar atributos secundarios

items.operations.balance.available

string

Saldo disponible previo.

items.operations.balance.onHold

string

Monto retenido/reservado.

items.operations.balance.version

integer

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

items.operations.balanceAfter

object

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

Mostrar atributos secundarios

items.operations.balanceAfter.available

string

Current available balance.

items.operations.balanceAfter.onHold

string

Monto retenido/reservado.

items.operations.balanceAfter.version

integer

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

items.operations.status

object

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

Mostrar atributos secundarios

items.operations.status.code

string

Código del estado de la transacción.

items.operations.status.description

string | null

Descripción del estado de la transacción.

items.operations.balanceAffected

boolean

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

items.operations.createdAt

string<date-time>

Marca de tiempo de creación (UTC).

items.operations.updatedAt

string<date-time>

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

items.operations.deletedAt

string<date-time> | null

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

items.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

items.operations.metadata.{key}

string

items.metadata

object

Mostrar atributos secundarios

items.metadata.{key}

string

next_cursor

string

Posición dentro del conjunto de datos de la siguiente página de resultados.

limit

integer

Número máximo de elementos incluidos en la respuesta.

Crear una Transacción con DSL

Obtener una Transacción

⌘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

Listar Transacciones

Headers

Path Parameters

Query Parameters

Response