Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

A Transaction moves value between Accounts in a Ledger. Create one only after the Asset, source account, destination account, and any required Accounting Route are ready.

​
Before you start

Confirm that:
  • The source and destination Accounts exist in the selected Ledger.
  • Both Accounts use the Asset selected for the Transaction.
  • You know each Account alias, including the @ prefix.
  • Source accounts allow sending and destination accounts allow receiving.
  • If Validate Routes is enabled, the Transaction matches an existing Accounting Route.

​
Create the Transaction

1
From the Transactions page, click the New Transaction button.
2
The New Transaction modal will open. Select the type of transaction you want to create:
  • Simple 1:1 - Transactions using one source and one destination
  • Complex n:n - Transactions using more than one source or destination
3
After selecting the transaction type, the New Transaction page opens with a step-by-step form:
1

Transaction Data

Fill in the basic transaction information:
  • (Optional) Add a Description for the transaction
  • (Optional) Specify an Accounting route group for classification
  • Enter the Value (amount) to be transferred
  • Select the Asset that will be used in the transaction
2
Click Next to proceed to the accounts selection step.
3

Source and Destination

Specify the accounts involved:
  • Search for the source account by alias and select it
  • Search for the destination account by alias and select it
  • For complex transactions, you can add multiple sources and/or destinations
You must use the account alias to perform transactions. Make sure you save it when you create your account.If you forget your alias, you can find it by editing account information.
4
Click Next to proceed to the operations step.
5

Operations

Review and adjust the operation details:
  • For simple transactions (1:1), the amounts are automatically filled
  • For complex transactions (n:n), specify the amount for each source (debit) and destination (credit)
  • Expand each operation to add optional descriptions and metadata
For complex transactions, the sum of all source amounts must equal the sum of all destination amounts.
4
When all the information is correct, click the Go to Review button.
5
A review page will be displayed showing a summary of all the transaction information:
  • Transaction value and asset
  • Source and destination accounts
  • Individual debit and credit operations
  • Metadata records (if any)
6
Review the information carefully. If everything is correct:
  • Click Send Transaction to submit and view the transaction details
  • Click Send and Create another to submit and immediately start a new transaction
7
Upon success, you will be redirected to the transaction details page showing the transaction summary, data, and status.

​
Field guide

FieldWhat to enterExample
Transaction typeChoose Simple 1:1 for one source and one destination, or Complex n:n for multiple sources or destinations.Simple 1:1
DescriptionOptional business description of the movement.Customer payment to merchant
Accounting route groupOptional route classification when your setup uses route validation or grouping.Pix Transfer Route
ValueTotal amount to move. For complex transactions, source totals must equal destination totals.100.00
AssetAsset used by the Transaction. It must match the selected Accounts.BRL
Source accountAccount alias that will be debited. Include the @ prefix.@customer_123
Destination accountAccount alias that will be credited. Include the @ prefix.@merchant_456
Operation amountAmount assigned to each source or destination operation. Required in complex transactions.100.00
Metadata KeyOptional classification or integration field name.externalReference
Metadata ValueValue for the metadata key.order_98765

​
Transaction types explained

​
Simple Transaction (1:1)

Use for straightforward transfers between two accounts:
  • One source account (debit)
  • One destination account (credit)
  • Same amount debited and credited
Example: Transfer $100 from Customer A to Merchant B.

​
Complex Transaction (n:n)

Use for transactions involving multiple parties:
  • Multiple source accounts (debits) and/or multiple destination accounts (credits)
  • Amounts can be distributed across accounts
  • Total debits must equal total credits
Examples:
  • Payment with fees:
    • Customer pays $103
    • Merchant receives $100
    • Fee account receives $3
  • Consolidated payment: Multiple customers fund a single vendor payment
The fields in the Metadata tab are open. There are no predefined keys or values. Use consistent key names across your Organization, such as externalReference, orderId, or channel, to link Transactions back to source systems for reconciliation and audit.

​
What to do next

After sending the Transaction, review the details page and confirm the status, source operation, destination operation, and account balances.

Create a Transaction using JSON

Create a Transaction programmatically with the JSON endpoint.

Retrieve a Transaction

Inspect the Transaction status and operations via API.