Saltar al contenido principal
Crear una Transacción con JSON
curl --request POST \
  --url http://127.0.0.1:3001/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/json \
  --header 'Content-Type: <content-type>' \
  --data '{
  "chartOfAccountsGroupName": "customer_payments",
  "description": "Transferencia de 100,00 BRL desde una fuente externa a la billetera del usuario",
  "metadata": {
    "note": "Pago del cliente a través de Pix",
    "referenceId": "PAY-2025-000123"
  },
  "send": {
    "asset": "BRL",
    "value": 100,
    "scale": 1,
    "source": {
      "from": [
        {
          "account": "@external/BRL",
          "amount": {
            "asset": "BRL",
            "value": 100,
            "scale": 1
          },
          "description": "Fondos entrantes del sistema bancario externo",
          "metadata": {
            "sourceType": "bank_transfer",
            "payerDocument": "12345678901"
          }
        }
      ]
    }
  },
  "distribute": {
    "to": [
      {
        "account": "@customer_brl_wallet",
        "amount": {
          "asset": "BRL",
          "value": 100,
          "scale": 1
        },
        "metadata": {
          "recipientNote": "Credit to user wallet",
          "internalReference": "TXN-987654"
        }
      }
    ]
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "template": "<string>",
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "amount": 123,
  "amountScale": 123,
  "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",
      "balanceId": "<string>",
      "accountAlias": "<string>",
      "description": "<string>",
      "type": "CREDIT",
      "assetCode": "<string>",
      "chartOfAccounts": "<string>",
      "amount": {
        "amount": 123,
        "scale": 123
      },
      "balance": {
        "available": 123,
        "onHold": 123,
        "scale": 123
      },
      "balanceAfter": {
        "available": 123,
        "onHold": 123,
        "scale": 123
      },
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "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 <code>application/json</code>.

​
X-Request-Id
string

Identificador único utilizado para rastrear cada solicitud.

​
X-Idempotency
string

Clave única que garantiza la idempotencia de la transacción. Si no se proporciona, el sistema genera automáticamente un hash con 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 con el libro contable.

​
ledger_id
string
required

Identificador único del libro contable asociado.

Body

application/json
​
chartOfAccountsGroupName
string
required

Nombre del grupo utilizado para categorizar las operaciones de una transacción bajo un mismo grupo.

​
description
string
required

Descripción de la transacción.

​
send
object
required

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

​
metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo <code>name</code> es la clave y el campo <code>value</code> es el valor. Por ejemplo, para agregar un centro de costos, usa 'costCenter': 'BR_11101997'.

Response

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

​
id
string<uuid>

Identificador único de la transacción.

​
organizationId
string<uuid>

Identificador único de la organización.

​
ledgerId
string<uuid>

Identificador único del libro contable.

​
description
string

Descripción de la transacción.

​
template
string

Identificador único de la plantilla si la transacción está basada en una plantilla.

​
status
object

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

​
amount
integer

Monto enviado.

​
amountScale
integer

Número de decimales utilizados para mostrar el monto.

​
assetCode
string

Nombre del activo utilizado en la operación.

​
chartOfAccountsGroupName
string

Nombre del grupo utilizado para categorizar las operaciones de una transacción bajo un mismo grupo.

​
source
string[]

Lista de cuentas utilizadas como origen.

​
destination
string[]

Lista de cuentas utilizadas como destino.

​
createdAt
string<date-time>

Marca temporal de creación (UTC).

​
updatedAt
string<date-time>

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

​
deletedAt
string<date-time> | null

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

​
operations
object[]
​
metadata
object

Objeto que contiene pares clave-valor para agregar como metadatos, donde el campo <code>name</code> es la clave y el campo <code>value</code> es el valor. Por ejemplo, para agregar un centro de costos, usa 'costCenter': 'BR_11101997'.