Payouts

List payouts

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

Scope: read

get/v1/payouts

Request

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

Query parameters

program_idstring required

Required on every list

Example:prg_7uSyy9FqVLCFWrdPeZaK
limitstring

1 to 100, default 25

Example:25
starting_afterstring

Object id; returns the page after it (older)

ending_beforestring

Object id; returns the page before it (newer)

string
OR
string[]
string
OR
string[]
partner_idstring
batch_idstring
status'not_eligible' | 'pending' | 'processing' | 'paid' | 'failed'

Response

Payouts

has_moreboolean required

Pass the last object's id as starting_after to fetch the next page

total_countinteger required

Count of every object matching the filters, ignoring the cursor

Example response

{
  "data": [
    {
      "id": "pyt_7uSyy9FqVLCFWrdPeZaK",
      "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
      "partner_id": "part_7uSyy9FqVLCFWrdPeZaK",
      "batch_id": "batch_7uSyy9FqVLCFWrdPeZaK",
      "amount_minor": 2500,
      "currency": "USD",
      "period_start": "2026-08-21T10:15:30.000Z",
      "period_end": "2026-08-21T10:15:30.000Z",
      "paid_at": "2026-08-21T10:15:30.000Z",
      "created_at": "2026-08-21T10:15:30.000Z",
      "updated_at": "2026-08-21T10:15:30.000Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.