Event (type) | Resource | Fires when |
|---|
payout.paid | payout | A creator payout is paid out |
payout.paid is a creator-level event: it reports a single withdrawal to
the creator, not a checkout-link sale, and is not scoped to any one link. It is
not a settlement statement; expect one event per withdrawal.
data object.
Payout resource
| Field | Type | Description |
|---|
object | string | Always "payout" |
id | string | Withdrawal invoice number (e.g. FVW-12345) |
status | string | Always "paid" |
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 |
creator | object | { uuid } of the creator |
The payout resource does not carry client_reference_id, metadata, or a
purchaser, as it is not tied to a specific checkout payment.
Example: payout.paid
{
"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" }
}
}
