Skip to main content

POST /sdk/v1/campaign-creators/payouts/bulk

Sends calculated campaign payouts for up to 100 creators. Each creator is recalculated immediately before payment so the amount cannot silently change between preview and payment.
This endpoint sends real payouts. Call Preview campaign creator payouts first and verify that calculation.readyToPay is true.

Headers

  • X-Application-Id (required)
  • X-Api-Key (required)
  • X-Idempotency-Key (required): a unique value for this payout request. Retry the same request with the same key to receive the original result without paying twice.

Body

payouts is a non-empty array with no more than 100 items. Each item accepts:
  • campaignCreatorRecordId (required)
  • amount (required): the exact payout.total returned by the preview.
  • currency (required): the exact payout.currency returned by the preview.
  • startDate and endDate (optional): the same inclusive YYYY-MM-DD range used for the preview. Send both or neither.
  • confirmHighValuePayout (optional): set to true when the amount exceeds your agency’s payout confirmation threshold.

Example request

Response

The request can contain both paid and failed items. A failure for one creator does not hide the results for the others.
Common item failures include:
  • the creator or campaign record was not found
  • the payout is still calculating or has no payable amount
  • the amount or currency no longer matches the current calculation
  • high-value confirmation is required
  • the agency wallet has insufficient available funds

Request errors

  • 400: missing idempotency key, invalid body, or more than 100 payouts
  • 401: missing or invalid SDK credentials
  • 409: the idempotency key was reused with different data, or the original request is still running
  • 503: idempotency protection is temporarily unavailable