Skip to main content
Create an Inflow Transaction
curl --request POST \
  --url http://127.0.0.1:3001/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/inflow \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "chartOfAccountsGroupName": "clients",
  "description": "Incoming transfer of BRL 100.00 for client funds allocation",
  "metadata": {
    "purpose": "client_deposit",
    "amount": "100.00",
    "referenceId": "TXN-2025-000789"
  },
  "send": {
    "asset": "BRL",
    "value": 100,
    "scale": 1,
    "distribute": {
      "to": [
        {
          "account": "@customer_brl_wallet",
          "amount": {
            "asset": "BRL",
            "value": 100,
            "scale": 1
          },
          "metadata": {
            "note": "Deposit allocated to client portfolio"
          }
        }
      ]
    }
  }
}
'
{
  "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

The authorization token. This header is required if your environment has the Access Manager enabled.

​
Content-Type
string
required

The type of media of the resource. Must be application/json.

​
X-Request-Id
string

A unique identifier used to trace and track each request.

​
X-Idempotency
string

A unique key that ensures transaction idempotency. If not provided, the system automatically generates a hash based on the transaction data.

​
X-TTL
integer

The time-to-live for the key, defined in seconds.

Path Parameters

​
organization_id
string
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
required

The unique identifier of the associated Ledger.

Body

application/json
​
description
string
required

A description for the transaction.

​
send
object
required

An object containing information about the transaction that will be sent.

​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Response

Indicates that the resource was successfully created and the operation was completed as expected.

​
id
string<uuid>

The unique identifier of the transaction.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

The unique identifier of the Ledger.

​
description
string

Description of the transaction.

​
template
string

The unique identifier of the template if the transaction is templated.

​
status
object

The transaction status (pending, completed, reversed).

​
amount
integer

The sent amount.

​
amountScale
integer

The number of decimal points used to display the amount.

​
assetCode
string

The name of the asset used in the operation.

​
chartOfAccountsGroupName
string

The name of the group used to categorize the operations of a transaction under the same group.

​
source
string[]

The list of accounts used as source.

​
destination
string[]

The list of accounts used as destination.

​
createdAt
string<date-time>

Timestamp of creation (UTC).

​
updatedAt
string<date-time>

Timestamp of last update (UTC).

​
deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).

​
operations
object[]
​
metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.