Pending disbursements summary
GET/institution/payments/bulk-withdrawals/pending-summary
Total of not-yet-approved bulk withdrawals, valued in one reference
currency. Scoped to the caller's payments.disbursements.read grant: an
entity-wide grant (with no sub-account selected) sees the whole entity,
while a sub-account-scoped caller sees only their selected sub-account.
projectx reads the per-currency pending totals from payments and converts
each at its last-traded price into referenceCurrency; a currency with no
price route (or unknown to the exchange) is omitted from the headline and
the response is flagged partial. Powers the business dashboard "Pending
disbursements" tile. Requires the payments.disbursements.read permission.
Request
Responses
- 200
- 400
- 401
- 403
- 500
OK
Missing or invalid referenceCurrency query param
Missing/invalid JWT or entity selection (RBAC_ENTITY_SELECTION_REQUIRED)
Caller lacks the payments.disbursements.read permission (RBAC_PERMISSION_DENIED)
Upstream payments pending-total lookup failed (UNKNOWN_ERROR, code -71)