Payments
Get Payment Stats
Cash flow stats — actual money received, by channel and period.
Pair with GET /invoice-requests/stats for the full AR picture:
that endpoint shows what was invoiced (accrual); this one shows
what was actually collected (cash basis).
GET
Get Payment Stats
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Reporting window. One of the preset windows below, or custom (requires date_from and date_to):
- today — current day only
- week — Monday of the current week to today
- mtd — Month To Date: 1st of this month to today
- qtd — Quarter To Date: 1st of this quarter to today (e.g. Apr 1 in Q2)
- ytd — Year To Date: Jan 1 to today
- rolling_30 — last 30 calendar days, regardless of month boundaries
- rolling_60 — last 60 calendar days
- rolling_90 — last 90 calendar days (standard treasury lookback)
- custom — supply
date_from=YYYY-MM-DD&date_to=YYYY-MM-DD
Start date for period='custom' (YYYY-MM-DD).
End date for period='custom' (YYYY-MM-DD).
Response
Successful Response
Get Payment Stats
