Creator Campaigns

Pay creators with one card payment

Changed on

Pays exactly what is owed to the creators of a treasury campaign by charging the billing owner's saved card, with no redirect.

How it works

  1. Every payable creator who finished payout setup (or only participantIds, minus excludeParticipantIds) is held in settling.
  2. The saved card (the default one, or paymentMethodId) is charged the total plus the fee (4% per creator, 50 cent minimum) while the payer is present.
  3. Once the charge succeeds, each creator gets a transfer funded by it, and the batch ends paid or partially_failed.

A creator whose payouts were disabled before the payment landed is skipped and stays payable.

3D Secure

payment.status: requires_action means the bank asked the payer to confirm. Complete it with Stripe.js handleNextAction({ clientSecret }), then call POST /v1/payout-batches/{batchId}/confirm.

One left unfinished is cancelled after 30 minutes and every amount is payable again. Cancel it sooner with POST /v1/payout-batches/{batchId}/cancel.

Limits and errors

  • 402 payment_required: no saved card. Nothing is held.
  • 402 card_declined: the bank's reason; every amount is payable again.
  • 402: card payouts are limited to $10,000.00 gross per rolling 30 days by default. Over it the call answers "Over your instant payout limit. Top up your balance to pay more this month, or contact support to raise the limit."
  • 400: nothing payable ("Nothing is payable.").

Access and retries

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.

post/v1/creator-campaigns/{campaignId}/payout-batches

Request

  • Base URL
    https://zernio.com/api
  • URL
    https://zernio.com/api/v1/creator-campaigns/{campaignId}/payout-batches
  • Auth
    HTTP bearer

Headers

Idempotency-Keystring

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 (e.g. by a function timeout) can leave its key in progress, answering 409 until the key expires after 24 hours.

Request body

participantIdsstring[]

Pay only these participants. Defaults to every payable participant who is ready.

excludeParticipantIdsstring[]

Leave these participants out.

paymentMethodIdstring

A saved card of the billing owner's (pm_...). Defaults to the default payment method.

Response

Batch created and the card charged, or the bank asked for 3D Secure.

Changes

    • breaking

      removed the required property from the response with the status

    • info

      added the new optional request property

    • info

      added the required property to the response with the status

    • info

      endpoint added