Webhook Topics

YieldPayoutCreated

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.

postWebhookyieldPayoutCreated

Payload

idstring uuid required

Unique identifier for the object.

type'WebhookEvent' required

Example payload

{
  "attributes": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "walletId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "included": [
    {
      "attributes": {
        "yieldPayoutId": "123e4567-e89b-12d3-a456-426614174000",
        "merchantId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 34932,
        "currency": "USD",
        "periodStart": "2026-09-01",
        "periodEnd": "2026-09-30"
      }
    }
  ]
}

Response

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

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.