Payout status change notification
Sent to the notification URL when it was provided at payout creation; otherwise to the webhook URL configured in Fuzebox.
| Type | Description |
|---|---|
payout_processing | Payout submitted for execution at the provider (status PROCESSING) |
payout_completed | Payout sent (status COMPLETED) |
payout_failed | Payout failed or was returned by the provider (status FAILED, see failureReason) |
payout_cancelled | Payout cancelled (status CANCELLED) |
Each event is sent at most once, but payout_processing is not guaranteed: a payout that fails before it reaches the provider (for example, insufficient funds) goes straight to payout_failed without ever emitting payout_processing. Treat payout_completed, payout_failed, and payout_cancelled as the source of truth, and do not rely on receiving payout_processing beforehand.
Delivery order is not guaranteed either, so do not rely on the order in which webhooks arrive: each payload is the payout's state at the moment it was sent, so a later-arriving webhook can validly describe an earlier moment than one you already received. Always take status from the payload itself rather than inferring it from arrival order.
Header Parameters
Content type.
"application/json"User agent.
"Volt/2.0"Timestamp of notification generation.
Notification signature.
Type of payout notification.
Value in
- "payout_processing"
- "payout_completed"
- "payout_failed"
- "payout_cancelled"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
Example Requests
/PayoutChannel payment status change notification Webhook
Sent to the notification URL when it was provided at related channel creation; otherwise to the webhook URL configured in Fuzebox. | Type | Description | |-------|-------------| | `channel_payment_detected` | Deposit seen on-chain, awaiting confirmation and crediting (`status` `PROCESSING`) | | `channel_payment_completed` | Deposit credited to the wallet (`status` `COMPLETED`) | | `channel_payment_cancelled` | Deposit cancelled or rejected (`status` `CANCELLED`) | `channel_payment_detected` is **not guaranteed**: when a deposit reaches its final state before the detection could be announced (for example, the confirmation arrived first), only the terminal webhook is sent. Treat `channel_payment_completed` and `channel_payment_cancelled` as the source of truth, and do not rely on receiving `channel_payment_detected` beforehand.
Volt Gateway API (legacy)
View OpenAPI Schemas.