Skip to main content
GET
/
v1
/
payout_groups
List
curl --request GET \
  --url https://{defaultHost}/v1/payout_groups \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "pagination": {
    "count": 1,
    "limit": 20,
    "page": 1,
    "url": "/v1/payout_groups"
  },
  "data": [
    {
      "id": "a93574f1-3874-4198-a013-3f2ea7d97d72",
      "object": "payout_group",
      "currency": "usd",
      "end_date": 1780617600,
      "live_mode": true,
      "min_commission_amount": null,
      "created_at": 1780925504,
      "updated_at": 1780925504
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
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.

​
page
integer

The page of items you want returned.

Response

200 - application/json

Success

​
object
string

A string describing the object type returned.

​
pagination
object
​
data
array

An array of objects.