Create a ledger
Overview
Everything in Blnk begins with a ledger and this guide shows you how to create and view a ledger in your Blnk server.
Before you start
Make sure you have read and understood how the Blnk Ledger works. If you are confused or have any questions, please join our Discord channel and share your questions in a relevant channel.
Create a ledger
Decide a name for the ledger
Send a request to the create-ledger endpoint with the following fields:
| Field | Description | Required | Type |
|---|---|---|---|
name | A name that best describes the function of the ledger | Yes | string |
meta_data | Custom data associated with the ledger being created | No | object |
Your ledger gets created
Once your ledger has been created, you can move on to create a balance connected to the ledger.
{
"ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"name": "Customer Wallets Ledger",
"created_at": "2024-02-20 05:28:03 UTC",
"meta_data":{
"project_owner": "Blnk Tech"
}
}
| Field | Description | Type |
|---|---|---|
ledger_id | Unique identification number for your ledger | string |
name | The name of your ledger | string |
created_at | Date and time of when it was created | string |
View your ledger
To view details of a ledger in your Blnk server this, call the Get Ledgers endpoint URL — /ledgers/[ledger_id]. Provide the ledger_id to see the details of a specific ledger.
See also → Search your Blnk data.
Need help?
Are you stuck? Do you have a question that isn’t answered in this doc? Have you run into a problem you can’t solve? Want to file a bug report?
Join our Discord server and share your questions/thoughts with other developers building financial applications like you.
Was this page helpful?