---
title: "Campaign payout payable event"
method: POST
path: "campaign_payout.payable"
tags: ["Webhook Events"]
---

# Campaign payout payable event

`POST campaign_payout.payable` (webhook)

Fired when a participant's held earnings mature and become payable.

## Payload

- WebhookPayloadCampaignPayout: Webhook payload for `campaign_payout.payable` and `campaign_payout.settled`. - `payable`: fires when a participant's held earnings mature. `payout.payableCents` is the participant's whole payable balance, so a partner paying from its own rails pays that amount and records it with `POST /v1/creator-campaigns/{campaignId}/participants/{participantId}/settle`. - `settled`: fires when a settlement is recorded and carries `payout.settlement`. - `failed`: fires when a treasury payout is refused, unconfirmed or reversed. The amount returns to payable (minus anything a rejection claws back) and `payout.failure` says why.
  - `id` string, required: Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery. It identifies the event only, never an account or other resource.
  - `profiles` object[]: The profiles this event belongs to, each with the externalId you set on it (null when none is set). Use it to route the event to your tenant without storing Zernio profile ids. Present on every event tied to a profile, absent on events that belong to none. Events spanning several profiles (a post published to accounts of different profiles) list each once.
    - `id` string, required
    - `externalId` string, nullable, required
  - `test` boolean: Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
  - `event` 'campaign_payout.payable' | 'campaign_payout.settled' | 'campaign_payout.failed', required
  - `campaign` object, required
    - `id` string, required
    - `name` string, required
    - `settlement` 'none' | 'external' | 'treasury', required
  - `participant` object, required
    - `id` string, required
  - `creator` object, required
    - `id` string, required
    - `displayName` string, required
  - `payout` object, required
    - `payableCents` integer, required: The participant's payable balance after this event.
    - `settlement` object: Present on campaign_payout.settled only.
      - `entryId` string, required: The ledger settlement entry.
      - `amountCents` integer, required
      - `externalReference` string, nullable, required
      - `recorded` boolean, required: True when the payout was made outside Zernio and only recorded here; false when Zernio moved the money through the treasury.
      - `transferId` string: Treasury settlement only: the Zernio transfer that moved the money. The creator receives amountCents in full.
      - `feeCents` integer: Treasury settlement only: the transfer fee, added on top of amountCents.
      - `totalCents` integer: Treasury settlement only: debited from your balance, amountCents plus feeCents.
    - `failure` object: Present on campaign_payout.failed only.
      - `transferId` string, required: The Zernio transfer that did not go through.
      - `amountCents` integer, required: The payout amount that did not reach the creator. It is returned to payable, minus any amount a rejection made while the payout was in flight claws back to the campaign budget; payableCents is the balance after both.
      - `reason` 'returned' | 'stale' | 'reversed', required: returned: Stripe refused the transfer. stale: it could not be confirmed with Stripe within 24 hours. reversed: Stripe reversed it after it was sent; the settlement is undone.
  - `timestamp` string, date-time, required: UTC time at which Zernio generated this event (set once when the event payload is built, before delivery is queued). Retries and redeliveries keep the original value, so it reflects the event, not the delivery attempt.

## Acknowledgement `200`

Webhook received successfully

---

[API](https://skmtc.dev/zernio/apis/zernio-api.md) - [All operations](https://skmtc.dev/zernio/apis/zernio-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zernio/apis/zernio-api/revisions/c319eb5d95b6?raw)