Getting paid
Collection records: inbound payments received against an entity, deposit totals, and the merged collections activity feed.
These reads are served via the payments proxy under /institution/payments/*. The underlying data
and schema are owned by account-events-service; the proxy rewrites the route, so the
path you call is the one documented here — not the account-events path.
📄️ List payments
The caller's payments (collections and disbursements). Scope is resolved server-side from the authenticated headers; no account ids are accepted from the client.
📄️ Deposit totals by currency
Total deposits per currency over a window (defaults to the last 24h).
📄️ Get a payment
A single payment with its flow-of-funds timeline and the settled payouts it went out on (`payouts`).
📄️ Collections activity feed
One chronological feed of COLLECTION payments merged with completed settlement roll-ups.
📄️ Collections summary tile
All-time entity-wide roll-up of COLLECTION payments for the dashboard tile.
📄️ Fees summary tile
Entity-wide roll-up of fees across every charge type; all-time unless a window is given. Totals and `chargeCount` cover charges in state CHARGED and UNCOLLECTED — fees collected plus fees owed but not yet collected, including conversion fees from the HTTP-order path. PENDING, DELETED, REVERSED and REVERSAL_PENDING charges are excluded. Per-item bulk-payout (disbursement) fees are rolled up per batch, so each batch counts as one charge.