For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact SupportGet Started
  • Modernfi Developer Hub
    • Overview for Developers
    • Getting Started
  • Topics
    • Using the Sandbox
    • Authentication
    • Account Structure
    • Idempotency
    • Transaction Records and Sweeps
    • Balance Fields
    • Interest
    • Reports
    • Versioning
    • Changelog
  • API Reference
LogoLogo
Contact SupportGet Started
On this page
  • What this means in practice
  • Which one should I use?
Topics

Balance Fields

Was this page helpful?
Previous

Interest

Next
Built with

Every account in ModernFi returns two balance fields:

Field What it reflects 
totalBalanceOnly POSTED transactions. This is the fully settled balance
pendingBalanceAll POSTED + PENDING transactions combined

What this means in practice

totalBalance reflects confirmed, finalized activity only. pendingBalance gives you a forward-looking view that includes transactions still awaiting posting.

Once any transaction has been created on an account, pendingBalance will not return $0 unless the account has been fully cleared. Both values reflect the account state at the time of the API call; no running or intraday balance is available.

Which one should I use?

Use totalBalance for reconciliation and reporting. Use pendingBalance when you need to account for in-flight transactions. For example, to prevent an overdraft before a credit has posted.