Skip to main content
GET
Get account-wide payment counts per tile group (pending / completed / failed / underpaid) for the filtered set — the numbers behind the dashboard tiles. Group membership is listed in the Payments overview.

Authorization

  • API-key scope: payments:read · JWT team permission: payments:view

Query parameters

string
Ticker filter (same semantics as List payments).
string (ISO date)
Start of the creation-date window (same semantics as the list).
string (ISO date)
End of the creation-date window (same semantics as the list).
boolean
Opt-in. Drops widget-created “abandoned” rows (grouped under failed) from the counts. List payments accepts the same flag — pass the same value to both when cross-referencing tiles against list rows, or the tile counts and the rows will disagree.

Response fields

integer
Count of payments in AWAITING_CURRENCY, WAITING, CONFIRMING, PARTIALLY_PAID, SENDING, SWEEP_QUEUED, or SWEEPING.
integer
Count of payments in CONFIRMED, SWEPT, or FINISHED — excluding settled underpayments, which are carved out into underpaid. So this undercounts those statuses by the underpaid ones.
integer
Count of payments in EXPIRED, FAILED, or CANCELLED.
integer
Count of settled underpayments — payments in the completed group (CONFIRMED, SWEPT, or FINISHED) that received materially less than the invoiced amount. Carved out of completed, so pending + completed + failed + underpaid is the total; summing only the first three misses these.

See also

  • Payments overview: the exact status-to-group mapping behind these three counters.
  • List payments: drill down from a counter to the individual payments, using the same filters.
  • Get a payment: the full detail of any payment you drill into.