---
title: "YieldPayoutCreated"
method: POST
path: "yieldPayoutCreated"
tags: ["Webhook Topics"]
---

# YieldPayoutCreated

`POST yieldPayoutCreated` (webhook)

Fired when a float revenue payout has been paid and becomes retrievable from the yield payouts API. That is also the point the payout exists as far as an integration is concerned — payouts are not addressable before they are paid, so this event is the signal that a period has closed and settled.

One event per period. Periods are contiguous and never overlap, so a sequence of these events accounts for every day with no gaps and no double-counting.

The included payload mirrors the payout resource — **yieldPayoutId**, **amount** (in cents), **currency**, **periodStart**, **periodEnd**, and **paidAt** — so you can record the payout without re-reading the API. Fetch `GET /api/v1/yield-payouts/{yieldPayoutId}` when the per-account breakdown is needed; it is not carried on the event.

## Payload

- object
  - `id` string, uuid, required: Unique identifier for the object.
  - `type` 'WebhookEvent', required
  - `attributes` object, required
    - `id` string, uuid, required: The webhook event ID
    - `topic` string, required: The webhook topic/event type
    - `clientId` string, uuid, required: The client ID associated with this webhook event
    - `userId` string, uuid: The user ID associated with this webhook event (if applicable)
    - `walletId` string, uuid: The wallet ID associated with this webhook event (if applicable)
    - `updatedAt` string, date-time, required
    - `createdAt` string, date-time, required
  - `relationships` object, required
    - `event` object
      - `data` object, required: The related event resource (PaymentIntent, Payment, Refund, Capture, or ApplicationEvent)
        - `id` string, uuid, required
        - `type` string, required
  - `included` WebhookYieldPayout[], required
    - `id` string, uuid, required
    - `type` 'YieldPayoutCreated', required
    - `attributes` object, required
      - `yieldPayoutId` string, uuid, required: The payout id, as returned by the yield payouts API
      - `merchantId` string, uuid, required: The merchant the payout belongs to
      - `amount` integer, required: Float revenue earned over the period, in cents. This is the merchant's own revenue, not the gross interest received from the bank.
      - `currency` string, required: ISO 4217 currency code
      - `periodStart` string, required: First day the payout covers, as `YYYY-MM-DD`. Inclusive.
      - `periodEnd` string, required: Last day the payout covers, as `YYYY-MM-DD`. Inclusive.
      - `paidAt` string, required: ISO 8601 timestamp of when the payout was paid
      - `reference` string, nullable
      - `email` string, email, nullable
      - `fullName` string, nullable
      - `phoneNumber` string, nullable
      - `error` string, nullable
      - `walletId` string, uuid, nullable
      - `billingAddress` object, nullable

## Acknowledgement `200`

Return a 200 status to indicate that the data was received successfully

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)