---
title: "Retrieve a payout batch"
method: GET
path: "/v1/payout_batches/{id}"
tags: ["Payout batches"]
---

# Retrieve a payout batch

`GET /v1/payout_batches/{id}`

## Request

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

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

**Scope:** `read`

## Path parameters

- `id` string, required: Prefixed id (`batch_…`)

## Response `200`

The batch

- PayoutBatch
  - `id` string, required: Prefixed id (`batch_…`)
  - `object` 'payout_batch', required
  - `program_id` string, required: Prefixed id (`prg_…`)
  - `term` 'net_15' | 'net_30' | 'net_60', required
  - `period_start` string, date-time, required: ISO-8601, UTC
  - `period_end` string, date-time, required: ISO-8601, UTC
  - `currency` string, required: ISO-4217
  - `total_minor` integer, required: Integer minor units (cents, pence). Never a float, never a string.
  - `payout_count` integer, required
  - `generated_by_user_id` string, nullable, required
  - `executed_at` string, date-time, nullable, required: ISO-8601, UTC
  - `created_at` string, date-time, required: ISO-8601, UTC
  - `updated_at` string, date-time, required: ISO-8601, UTC

## 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)