List balance changes for a period
Every change to this account’s balance in a window, in the order the money moved, with the opening and closing balances for that window in the same response.
GET /transactions returns one row per transaction. This returns one row per change to the balance, and a transaction that moves the balance more than once produces more than one change: an ACH deposit and its later return are two, and a card purchase that clears in two parts is two. Each change’s transactionId names its transaction, so fetch it from GET /transactions/{transactionId} for its type, counterparty, merchant and rail.
The identity to assert: openingBalance + Σ(data[].amount) == closingBalance, summed over every page. The opening and closing balances describe the window rather than the page, so they are the same on every page. Page until hasMore is false, then assert the identity.
startDate and endDate are instants in any timezone, UTC included, and the window is half-open: a change at exactly endDate belongs to the next window. Consecutive windows therefore tile with no gap and no overlap.
A window whose card settlement has not closed is refused with 409 NOT_YET_AVAILABLE, because its figures could still change. Retry once it has settled.
A fee is already inside a change’s amount. For the fee itself, read fees on the change’s transaction, counting each transaction once.
Authorizations
Query Parameters
Response
The balance changes in the window, with the balances that bound it
A window of balance changes with the balances that bound it. The opening and closing balances describe the whole window, not the page, so they are the same on every page, and the identity openingBalance + Σ(data[].amount) == closingBalance holds only once every page's data is summed.