blnk balances
command to create and manage balances in your Blnk server.
Ensure that your Blnk server is running and connected to the CLI to use this command.
1. Create new balance
To create a new balance:Shell
Output
Field | Description |
---|---|
<ledger-id> | The unique id of the ledger that this balance belongs to. |
<currency> | The currency in which transactions recorded in this balance will be recorded. |
<metadata> | Custom info written in JSON format, e.g. {"first_name":"Sandra", "last_name":"Baileys"} . If you have no metadata, you can leave it blank like this: {} |
2. View balances
To view all of the balances in your server:Shell
3. Search balances
Search is used to query and find data in your Blnk server. To search your balances with the Blnk CLI, you can use the following options with theblnk balances list
command.
Options | Description |
---|---|
-p or --page <number> | Page number (default: “1”) |
--per-page <number> | Results per page (default: “10”) |
-s or --search <term> | What you are searching for (default: ”*“) |
-q or --query-by <fields> | Fields to query your search term by (default: “currency, balance_id”) |
Shell
Read our Search docs to learn more about Search.