> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usecleff.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Payout volume

> The 'Payouts last 30 days' card payload: disbursed + settled Payout volume bucketed by created_at UTC day across the requested window (zero-filled, ascending), plus the % change vs the equal-length prior window. A pure read-model over Payout — nothing is stored. Results are scoped to the caller's Business and environment.



## OpenAPI

````yaml GET /v1/reporting/payout-volume
openapi: 3.0.0
info:
  title: Cleff API
  description: >-
    Payout orchestration platform. All endpoints under /v1/ require an API key
    in the Authorization header (Bearer ck_<env>_<id>_<secret>).
  version: 0.0.1
  contact: {}
servers: []
security: []
tags: []
paths:
  /v1/reporting/payout-volume:
    get:
      tags:
        - Reporting
      summary: >-
        Payout (Money-Out) volume over a window for the current Business and
        environment
      description: >-
        The 'Payouts last 30 days' card payload: disbursed + settled Payout
        volume bucketed by created_at UTC day across the requested window
        (zero-filled, ascending), plus the % change vs the equal-length prior
        window. A pure read-model over Payout — nothing is stored. Results are
        scoped to the caller's Business and environment.
      operationId: PayoutVolumeController_get
      parameters:
        - name: from
          required: true
          in: query
          description: Inclusive lower bound of the window (ISO-8601 date or timestamp).
          schema:
            type: string
        - name: to
          required: true
          in: query
          description: >-
            Inclusive upper bound of the window (ISO-8601 date or timestamp). A
            date-only value covers the whole day.
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PayoutVolumeResponseDto'
        '401':
          description: Missing or invalid credentials
      security:
        - api_key: []
components:
  schemas:
    PayoutVolumeResponseDto:
      type: object
      properties:
        currency:
          type: string
          description: Currency of the series (single-currency MVP).
        series:
          description: >-
            One bucket per UTC day across the requested window, zero-filled and
            ascending.
          type: array
          items:
            $ref: '#/components/schemas/VolumeBucketDto'
        trend_pct:
          type: number
          nullable: true
          description: >-
            % change in Money-Out total vs the equal-length window immediately
            before it. Null when the prior window had no volume.
      required:
        - currency
        - series
        - trend_pct
    VolumeBucketDto:
      type: object
      properties:
        date:
          type: string
          description: The bucket's UTC day, YYYY-MM-DD.
        volume_minor:
          type: number
          description: >-
            Money-Out volume (disbursed + settled) initiated that day, in minor
            units.
      required:
        - date
        - volume_minor
  securitySchemes:
    api_key:
      scheme: bearer
      bearerFormat: ck_<env>_<id>_<secret>
      type: http
      description: >-
        Cleff API key issued to a Business that self-registers via POST
        /v1/registration

````