Skip to main content

Ledgers

πŸ”° What Is the Ledgers Sub-Module?​

Think of a Ledger as a real digital bank account that HelloMe Money gives to a customer (called a remitter).

When someone is approved, HelloMe creates a special account just for them, with:

  • βœ… An Account Number (just like your normal bank).
  • βœ… An IBAN (International Bank Account Number for sending money abroad).
  • βœ… A Currency (like GBP or EUR).
  • βœ… A Provider (like Tribe β€” they help HelloMe run this account).
  • βœ… Compliance Info (rules to keep it safe and legal).

This is what makes HelloMe work like a real bank in the background

πŸ” Search Filters​

Admins can quickly find any ledger by using filters like:

  • Provider (e.g., Tribe)
  • Remitter Name or ID
  • Account Number or IBAN
  • Currency (GBP, EUR, etc.)
  • Status (Active, Closed, In Review)

πŸ—‚οΈ Ledger Table: What You See​

When admins open the Ledgers page, they see a list of all these bank accounts.

FieldWhat It Means
DateWhen the account was created or last updated.
Remitter NameThe name of the customer who owns the account.
Account #The unique virtual account number.
IBANThe international format of the account number.
CurrencyThe currency this account uses (e.g., GBP).
ProviderThe company that helps HelloMe run this account (e.g., Tribe).
IBAN StatusShows if the account is Active, Pending, or Blocked.
ActionAdmins can View, Edit, or Manage the account.

--

✏️ How to Edit a Ledger​

When you click Edit, you open a form.
Admins use this form to fix or update a customer’s account details if needed.

Reasons to edit:

  • βœ… Fix wrong information.
  • βœ… Update a customer’s address or phone.
  • βœ… Make sure all details match KYC/AML rules.
  • βœ… Correct mistakes from the onboarding system.

🧾 Remitter Identity Fields (Editable)​

FieldWhat It Means
First Name / Last NameThe customer’s real name.
Address, City, State, PostcodeWhere they live β€” needed for verification.
Phone NumberThe phone number linked to the account.
CountryThe country the customer lives in.
Pin CodeAdmin security field to confirm the update is safe.



🏦 Example Balances​

When User Clicks on View on the Hompegage, it takes user to the Ledger Detail Page

βœ… What is the Ledger Detail Page ?​

The Ledger Detail Page is the full snapshot of a digital bank account. Admins use this to:

  • View complete ledger balances.
  • Cross-check compliance information.
  • Confirm account banking details (IBAN, BIC, Swift).
  • Investigate issues or match data with external providers (e.g., Tribe).

It’s a single source of truth for that customer’s virtual account inside HelloMe.

In the detail view you might see something like:

  • Total Balance: 0.009434232
  • Reserved Balance: 0
  • Available Balance: 0.009434232

Meaning: All funds are fully available β€” nothing is locked or on hold.


From the Ledger Detail Page, Admins may:

  • View related API logs for ledger updates.

βœ… Summary​

The Ledger Detail Page gives Admins a full, transparent view of any customer’s digital banking account inside HelloMe Money β€” showing balances, identity details, banking references, and provider integrations β€” all in one place.

This makes it easy to manage, verify, and support real digital banking operations securely and compliantly.

πŸ—‚οΈ Fields Shown on the Ledger Detail Page​

FieldDescription
Total BalanceThe total funds in the ledger account.
Reserved BalanceAny funds that are currently held/reserved (not spendable).
Available BalanceTotal Balance minus Reserved Balance β€” this is the spendable balance.
DateDate of ledger creation or last update.
Ledger TypeType of ledger (Personal or Business).
RemitterLinked customer or business name + ID (e.g., 1434 / David Baker).
Account #System-generated virtual account number.
IBANThe International Bank Account Number assigned to the ledger.
Country Iso CodeThe country code where the account is registered (e.g., EUR).
Currency Iso CodeThe currency of the ledger (e.g., EUR: Euro).
Sort/BIC/SWIFTBank codes for international transactions (e.g., MOODWGB22XXX).
Ledger IDUnique ID for this ledger in the system.
AddressAddress linked to the remitter’s account (e.g., London 2nd Floor...).
State/ProvinceRegion info (e.g., London).
PostcodePostcode for the address (e.g., E14 9RE).
Mobile PhoneRemitter’s registered mobile phone number.
Company NameIf it’s a business ledger, shows the company name (can be blank if N/A).
Inbound/Outbound EnabledIndicates if deposits (inbound) and withdrawals (outbound) are allowed.
Bank NameThe actual name of the bank (optional; may show -- if not provided).
Bank AddressAddress of the bank (optional; may show -- if not provided).
Ledger StatusStatus of the ledger account (e.g., Active, Pending, Blocked).
Is PrimaryShows if this is the primary ledger for the remitter (Yes/No).
ProviderThird-party provider powering the ledger (e.g., tribe).
Branch CodeBank branch code (if applicable).
Ledger Primary Use TypesDescribes the main use of the ledger (optional; may be blank).
StatusCurrent operational status of the ledger.
Holder/Partner IDInternal ID linking to external partner or account holder.
Partner ReferenceReference number to the partner system.

πŸ”° What does the view Api logs button does ? If fact, what are API Logs ?​

The API Logs section provides a detailed history of communication between HelloMe Money and its external service providers (e.g., Tribe).
These logs are essential for tracking how updates (such as ledger or account changes) are sent or received.

Admins and developers use this to:

  • βœ… Troubleshoot account or sync issues
  • βœ… Verify successful data exchange
  • βœ… Confirm account status updates
  • βœ… Check for duplicate or failed API calls

πŸ—‚οΈ Log Table Overview​

When you click "View API Logs" for a ledger, you will see the following table:

FieldDescription
DateTimestamp of when the API request/response occurred
RequestType of API call (e.g., callbackUpdateLedger)
ResponseJSON response payload with ledger/account data
ClientAPI source or repeated content (varies by implementation)

🧩 Example API Log Entry (Decoded)​

{
"currency_code": "GBP",
"iban": "GB34CLRB04047300154174",
"iban_id": 180648352278757916,
"key": "eb5910c8d31d86ec",
"status_id": 5,
"ts": 1725626937,
"sign
}

| Field | Meaning |
|----------------|-------------------------------------------------------------------------|
| `currency_code`| The currency linked to the ledger/account β€” e.g., GBP |
| `iban` | The IBAN (International Bank Account Number) being updated |
| `iban_id` | System-generated ID representing this IBAN |
| `key` | API key used for verifying the source of the update |
| `status_id` | Numeric ID showing current status of the ledger (e.g., Active = 5) |
| `ts` | UNIX timestamp of when the update occurred |
| `sign` | Digital signature for verifying request authenticity |