Home / Issuing / Transfer Funds
When you create a card product, Highnote creates ledgers for your financial accounts based on the card product vertical. Ledgers have a LedgerName
, description
, and a normalBalance
that is determined by the ledger category. For example, a CASH
ledger has a category of ASSETS
and a normalBalance
of DEBIT
. For a full list of ledger names, see LedgerName in the API Reference.
A ledger is made up of the following foundational concepts:
Concept | Definition |
---|---|
Normal balance | The expected balance of a ledger |
Financial event | Any event that impacts the balance of a financial account |
Ledger entry | A record of a financial event, resulting in a change in a financial account's balance |
Account balance | The current balance of a ledger, reflecting all financial events |
Account balances show all financial events for a given ledger. When an individual financial event occurs, it results in a ledger entry. Each ledger entry reflects the change in account balance. Refer to the following example for a breakdown of this process:
CASH
ledger, reflecting the account balance.AUTHORIZATION
ledger reflects pending authorizations and holds on the account.AVAILABLE_CASH
ledger reflects the money available to spend in a financial account.Account balances reflect the current balance of a ledger based on financial events, based on the following:
DEBIT
or CREDIT
If the account balance and normal balance agree, the balance is interpreted as positive. If the balance of a ledger and the normal balance disagree, the balance is interpreted as negative. The following example using a CASH
ledger outlines how account balances and normal balances are reflected. CASH
ledgers have a normal balance of DEBIT
:
CASH
ledger has a $1000 debit balance, the balance is positive. This means the account balance is $1000 because the normal balance for a CASH
ledger is debit.CASH
ledger has a $1000 credit balance, the balance is negative. In this case, the account balance and normal balance disagree, meaning there is -$1000 in the account.Highnote's ledger system is based on account principles, with cash and activity being represented independently. This means that account balances provide a snapshot for a point in time, rather than reflecting pending or available balances. Pending or available balances can be calculated across ledgers if desired.
Ledgers and financial events can be used to create account statements, display account balances, and show money movement statuses. Refer to the following table for the objects used to create each use case:
Use case | Objects |
---|---|
Transaction feed without account balance | FinancialAccountActivity |
Account statement with balance | FinancialAccountActivity for pending and Ledger for posted |
Money movement status | FinancialAccountActivity |
Use the following query to list all ledgers for your organization. The query returns each ledger's normalBalance
, creditBalance
, and debitBalance
:
Use the following query to find a ledger and its associated ledger entries: