Saltar al contenido principal
POST
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
transactions
/
annotation
Crear una Anotación de Transacción
curl --request POST \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/annotation \
  --header 'Content-Type: <content-type>' \
  --data '{
  "description": "Pix payout to external merchant with fee allocation",
  "transactionDate": "2025-03-15T14:22:00Z",
  "send": {
    "asset": "BRL",
    "value": "250.00",
    "source": {
      "from": [
        {
          "accountAlias": "@external/BRL",
          "balanceKey": "settlement",
          "amount": {
            "asset": "BRL",
            "value": "250.00"
          },
          "description": "Débito de la cartera del cliente",
          "metadata": {
            "payerDocument": "12345678901",
            "channel": "app"
          }
        }
      ]
    },
    "distribute": {
      "to": [
        {
          "accountAlias": "@customer_brl_wallet",
          "balanceKey": "settlement",
          "amount": {
            "asset": "BRL",
            "value": "250.00"
          },
          "description": "Liquidación mercantil",
          "metadata": {
            "orderId": "ORD-2025-0315-98765",
            "conciliationId": "CN-PIX-000123"
          }
        }
      ]
    }
  },
  "metadata": {
    "correlationId": "c6a2f1b0-1e3a-4771-9d7a-0d9f2a7a5e42",
    "e2eId": "E2E-7f2b1a3c9e5d4a0fb1",
    "initiatedBy": "system",
    "environment": "production"
  }
}'
{
  "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": {}
}

Headers

​
Authorization
string

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

​
Content-Type
string
required

Tipo de medio del recurso. Debe ser application/json.

​
X-Request-Id
string

Identificador único usado para rastrear cada solicitud.

​
X-Idempotency
string

Clave única que garantiza la idempotencia de la transacción. Si no se envía, el sistema genera automáticamente un hash basado en los datos de la transacción.

​
X-TTL
integer

Tiempo de vida de la clave, definido en segundos.

Path Parameters

​
organization_id
string
required

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

​
ledger_id
string
required

Identificador único del ledger asociado.

Body

application/json
​
send
object
required

Objeto que contiene información sobre la transacción que se enviará.

​
description
string

Descripción de la transacción.

Maximum length: 256
​
route
string

Especifica la ruta de transacción asociada a la transacción. Importante: cuando la validación de enrutamiento de transacciones está habilitada para tu ledger, este campo se vuelve obligatorio y debe coincidir con un id existente en tus rutas de transacción configuradas. Sin embargo, cuando la validación está deshabilitada (comportamiento predeterminado), este campo es opcional y acepta cualquier cadena libre.

​
transactionDate
string

Momento en que se realizó la transacción. Se usa para añadir transacciones anteriores. Debe ser una fecha en el pasado.

​
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'.

Response

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

​
id
string<uuid>

Identificador único de la transacción.

​
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 a la transacción.

​
status
object

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

​
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 usadas como origen.

​
destination
string[]

Lista de cuentas usadas 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 la eliminación lógica, si aplica (UTC).

​
operations
object[]
​
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'.