Skip to main content
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

​
id
string
required
Unique webhook event ID. Store it for deduplication.
​
type
string
required
collateral.deposited
​
created_at
string
required
ISO 8601 datetime
​
api_version
string
required
​
data
object
required
​
data.user_address
string
required
Wallet that owns the deposited collateral.
​
data.asset_address
string
required
Deposited token address. The zero address represents ETH.
​
data.amount
string
required
Deposit amount in token base units.
​
data.network
string
required
network identifier.
​
data.transaction_hash
string
required
​
data.block_number
number
required
​
data.status
string
required
finalized

​
Event examples

Payload
{
  "id": "evt_01JY3K8F4TQ9M5C2N7A6B1D0EP",
  "type": "collateral.deposited",
  "created_at": "2026-06-22T14:30:00.000Z",
  "api_version": "2026-06-01",
  "data": {
    "user_address": "0x1111111111111111111111111111111111111111",
    "asset_address": "0x3333333333333333333333333333333333333333",
    "amount": "10000000",
    "network": "eip155:84532",
    "transaction_hash": "0xDepositTransaction",
    "block_number": 28123456,
    "status": "finalized"
  }
}
  • Verify the signature against the raw request body before parsing.
  • Return 2xx only 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.
See deposits and withdrawals.