List payout batches (GET /v1/creator-campaigns/{campaignId}/payout-batches)

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the creator_campaigns resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`campaignId`required	string

Query parameters

Name	Type	Notes
`limit`	integer	Default `20`1 to 100
`skip`	integer	Default `0`At least 0

Example

curl -X GET "https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e/payout-batches?limit=20" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e/payout-batches?limit=20", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e/payout-batches",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    params={
        "limit": 20,
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

batchesarray of objectrequired
11 child fields
- idstringrequired
- campaignIdstringrequired
  Can be null.
- statusstringrequired
  One of awaiting_payment, paying, paid, partially_failed, failed, expired.
- methodstringrequired
  One of card.
- amountCentsintegerrequired
- feeCentsintegerrequired
- totalCentsintegerrequired
- itemsarray of objectrequired
  9 child fields
  idstringrequired
  participantIdstringrequired
  creatorobjectrequired
  1 child field
  displayNamestringrequired
  amountCentsintegerrequired
  feeCentsintegerrequired
  totalCentsintegerrequired
  statusstringrequired
  One of pending, paid, failed, skipped.
  failureReasonstringrequired
  Can be null.
  transferIdstringrequired
  Can be null.
- paidAtstring (date-time)required
  Can be null.
- finishedAtstring (date-time)required
  Can be null.
- createdAtstring (date-time)required
totalintegerrequired

200 response

{
  "batches": [
    {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "campaignId": "65a3737dd8b11ea61f199e6e",
      "status": "awaiting_payment",
      "method": "card",
      "amountCents": 1,
      "feeCents": 1,
      "totalCents": 42,
      "items": [
        {
          "id": "6bfebd43ddc270f6d2c56fc5",
          "participantId": "6f0150243551cb6ee41f35e0",
          "creator": {
            "displayName": "Acme"
          },
          "amountCents": 1,
          "feeCents": 1,
          "totalCents": 42,
          "status": "pending",
          "failureReason": "string",
          "transferId": "6f5f6fe5901ca25e11c24ddb"
        }
      ],
      "paidAt": "2026-10-02T09:00:00.000Z",
      "finishedAt": "2026-10-02T09:00:00.000Z",
      "createdAt": "2026-10-02T09:00:00.000Z"
    }
  ],
  "total": 42
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.