layer1:digital:balance:updated

Webhook Payload Structure

The webhook notification sends a JSON object containing details about the event. Here is the example payloads:

{
  "event": "layer1:digital:balance:updated",
  "timestamp": "2024-06-05T20:40:16.941138099Z",
  "data": {
    "reference": "First Eth Address",
    "address": "0xc4b21fb39aaf5fc07d3cd4420bf3ee74a61642e9",
    "asset": "ETH",
    "funds": [
      {
        "type": "AVAILABLE",
        "balance": "0.00",
        "delta": "0.00"
      },
      {
        "type": "BLOCKCHAIN",
        "balance": "0.20",
        "delta": "0.20"
      },
      {
        "type": "RESERVED",
        "balance": "0.20",
        "delta": "0.20"
      }
    ]
  }
}

Field Descriptions

Below is a detailed explanation of each field in the webhook payload:

Field	Description
event	The type of event that triggered the webhook.
timestamp	The time when the event occurred in ISO 8601 format.
data	A nested object containing details of the balance update.
data.reference	A unique reference for the crypto address.
data.address	The crypto address involved in the balance update.
data.asset	The type of cryptocurrency asset.
data.funds	An array containing details of the fund balances.
data.funds.type	The type of fund balance [AVAILABLE, BLOCKCHAIN, RESERVED].
data.funds.balance	The current balance of the fund type.
data.funds.delta	The change in balance for the fund type.