Skip to main content
GET
/
payouts
List Payouts
curl --request GET \
  --url https://{defaultHost}/payouts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "object": "payout",
      "id": "<string>",
      "amount": 123,
      "currency": "<string>",
      "fee_amount": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "estimated_arrival": "2023-11-07T05:31:56Z",
      "payer_name": "<string>",
      "payout_token": {
        "nickname": "<string>",
        "payout_destination": {
          "payer_name": "<string>",
          "icon_url": "<string>"
        }
      }
    }
  ],
  "page_info": {
    "has_next_page": true,
    "end_cursor": "<string>",
    "has_previous_page": true,
    "start_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

An account API key, account scoped JWT, app API key, or user OAuth token.

Headers

​
Api-Version-Date
string<date>

Pins the request to a dated API version. When omitted, the request uses the original (2025-01-01) request/response shapes, so existing unversioned callers are never broken. Generated SDKs always send the latest version they were built against. An unrecognized value is rejected with a 400. The schemas documented here always describe the latest version.

Example:

"2026-07-01"

Query Parameters

​
account_id
string

The owning account ID (a biz_ identifier). Provide this or user_id.

​
user_id
string

The owning user ID (a user_ identifier). Provide this or account_id.

​
currency
string

Optional currency code filter, for example usd.

​
first
integer
default:20

Number of payouts to return from the start of the window.

Required range: x <= 100
​
after
string

Cursor to fetch the page after (from page_info.end_cursor).

​
last
integer

Number of payouts to return from the end of the window.

Required range: x <= 100
​
before
string

Cursor to fetch the page before (from page_info.start_cursor).

Response

payout method nulled without the destination-read scope

​
data
object[]
required
​
page_info
object
required