Creators · Treasury
Confirms a payout batch payment.
POST
https://api.pozy.ai/v1/payout-batches/{batchId}/confirmEnabled on requestconfirmPayoutBatch
Guide: Pay creators
Request
Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the money 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 |
|---|---|---|
batchIdrequired | string |
Example
curl -X POST "https://api.pozy.ai/v1/payout-batches/627ca9b89851603d67d7b0f6/confirm" \
-H "Authorization: Bearer $POZY_API_KEY"const res = await fetch("https://api.pozy.ai/v1/payout-batches/627ca9b89851603d67d7b0f6/confirm", {
method: "POST",
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.post(
"https://api.pozy.ai/v1/payout-batches/627ca9b89851603d67d7b0f6/confirm",
headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
timeout=30,
)
resp.raise_for_status()
print(resp.json())Response
200 on success
batchobjectrequired11 child fields
idstringrequiredcampaignIdstringrequiredCan be null.
statusstringrequiredOne of
awaiting_payment,paying,paid,partially_failed,failed,expired.methodstringrequiredOne of
card.amountCentsintegerrequiredfeeCentsintegerrequiredtotalCentsintegerrequireditemsarray of objectrequired9 child fields
idstringrequiredparticipantIdstringrequiredcreatorobjectrequired1 child field
displayNamestringrequired
amountCentsintegerrequiredfeeCentsintegerrequiredtotalCentsintegerrequiredstatusstringrequiredOne of
pending,paid,failed,skipped.failureReasonstringrequiredCan be null.
transferIdstringrequiredCan be null.
paidAtstring (date-time)requiredCan be null.
finishedAtstring (date-time)requiredCan be null.
createdAtstring (date-time)required
200 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"
}
}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.