Skip to main content
GET
Payout (Money-Out) volume over a window for the current Business and environment

Authorizations

Authorization
string
header
required

Cleff API key issued to a Business that self-registers via POST /v1/registration

Query Parameters

from
string
required

Inclusive lower bound of the window (ISO-8601 date or timestamp).

to
string
required

Inclusive upper bound of the window (ISO-8601 date or timestamp). A date-only value covers the whole day.

Response

currency
string
required

Currency of the series (single-currency MVP).

series
object[]
required

One bucket per UTC day across the requested window, zero-filled and ascending.

trend_pct
number | null
required

% change in Money-Out total vs the equal-length window immediately before it. Null when the prior window had no volume.