Skip to main content
GET
/
v1
/
payouts
List
curl --request GET \
  --url https://{defaultHost}/v1/payouts \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/payouts"
  },
  "data": [
    {
      "id": "06a1b2e7-1ce2-4841-809d-6020e7258214",
      "object": "payout",
      "currency": "usd",
      "description": null,
      "end_date": 1767571200,
      "live_mode": true,
      "manual": false,
      "payout_email": null,
      "status": "processing",
      "total_commission_amount": 9900,
      "affiliation": "9e2270f5-702c-48db-896a-10b31524ae6f",
      "payout_group": null,
      "created_at": 1767909730,
      "updated_at": 1767909730
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
affiliation_ids[]
string[]

Only return objects that belong to the given affiliations.

​
currency
string

Three-letter ISO currency code, in lowercase.

​
ids[]
string[]

Only return objects with the given IDs.

​
limit
integer

A limit on the number of items to be returned, between 1 and 100.

​
live_mode
boolean

Only return objects that are live mode or test mode.

​
page
integer

The page of items you want returned.

​
payout_group_ids[]
string[]

Only return objects that belong to the given payout groups.

​
status[]
string[]

Only return objects with the given status.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.