Settlements
Settlements group collected payments into a single payout. List settlements, read one, and see the
payments rolled into it — reached under /institution/payments/collect/settlements/*.
Served via the payments proxy; the data and schema are owned by account-events-service. The proxy rewrites the route, so the path you call is the one documented here.
📄️ List settlements
One row per settlement: a scheduled-withdrawal run for scheduled payouts (every payment in the run, however many payout batches it went out on), or the payout request for an instant payout. Filters select which settlements appear (any of their payments matching); every figure covers the whole settlement.
📄️ Settlement wallet
The entity-level crypto payout destination.
📄️ Settlements summary tile
Total amount settled over a window (all-time when omitted). `from`/`to` bound each payment's receive date, and each payment contributes only what actually went out for it, so a run straddling the window edge is split rather than counted in both windows.
📄️ Payments in a settlement
Payments in a settlement
📄️ Get a settlement
Get a settlement