Payout batches

Retrieve a payout batch

The payouts inside it are GET /v1/payouts?batch_id=….

Scope: read

get/v1/payout_batches/{id}

Request

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

Path parameters

idstring required

Prefixed id (batch_…)

Example:batch_7uSyy9FqVLCFWrdPeZaK

Response

The batch

idstring required

Prefixed id (batch_…)

object'payout_batch' required
program_idstring required

Prefixed id (prg_…)

term'net_15' | 'net_30' | 'net_60' required
period_startstring date-time required

ISO-8601, UTC

period_endstring date-time required

ISO-8601, UTC

currencystring required

ISO-4217

total_minorinteger required

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

payout_countinteger required
generated_by_user_idstring nullable required
executed_atstring date-time nullable required

ISO-8601, UTC

created_atstring date-time required

ISO-8601, UTC

updated_atstring date-time required

ISO-8601, UTC

Example response

{
  "id": "batch_7uSyy9FqVLCFWrdPeZaK",
  "program_id": "prg_7uSyy9FqVLCFWrdPeZaK",
  "period_start": "2026-08-21T10:15:30.000Z",
  "period_end": "2026-08-21T10:15:30.000Z",
  "currency": "USD",
  "total_minor": 2500,
  "executed_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.