Channel payment status change notification

Sent to the notification URL when it was provided at related channel creation; otherwise to the webhook URL configured in Fuzebox.

TypeDescription
channel_payment_detectedDeposit seen on-chain, awaiting confirmation and crediting (status PROCESSING)
channel_payment_completedDeposit credited to the wallet (status COMPLETED)
channel_payment_cancelledDeposit 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.

Header Parameters

Content-Type*string

Content type.

Default"application/json"
User-Agent*string

User agent.

Default"Volt/2.0"
X-Volt-Timed*integer

Timestamp of notification generation.

X-Volt-Signed*string

Notification signature.

X-Volt-Type*string

Type of channel payment notification.

Value in

  • "channel_payment_detected"
  • "channel_payment_completed"
  • "channel_payment_cancelled"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

An incoming on-chain deposit received on a channel and converted into the channel's crediting wallet. The transaction object carries the on-chain evidence; credited and rate are null until the conversion settles. This object is also the payload of the channel payment webhooks.

Response Body

application/json

Example Requests

POST/Channel payment