Pular para o conteúdo principal
POST
/
v1
/
organizations
/
{organization_id}
/
ledgers
/
{ledger_id}
/
transactions
/
annotation
Create a Transaction Annotation
curl --request POST \
  --url https://ledger.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/annotation \
  --header 'Authorization: Bearer <token>' \
  --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": "Customer wallet debit",
          "metadata": {
            "payerDocument": "12345678901",
            "channel": "app"
          }
        }
      ]
    },
    "distribute": {
      "to": [
        {
          "accountAlias": "@customer_brl_wallet",
          "balanceKey": "settlement",
          "amount": {
            "asset": "BRL",
            "value": "250.00"
          },
          "description": "Merchant settlement",
          "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>",
      "chartOfAccounts": "<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": {}
}

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Cabeçalhos

Authorization
string

O token de autorização. Este cabeçalho é obrigatório se o seu ambiente tiver o Access Manager habilitado.

Content-Type
string
obrigatório

O tipo de mídia do recurso. Deve ser application/json.

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

X-Idempotency
string

Uma chave única que garante a idempotência da transação. Se não fornecida, o sistema gera automaticamente um hash com base nos dados da transação.

X-TTL
integer

O tempo de vida (TTL) da chave, definido em segundos.

Parâmetros de caminho

organization_id
string
obrigatório

O identificador único da Organização associada ao Ledger.

ledger_id
string
obrigatório

O identificador único do Ledger associado.

Corpo

application/json
send
object
obrigatório

Um objeto contendo informações sobre a transação que será enviada.

description
string

Uma descrição para a transação.

Maximum string length: 256
route
string

Especifica a Rota de Transação associada à transação. Importante: Quando a validação de Rota de Transação está habilitada para o seu Ledger, este campo se torna obrigatório e deve corresponder a um id existente das suas Rotas de Transação configuradas. No entanto, quando a validação está desabilitada (comportamento padrão), este campo é opcional e aceita qualquer string de formato livre.

transactionDate
string

A data em que a transação foi realizada. Usado para adicionar transações passadas. Deve ser uma data no passado.

metadata
object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

id
string<uuid>

O identificador único da transação.

organizationId
string<uuid>

O identificador único da Organização.

ledgerId
string<uuid>

O identificador único do Ledger.

description
string

Descrição da transação.

route
string

Especifica a Rota de Transação associada à transação.

status
object

O status da transação (pendente, concluída, revertida).

amount
string

O valor enviado.

assetCode
string

O nome do ativo utilizado na operação.

chartOfAccountsGroupName
string

O nome do grupo do plano de contas.

source
string[]

A lista de contas utilizadas como origem.

destination
string[]

A lista de contas utilizadas como destino.

createdAt
string<date-time>

Data e hora de criação (UTC).

updatedAt
string<date-time>

Data e hora da última atualização (UTC).

deletedAt
string<date-time> | null

Data e hora da exclusão lógica, se aplicável (UTC).

operations
object[]
metadata
object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.