collateral.deposited
Sent after a collateral deposit has been observed and finalized for a payer.
Use it to refresh available collateral, enable payment features, or update a
wallet dashboard.
Event fields
string
required
Unique webhook event ID. Store it for deduplication.
string
required
collateral.deposited
string
required
ISO 8601 datetime
string
required
object
required
string
required
Wallet that owns the deposited collateral.
string
required
Deposited token address. The zero address represents ETH.
string
required
Deposit amount in token base units.
string
required
network identifier.
string
required
number
required
string
required
finalized
Event examples
Payload
Recommended handling
- Verify the signature against the raw request body before parsing.
- Return
2xxonly after the event is durably queued or processed. - Refresh collateral from the authoritative API instead of treating the event as the complete wallet state.
- Display amounts using the asset decimals returned by
GET /core/tokens. - Ignore duplicate deliveries with the same event
id.