Payouts

Retrieve a payout

Scope: read

get/v1/payouts/{id}

Request

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

Path parameters

idstring required

Prefixed id (pyt_…)

Example:pyt_7uSyy9FqVLCFWrdPeZaK

Query parameters

string
OR
string[]
string
OR
string[]

Response

The payout

idstring required

Prefixed id (pyt_…)

object'payout' required
program_idstring required

Prefixed id (prg_…)

partner_idstring required

Prefixed id (part_…)

batch_idstring nullable required

Prefixed id (batch_…)

amount_minorinteger required

Integer minor units (cents, pence). Never a float, never a string.

currencystring required

ISO-4217

method'paypal' | 'wise' | 'bank_transfer' | 'wire' | 'crypto' | 'payoneer' | 'null' nullable required
status'not_eligible' | 'pending' | 'processing' | 'paid' | 'failed' required
not_eligible_reasonstring nullable required

Why this partner was not paid this period, in words

external_idstring nullable required
error_codestring nullable required
error_messagestring nullable required
period_startstring date-time nullable required

ISO-8601, UTC

period_endstring date-time nullable required

ISO-8601, UTC

paid_atstring date-time nullable required

ISO-8601, UTC

metadataobject nullable required

Your own key/value data, stored as given

created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "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.