balances command to list monetary accounts, inspect one balance by ID, create balances on a ledger, and link balances to identities. Balances hold currency positions and appear as sources or destinations on transactions.
| Command | Alias | Description |
|---|---|---|
| list | l | Browse balances in a table; add --id for one record |
| create | c | Open a balance on a ledger via interactive prompts |
| update | u | Link an existing balance to an identity |
list
Browse balances across your ledgers in a paginated table with amounts, credit/debit totals, and inflight columns.
Use --{field} filters (for example --currency) to narrow results before you fetch one record with list --id.
| Option | Type | Default | Description |
|---|---|---|---|
--{field} | string | — | Filter by any indexed field (for example --currency "USD,EUR"). |
-p, --page | integer | 1 | Page number. |
--per-page | integer | 10 | Results per page. |
-h, --help | boolean | — | Show help for this command. |
list --id
Look up one balance by balance_id and print a readable summary of ledger link, identity, and balance breakdowns.
Pass --json when you need the full API object for scripts or support tickets.
| Option | Type | Required | Description |
|---|---|---|---|
--id | string | Yes | Balance ID to fetch (for example bln_01dab2b7-3ec7-4253-b302-edd947423883). |
--json | boolean | No | Print the full API object as JSON instead of a formatted summary. |
-h, --help | boolean | No | Show help for this command. |
create
Open a new balance on a ledger through prompts for currency, ledger ID, and optional identity.
Every balance belongs to exactly one ledger; you can link an identity now or later with update.
| Argument | Type | Required | Description |
|---|---|---|---|
currency | string | Yes | Balance currency. Prompt: currency > |
ledger_id | string | Yes | Ledger ID for the balance. Prompt: ledger id > |
identity_id | string | No | Optional identity to link. Prompt: identity id >. Press Enter to skip. |
meta_data | object | No | Optional metadata as JSON. Prompt: metadata (json) >. Press Enter to skip. |
| Option | Type | Description |
|---|---|---|
--json | boolean | After a successful create, print the full API response as JSON. |
-h, --help | boolean | Show help for this command. |
Create new balance
Run the command:The CLI prompts for each argument:Press Enter at optional prompts to skip.
update
Attach an identity to a balance that was created without one (or change the linked identity).
Pass the balance ID on the command line; the CLI prompts for the identity_id to store on the record.
| Argument | Type | Required | Description |
|---|---|---|---|
balance-id | string | Yes | Balance ID to update (for example bln_01dab2b7-3ec7-4253-b302-edd947423883). Passed on the command line. |
identity_id | string | Yes | Identity ID to link. |
| Option | Type | Description |
|---|---|---|
-h, --help | boolean | Show help for this command. |