Skip to main content
GET
List payouts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page[number]
number

Page number for pagination, for example ?page[number]=2

filter[site_id]
string
required

Site ID to fetch payouts for (required), for example ?filter[site_id]=123

filter[status]
string

Filter by payout status (pending, paid, failed, canceled), for example ?filter[status]=paid

filter[start_date]
string

Filter payouts after this date (ISO 8601), for example ?filter[start_date]=2024-01-01

filter[end_date]
string

Filter payouts before this date (ISO 8601), for example ?filter[end_date]=2024-12-31

Response

Success, returns empty list when no payouts exist