---
title: "List payouts"
method: GET
path: "/v1/payouts"
tags: ["Payouts"]
---

# List payouts

`GET /v1/payouts`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/payouts`
- Auth: HTTP bearer

`not_eligible` payouts carry the reason in words. Nothing is dropped silently.

**Scope:** `read`

## Query parameters

- `program_id` string, required: Required on every list
- `limit` string: 1 to 100, default 25
- `starting_after` string: Object id; returns the page after it (older)
- `ending_before` string: Object id; returns the page before it (newer)
- `expand[]` union: Relations to embed: partner, batch
  - string
  - string[]
- `include[]` union: Nothing to include on this resource
  - string
  - string[]
- `partner_id` string
- `batch_id` string
- `status` 'not_eligible' | 'pending' | 'processing' | 'paid' | 'failed'

## Response `200`

Payouts

- PayoutList
  - `data` Payout[], required
    - `id` string, required: Prefixed id (`pyt_…`)
    - `object` 'payout', required
    - `program_id` string, required: Prefixed id (`prg_…`)
    - `partner_id` string, required: Prefixed id (`part_…`)
    - `batch_id` string, nullable, required: Prefixed id (`batch_…`)
    - `amount_minor` integer, required: Integer minor units (cents, pence). Never a float, never a string.
    - `currency` string, required: ISO-4217
    - `method` 'paypal' | 'wise' | 'bank_transfer' | 'wire' | 'crypto' | 'payoneer' | 'null', nullable, required
    - `status` 'not_eligible' | 'pending' | 'processing' | 'paid' | 'failed', required
    - `not_eligible_reason` string, nullable, required: Why this partner was not paid this period, in words
    - `external_id` string, nullable, required
    - `error_code` string, nullable, required
    - `error_message` string, nullable, required
    - `period_start` string, date-time, nullable, required: ISO-8601, UTC
    - `period_end` string, date-time, nullable, required: ISO-8601, UTC
    - `paid_at` string, date-time, nullable, required: ISO-8601, UTC
    - `metadata` object, nullable, required: Your own key/value data, stored as given
    - `created_at` string, date-time, required: ISO-8601, UTC
    - `updated_at` string, date-time, required: ISO-8601, UTC
  - `has_more` boolean, required: Pass the last object's id as `starting_after` to fetch the next page
  - `total_count` integer, required: Count of every object matching the filters, ignoring the cursor

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)