Creators · Creator Campaigns

Pay creators with one card payment

Pays creators with one card payment.

POSThttps://api.pozy.ai/v1/creator-campaigns/{campaignId}/payout-batches

Enabled on requestcreateCampaignPayoutBatch

Request

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

This endpoint is enabled per workspace. Until it is, calls return 403 feature_not_available. Email support@pozy.ai to turn it on.

Path parameters

Name	Type	Notes
`campaignId`required	string

Headers

Name	Type	Notes
`Idempotency-Key`	string	Up to 255 charactersRetries with the same key return the original result. See Idempotency

Request body

application/json, optional

participantIdsarray of string
At least 1 item. Up to 500 items.
excludeParticipantIdsarray of string
At least 1 item. Up to 500 items.
paymentMethodIdstring

Example

curl -X POST "https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e/payout-batches" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "participantIds": [
    "string"
  ],
  "excludeParticipantIds": [
    "string"
  ],
  "paymentMethodId": "6f0f324b965caaf218fe69b7"
}'

import { randomUUID } from "node:crypto";

const res = await fetch("https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e/payout-batches", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Idempotency-Key": randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    participantIds: [
      "string"
    ],
    excludeParticipantIds: [
      "string"
    ],
    paymentMethodId: "6f0f324b965caaf218fe69b7"
  }),
});
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.post(
    "https://api.pozy.ai/v1/creator-campaigns/65a3737dd8b11ea61f199e6e/payout-batches",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "participantIds": [
            "string",
        ],
        "excludeParticipantIds": [
            "string",
        ],
        "paymentMethodId": "6f0f324b965caaf218fe69b7",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

201 on success

batchobjectrequired
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
paymentobjectrequired
- statusstringrequired
  One of succeeded, processing, requires_action.
- clientSecretstringrequired
  Can be null.

201 response

{
  "batch": {
    "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"
  },
  "payment": {
    "status": "succeeded",
    "clientSecret": "string"
  }
}

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 read-only, 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.