Create an Outflow Transaction

curl --request POST \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/outflow \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "code": "OUTFLOW_2025_0007",
  "pending": false,
  "description": "Pix transfer from customer wallet to external bank account",
  "send": {
    "asset": "BRL",
    "value": "150.00",
    "source": {
      "from": [
        {
          "accountAlias": "@external/BRL",
          "amount": {
            "asset": "BRL",
            "value": "150.00"
          },
          "description": "Pix transfer to Banco do Brasil account",
          "balanceKey": "settlement",
          "metadata": {
            "payerDocument": "12345678901",
            "origin": "customer_wallet"
          }
        }
      ]
    }
  },
  "metadata": {
    "referenceId": "PIX-OUT-553921",
    "channel": "pix",
    "purpose": "customer_payment"
  }
}
'

{
  "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": {}
}

POST

organizations

{organization_id}

ledgers

{ledger_id}

transactions

outflow

Create an Outflow Transaction

curl --request POST \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions/outflow \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "code": "OUTFLOW_2025_0007",
  "pending": false,
  "description": "Pix transfer from customer wallet to external bank account",
  "send": {
    "asset": "BRL",
    "value": "150.00",
    "source": {
      "from": [
        {
          "accountAlias": "@external/BRL",
          "amount": {
            "asset": "BRL",
            "value": "150.00"
          },
          "description": "Pix transfer to Banco do Brasil account",
          "balanceKey": "settlement",
          "metadata": {
            "payerDocument": "12345678901",
            "origin": "customer_wallet"
          }
        }
      ]
    }
  },
  "metadata": {
    "referenceId": "PIX-OUT-553921",
    "channel": "pix",
    "purpose": "customer_payment"
  }
}
'

{
  "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": {}
}

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

send

object

required

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

Show child attributes

send.asset

string

required

The code that identifies the asset that will be sent.

send.value

string

required

The amount that will be sent. Important: Use a dot (.) as the decimal separator — commas are not accepted.

send.source

object

required

An object containing information about the source accounts.

Show child attributes

send.source.from

object[]

required

The list of accounts that will be used as source. Each entry in the array must include one of the following fields: amount, share, or remaining. If an entry includes more than one of these fields, an error will occur.

Minimum array length: 1

Show child attributes

send.source.from.accountAlias

string

required

The alias for the account used in the operation.

send.source.from.amount

object

required

An object containing information about the amount that will be used in the operation.

Show child attributes

send.source.from.amount.asset

string

required

The name of the asset used in the operation.

send.source.from.amount.value

string

required

The amount that will be sent. Important: Use a dot (.) as the decimal separator — commas are not accepted.

send.source.from.balanceKey

string

The unique identifier key for the account balance. If omitted, the default balance is used. Use a previously created key to route funds to a specific balance.

send.source.from.route

string

Specifies the Transaction Route associated with the transaction. Important: When Transaction Routing validation is enabled for your Ledger, this field becomes mandatory and must match an existing id from your configured Transaction Routes. However, when validation is disabled (default behavior), this field is optional and accepts any free-form string.

If different accounts are part of the operation, this object will contain the information about the percentage used for each account.

Show child attributes

The percentage that will be shared. Important: Use a dot (.) as the decimal separator — commas are not accepted.

The percentage of the percentage that will be shared. Important: Use a dot (.) as the decimal separator — commas are not accepted.

send.source.from.remaining

string

The remaining amount or percentage. Important: Use a dot (.) as the decimal separator — commas are not accepted.

send.source.from.description

string

A description for the transaction.

send.source.from.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'.

Show child attributes

send.source.from.metadata.{key}

string

chartOfAccountsGroupName

string

The chart of accounts group name which categorizes this transaction under a specific group.

code

string

Transaction code for reference.

Maximum string length: 100

pending

boolean

default:false

Indicates whether the transaction should follow a two-step process: authorization followed by execution. When set to true, the transaction is created in a pending state, reserving funds (on_hold) without immediately moving them. A subsequent commit is required to finalize the transfer.

description

string

A description for the transaction.

route

string

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

Show child attributes

metadata.{key}

string

Response

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

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.

route

string

Specifies the Transaction Route associated with the transaction.

status

object

The transaction status (pending, completed, reversed).

Show child attributes

status.code

string

Transaction status code.

status.description

string

Transaction status description.

amount

string

The sent amount.

assetCode

string

The name of the asset used in the operation.

chartOfAccountsGroupName

string

The name of the chart-of-accounts 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[]

Show child attributes

operations.id

string<uuid>

The unique identifier of the Operation.

operations.transactionId

string<uuid>

The unique identifier of the Transaction.

operations.organizationId

string<uuid>

The unique identifier of the Organization.

operations.ledgerId

string<uuid>

The unique identifier of the Ledger.

operations.accountId

string<uuid>

The unique identifier of the Account.

operations.accountAlias

string

The alias for the account used in the operation.

operations.balanceId

string

The unique identifier of the Balance.

operations.balanceKey

string

The key identifier of the Balance.

operations.description

string

A description for the operation.

operations.type

enum<string>

The type of the operation.

Available options:

CREDIT,

DEBIT,

ON_HOLD,

RELEASE

operations.assetCode

string

The code that identifies the sent asset.

operations.chartOfAccounts

string

The name of the Chart-of-Accounts that the operation belongs to.

operations.route

string

Specifies the Operation Route for each individual debit or credit operation.

operations.amount

object

An object containing information about the amount used in the operation.

Show child attributes

operations.amount.value

string

The amount that will be sent.

operations.balance

object

An object containing information about the balance before the operation.

Show child attributes

operations.balance.available

string

Previous available balance.

operations.balance.onHold

string

Amount on hold/reserved.

operations.balance.version

integer

Balance version, which is updated with each transaction.

operations.balanceAfter

object

An object containing information about the balance after the operation.

Show child attributes

operations.balanceAfter.available

string

Current available balance.

operations.balanceAfter.onHold

string

Amount on hold/reserved.

operations.balanceAfter.version

integer

Balance version, which is updated with each transaction.

operations.status

object

The transaction status (pending, completed, reversed).

Show child attributes

operations.status.code

string

Transaction status code.

operations.status.description

string | null

Transaction status description.

operations.balanceAffected

boolean

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

operations.createdAt

string<date-time>

Timestamp of creation (UTC).

operations.updatedAt

string<date-time>

Timestamp of last update (UTC).

operations.deletedAt

string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).

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

Show child attributes

operations.metadata.{key}

string

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

Show child attributes

metadata.{key}

string

Create an Inflow Transaction

Commit a Pending Transaction

⌘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

Error handling

Create an Outflow Transaction

Headers

Path Parameters

Body

Response