API Behavior for Transactions and Balances

Executive Summary

The provided documentation outlines a critical distinction in how financial data is presented through the API, specifically concerning transaction status and account balances. The core principle is that the API's transaction list is intentionally limited, including only posted transactions. Pending or void transactions are explicitly excluded from this payload, and there is no field to indicate a transaction's status.

However, a comprehensive view of an account's financial position is made available through the Balance object. This object contains two key fields—Available and Current—which serve distinct purposes. The Current balance reflects the total based solely on posted transactions, aligning with the data in the transaction list. The Available balance provides a broader perspective by incorporating the sum of both posted and pending transactions. The difference between these two balance figures allows for the precise calculation of the net value of all pending transactions, even though they are not itemized in the transaction list.

Scope of Transaction Data

The API's design intentionally curates the transaction data to ensure only finalized, settled activities are included in the primary transaction list.

• Posted Transactions Only: The transaction payload exclusively contains transactions that have been fully processed and posted to the account.
• Exclusion of Pending and Void Transactions: Any transaction that is still pending or has been voided will not be present in the Transactions array of the API response.
• No Status Field: The API does not currently expose a field to differentiate the status of a transaction (e.g., 'pending', 'posted').

Balance Definitions and Interpretation

While individual pending transactions are not itemized, their financial impact is captured and can be precisely determined by comparing the two distinct balance types provided in the Balance object.

Inferring Pending Transaction Value

The total net value of all pending transactions can be derived by calculating the difference between the Available and Current balances. This provides a quantitative measure of pending activity without itemizing the specific transactions.

• Formula: Net Pending Value = Available Balance - Current Balance
• Example Calculation: Based on the provided data, the calculation is 5405.5 (Available) - 5105.5 (Current) = 300.0. This indicates a net value of $300 in pending transactions that are factored into the Available balance but not yet listed in the Transactions array.

API Response Structure: GetAccountsDetail

The GetAccountsDetail response encapsulates these concepts within a structured JSON object. The Accounts array contains individual account objects, each with its own Balance object and Transactions array, demonstrating the relationship between the balance figures and the transaction list.

Key Components from Example Response:

• ResponseType: GetAccountsDetail
• Accounts: An array of account objects.
  • Account Object:
    • Transactions: An array containing only posted transactions. The example snippet includes:
      • A debit of 50 for "Grocery Store".
      • A credit of 2000 for "Initial Deposit".
    • Balance: An object containing the different balance calculations.
      • "Available": 5405.5 (Posted + Pending)
      • "Current": 5105.5 (Posted Only)
      • "Limit": 5105.5