Guides

Accounts

Accounts are the backbone of your Ledger, enabling seamless financial transactions.

Suggest Edits

Each account represents a specific asset and can include child accounts (sub-accounts) for specialized purposes or distinct activity tracking.


Account Types

Each account type defines its behavior and primary function within the Ledger:

  • Deposit: The most common account type for everyday transactions, including checking or payment activities.
  • Savings: Ideal for investments, with potential earnings (e.g., interest) when integrated with the Interests satellite service.
  • Loans: Tracks and manages client loans, supporting automated calculations when connected to the Interests satellite.
  • Marketplace: Built for installment-based sales (e.g., five-month installments), including settlement and receivables advance products.
  • Credit Card: Dedicated to tracking credit card balances, payments, and usage.
  • External Accounts: Handles funds entering or leaving the Ledger. These accounts:
    • Manage temporary balances.
    • Are the only type allowed to have a negative balance (indicating funds in transit).
    • Are automatically generated by the Ledger for reconciliation purposes.

🚧

External Accounts Are Non-Modifiable

To maintain Ledger integrity and ensure accurate reconciliation, external accounts cannot be deleted or altered.


Account Behaviors

The table below outlines the modifiability and behaviors for each account type:

TypeDeactivatedEditedNegative Balance Allowed
Deposit

Savings

Loans

Marketplace

Credit Card

External Accounts


Child Accounts

Child accounts, or sub-accounts, extend the functionality of a primary account. They inherit the primary account’s characteristics while allowing for specific use cases, such as managing funds or tracking unique transaction types.


Account Aliases

Aliases simplify account identification by replacing complex IDs with user-friendly labels. For example:

  • Instead of sharing an account ID (3172933b-50d2-4b17-96aa-9b378d6a6eac), a user can assign an alias like @username_1.
  • The alias can then be shared for easier transactions.

Example Structure

The diagram below demonstrates how entities, portfolios, and accounts relate to one another:

Figure 1. Example of how the assets can relate to one another.

Figure 1. Example of how the assets can relate to one another.

  • Entity 123 owns Portfolio 1, which includes Accounts 1, 2, and 3.
  • Portfolio 1 also has a sub-account (Account 98) linked to Entity 626.

This setup allows flexible relationship management and access controls. For example, a parent might oversee a child’s sub-account within the same portfolio, while the child remains the primary user of their account.

By structuring accounts this way, you gain the flexibility to tailor relationships and permissions to meet diverse needs.


Managing Accounts

To manage your Accounts you can use the Accounts API or the Portfolios and Accounts tab of the Ledgers page on Midaz Console.


View Accounts Details

  • Via API:
  • Via Console: Access the Portfolios and Accounts tab to view the details of a Portfolio. For more information, refer to the Managing Accounts page.

Create an Account


Edit an Account


Delete an Account

  • Via API: Use the Update an Account endpoint.
  • Via Console: Delete an Account from the Portfolios and Accounts tab of the Ledgers page. For more information, refer to the Deleting an Account page.

Managing Portfolio Accounts

You can use the following endpoints to manage accounts directly from the Portfolio:

🚧

Attention

These endpoints will soon be deprecated.

Updated 15 days ago