Internal balances
Learn how to create and use internal balances for your organization.
In your application, there are scenarios when your balances interact with your organization accounts or external balances. As a principle, it is crucial for you to have an organized way of tracking these interactions in your ledger.
This is why Blnk creates the General Ledger. The main difference between the general ledger and other ledgers is that it is meant to group balances owned by your organization. We refer to these balances as “Internal balances.”
The General Ledger is created by default when you deploy your Blnk server.
Let’s dive in ✨
What we’ll cover …
- What are internal balances?
- Creating an internal balance
- Naming conventions
- Representing external accounts
1. What are internal balances?
An internal balance is a ledger balance owned by your organization, e.g., revenue, fees, loans, etc. You can use an internal balance to track interactions between your own accounts as an organization and your customers accounts managed by your application.
For instance, you own an online e-commerce app that assigns a wallet to every signed up user. Two things happen:
- Every time a user pays for something on your app with their wallet, their balance is debited and you earn revenue.
- Every time a user funds their wallet, a fee is debited from the user’s wallet and paid somewhere (the e-commerce startup or the payment processor).
There are two destinations that have not been defined — revenue and fees. These have to be represented as balances held and managed by the organization.
To do this, you need to create these balances in the General Ledger and provide them as the destination in your transaction record request to complete the transaction workflow.
2. Creating an internal balance
Blnk makes this simple by automating the creation and identification of balances in the General Ledger. When a transaction is recorded and a balance is referenced using the ”@” prefix, Blnk checks to see if it exists in the General Ledger.
If the specified balance doesn’t exist, it is automatically created, and the transaction is processed accordingly.
Continuing our earlier example, we can represent revenue with @Revenue
and fees with @Fees
. A transaction request from the user’s wallet when they pay for something on the app would look like this:
When you post a transaction to a new internal balance, the balance is created with the same asset class specified in the transaction, e.g., in the example above, @Revenue
is a USD internal balance.
3. Naming conventions
When choosing names for your internal balances, it’s important to use consistent and descriptive naming schemes. This ensures easy recall and reduces the risk of errors when posting transactions.
Here are some things to note when naming your internal balances:
- Always use the @ prefix to automatically add it to the General Ledger.
- Use names that clearly describe the balance’s purpose, e.g.,
@Revenue
,@Fees
,@World
, etc. - You can use the same name for balances that perform the same function, but for different asset classes, i.e., you can have two balances named
@Revenue
but one is in EUR, while the other is in USD.For better readability, it’s advisable to have the indicators suffixed by the currency, e.g.
@RevenueUSD
and@RevenueEUR
. - Use camel case (
@OnlineRevenue
) or underscores (@online_revenue
) to separate words for better readability. Avoid including spaces to prevent formatting issues. - Keep it short to facilitate easier referencing.
4. Representing external accounts
When balances interact with external balances like other bank accounts, wallets, cards, etc. that are outside of your system, it is still required that the corresponding entry is recorded in your ledger.
To do this, create a new internal balance called "@World"
and use it to represent all interactions with the outside world. You can also choose to name it however you want, as long as it represents all interactions with the outside world in your ledger.
Depending on the design of your ledger architecture, how you represent external accounts might differ. See our guides on Money Movement Maps and Ledger Architecture.
See the table below for a simplified example of how @World
works.
You can also have multiple @World
balances for different asset classes (NGN, USD, etc).
Scenarios | Source | Destination |
---|---|---|
Sending funds to an external bank account | bal_customer | @World |
Receiving money from an external bank account | @World | bal_customer |
Making online payment with virtual card | bal_customer | @World |
Received a refund of an online payment | @World | bal_customer |
When using the @World
balance in a transaction, it is encouraged to enable overdrafts. This allows you to be able to record transactions on @World
even when its balance is less than 0.
A negative balance on @World
simply means your application has received more money than it has sent out, and vice versa.
Need help?
We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool.
To ask questions or discuss issues, please join our Discord community.
Manage your Blnk Ledger and explore advanced features (access control & collaboration, anomaly detection, secure storage & file management, etc.) in one dashboard.
Was this page helpful?