Pay creators with one card payment
Pays exactly what is owed: every payable creator of a treasury campaign who finished payout
setup (or only participantIds, minus excludeParticipantIds) is held in settling, and the
response carries a Stripe Checkout url for the total plus the fee (4% per creator, 50 cent
minimum). Once the card payment completes, each creator gets a transfer funded by that charge
and the batch ends paid or partially_failed. A creator whose payouts were disabled before
the payment landed is skipped and stays payable. If the Checkout expires unpaid (24 hours),
every amount is payable again.
Card payouts are limited to $2,000.00 gross per rolling 30 days by default; over it the call
answers 402 ("Over your instant payout limit. Top up your balance to pay more this month, or
contact support to raise the limit."). Nothing payable answers 400 ("Nothing is payable.").
Needs an owner, admin or billing admin, signed in or through a full-access key they created.
Send an Idempotency-Key so a retry never opens a second batch.
Authorization
bearerAuth API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.
In: header
Path Parameters
Campaign ID.
Header Parameters
Optional client-generated unique key (e.g. a UUID) that makes retries safe. Same key + same body replays the original response; same key + different body → 422; key still processing → 409. A request cut off mid-handler (for example by a function timeout) can leave its key in progress, answering 409 until the key expires after 24 hours.
length <= 255Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.creatorcampaigns.createCampaignPayoutBatch({ body: { participantIds: [ 'participant_abc123', ], excludeParticipantIds: [ 'excludeparticipant_abc123', ], },});console.log(data);{ "batch": { "id": "string", "campaignId": "string", "status": "awaiting_payment", "method": "card", "amountCents": 0, "feeCents": 0, "totalCents": 0, "items": [ { "id": "string", "participantId": "string", "creator": { "displayName": "string" }, "amountCents": 0, "feeCents": 0, "totalCents": 0, "status": "pending", "failureReason": "string", "transferId": "string" } ], "paidAt": "2019-08-24T14:15:22Z", "finishedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" }, "url": "http://example.com"}Invite campaign participant
Invites one creator and returns their personal invite URL. Send it to the creator: on that page they connect their accounts (read-only), submit posts and see their earnings. The URL is returned only here; inviting again creates no second link (409 for a creator already in the campaign). A creator is matched by email within your workspace, so the same person keeps one identity across your campaigns. Answers 409 on a closed campaign and 403 `feature_not_available` once `caps.maxParticipants` is reached.
Create creator campaign
Creates a campaign in `draft`. Creators are paid for verified performance of the posts they submit: Zernio tracks each post through a tracking window, scores its authenticity and records every earning in a ledger. Activate the campaign to start accepting submissions. Creator campaigns run on usage-based billing; a workspace not on it gets 403 `feature_not_available`. `profileId` must be a profile this key can reach, otherwise 404.