> ## Documentation Index
> Fetch the complete documentation index at: https://api.fanvue.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Payout Events

> Reference for payout.paid and payout.failed webhooks: creator-level events fired when a withdrawal settles or fails, with payload fields and status values.

| Event (`type`)  | Resource | Fires when               |
| --------------- | -------- | ------------------------ |
| `payout.paid`   | payout   | A creator payout settles |
| `payout.failed` | payout   | A creator payout fails   |

<Note>
  These are **creator-level** events: each reports a single withdrawal to the
  creator, not a checkout-link sale, and is not scoped to any one link. Neither
  is a settlement statement; expect one event per withdrawal transition.
</Note>

They are delivered in the
[Standard-Webhooks envelope](/docs/checkout/overview#event-envelope); the
fields below describe the `data` object.

## Payout resource

| Field                   | Type           | Description                                                         |
| ----------------------- | -------------- | ------------------------------------------------------------------- |
| `object`                | string         | Always `"payout"`                                                   |
| `id`                    | string         | Withdrawal invoice number (e.g. `FVW-12345`)                        |
| `status`                | string         | `paid` on `payout.paid`, `failed` on `payout.failed`                |
| `amount`                | integer        | Payout amount in minor units                                        |
| `currency`              | string \| null | ISO 4217 currency code                                              |
| `fees`                  | object         | `{ transaction_fee }` in minor units (may be `null`)                |
| `fx_rate`               | number \| null | FX rate applied, if a currency conversion took place                |
| `external_reference_id` | string \| null | Reference id from the payout provider                               |
| `paid_at`               | string \| null | ISO 8601 time the payout was paid. Always `null` on `payout.failed` |
| `creator`               | object         | `{ uuid }` of the creator                                           |

<Note>
  The payout resource does not carry `client_reference_id`, `metadata`, or a
  purchaser, as it is not tied to a specific checkout payment.
</Note>

## Example: `payout.paid`

```json theme={null}
{
  "id": "f1a2b3c4-8888-4a2b-9c3d-aaaaaaaaaaaa",
  "type": "payout.paid",
  "timestamp": "2026-06-09T08:42:00.000Z",
  "data": {
    "object": "payout",
    "id": "FVW-12345",
    "status": "paid",
    "amount": 50000,
    "currency": "USD",
    "fees": { "transaction_fee": 100 },
    "fx_rate": 1.0,
    "external_reference_id": "ext-ref-1",
    "paid_at": "2026-06-09T08:42:00.000Z",
    "creator": { "uuid": "creator-uuid" }
  }
}
```

## Example: `payout.failed`

The same resource with `status: "failed"` and no settlement time. The withdrawal
did not complete; the amount is not with the creator.

```json theme={null}
{
  "id": "f1a2b3c4-8889-4a2b-9c3d-aaaaaaaaaaaa",
  "type": "payout.failed",
  "timestamp": "2026-06-09T08:44:00.000Z",
  "data": {
    "object": "payout",
    "id": "FVW-12346",
    "status": "failed",
    "amount": 50000,
    "currency": "USD",
    "fees": { "transaction_fee": 100 },
    "fx_rate": 1.0,
    "external_reference_id": "ext-ref-2",
    "paid_at": null,
    "creator": { "uuid": "creator-uuid" }
  }
}
```

<Note>
  The payout resource carries no failure reason. Use the
  [earnings endpoints](/docs/api-reference/get-earnings-data) or the creator's payout
  history to find out why a withdrawal failed.
</Note>