layer1:crypto:consolidation:status-change

Webhook Payload Structure

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

{
  "event": "layer1:digital:consolidation:status-change",
  "timestamp": "2024-05-09T06:11:13.976035981Z",
  "data": {
    "id": "018f5bfa2e9a74edbcbb60fccbe7e842a4e464fb30554fe2a5cb4ed39a14408969",
    "address": {
      "id": "a4e464fb-3055-4fe2-a5cb-4ed39a144089",
      "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
      "assetPoolId": "b85cdc60-29da-4b2a-b28c-248e38cef764",
      "network": "ETHEREUM",
      "keyPairId": "59d0e545-2985-46c2-a834-7ab5199abbd4",
      "reference": "REF-127558124LT181Y1I"
    },
    "reference": "consolidation-018f5bf8-f9c3-77bb-abc7-0b0597001ba1",
    "status": "CREATED",
    "sources": [
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "0.00050889650541582",
        "asset": "ETH"
      },
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "100.00",
        "asset": "USDT"
      }
    ],
    "destinations": [
      {
        "address": "0xd399fe8c3914c9dc9f218c912c264d616e32a5ab",
        "amount": "100.00",
        "asset": "USDT"
      }
    ],
    "type": "CONSOLIDATION",
    "asset": "USDT",
    "amount": "100.00",
    "createdAt": "2024-05-09T06:11:13.690Z",
    "updatedAt": "2024-05-09T06:11:13.958481Z"
  }
}
{
  "event": "layer1:digital:consolidation:status-change",
  "timestamp": "2024-05-09T06:11:14.208226824Z",
  "data": {
    "id": "018f5bfa2e9a74edbcbb60fccbe7e842a4e464fb30554fe2a5cb4ed39a14408969",
    "address": {
      "id": "a4e464fb-3055-4fe2-a5cb-4ed39a144089",
      "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
      "assetPoolId": "b85cdc60-29da-4b2a-b28c-248e38cef764",
      "network": "ETHEREUM",
      "keyPairId": "59d0e545-2985-46c2-a834-7ab5199abbd4",
      "reference": "REF-127558124LT181Y1I"
    },
    "reference": "consolidation-018f5bf8-f9c3-77bb-abc7-0b0597001ba1",
    "status": "SIGNED",
    "sources": [
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "0.00050889650541582",
        "asset": "ETH"
      },
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "100.00",
        "asset": "USDT"
      }
    ],
    "destinations": [
      {
        "address": "0xd399fe8c3914c9dc9f218c912c264d616e32a5ab",
        "amount": "100.00",
        "asset": "USDT"
      }
    ],
    "type": "CONSOLIDATION",
    "asset": "USDT",
    "amount": "100.00",
    "createdAt": "2024-05-09T06:11:13.690Z",
    "updatedAt": "2024-05-09T06:11:14.188735Z"
  }
}
{
  "event": "layer1:digital:consolidation:status-change",
  "timestamp": "2024-05-09T06:11:14.747080547Z",
  "data": {
    "id": "018f5bfa2e9a74edbcbb60fccbe7e842a4e464fb30554fe2a5cb4ed39a14408969",
    "address": {
      "id": "a4e464fb-3055-4fe2-a5cb-4ed39a144089",
      "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
      "assetPoolId": "b85cdc60-29da-4b2a-b28c-248e38cef764",
      "network": "ETHEREUM",
      "keyPairId": "59d0e545-2985-46c2-a834-7ab5199abbd4",
      "reference": "REF-127558124LT181Y1I"
    },
    "reference": "consolidation-018f5bf8-f9c3-77bb-abc7-0b0597001ba1",
    "status": "DETECTED",
    "sources": [
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "100.00"
      }
    ],
    "destinations": [
      {
        "address": "0xd399fe8c3914c9dc9f218c912c264d616e32a5ab",
        "amount": "100.00"
      }
    ],
    "type": "CONSOLIDATION",
    "asset": "USDT",
    "amount": "100.00",
    "hash": "0x74b832f44c3405846bd9a881feca9f9903bf78cca42d5706bc1cec6bc7871685",
    "createdAt": "2024-05-09T06:11:13.690Z",
    "updatedAt": "2024-05-09T06:11:14.726244Z"
  }
}
{
  "event": "layer1:digital:consolidation:status-change",
  "timestamp": "2024-05-09T06:11:29.376821677Z",
  "data": {
    "id": "018f5bfa2e9a74edbcbb60fccbe7e842a4e464fb30554fe2a5cb4ed39a14408969",
    "address": {
      "id": "a4e464fb-3055-4fe2-a5cb-4ed39a144089",
      "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
      "assetPoolId": "b85cdc60-29da-4b2a-b28c-248e38cef764",
      "network": "ETHEREUM",
      "keyPairId": "59d0e545-2985-46c2-a834-7ab5199abbd4",
      "reference": "REF-127558124LT181Y1I"
    },
    "reference": "consolidation-018f5bf8-f9c3-77bb-abc7-0b0597001ba1",
    "status": "UNCONFIRMED",
    "sources": [
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "0.00023986962523329",
        "asset": "ETH"
      },
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "100.00",
        "asset": "USDT"
      }
    ],
    "destinations": [
      {
        "address": "0xd399fe8c3914c9dc9f218c912c264d616e32a5ab",
        "amount": "100.00",
        "asset": "USDT"
      }
    ],
    "type": "CONSOLIDATION",
    "asset": "USDT",
    "amount": "100.00",
    "hash": "0x74b832f44c3405846bd9a881feca9f9903bf78cca42d5706bc1cec6bc7871685",
    "networkDetail": {
      "block": {
        "number": 5865626,
        "timestamp": "2024-05-09T06:11:24Z"
      },
      "fee": {
        "amount": "0.00023986962523329",
        "asset": "ETH"
      }
    },
    "createdAt": "2024-05-09T06:11:13.690Z",
    "updatedAt": "2024-05-09T06:11:29.352098Z"
  }
}
{
  "event": "layer1:digital:consolidation:status-change",
  "timestamp": "2024-05-09T06:12:29.567534241Z",
  "data": {
    "id": "018f5bfa2e9a74edbcbb60fccbe7e842a4e464fb30554fe2a5cb4ed39a14408969",
    "address": {
      "id": "a4e464fb-3055-4fe2-a5cb-4ed39a144089",
      "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
      "assetPoolId": "b85cdc60-29da-4b2a-b28c-248e38cef764",
      "network": "ETHEREUM",
      "keyPairId": "59d0e545-2985-46c2-a834-7ab5199abbd4",
      "reference": "REF-127558124LT181Y1I"
    },
    "reference": "consolidation-018f5bf8-f9c3-77bb-abc7-0b0597001ba1",
    "status": "CONFIRMED",
    "sources": [
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "100.00",
        "asset": "USDT"
      },
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "0.00023986962523329",
        "asset": "ETH"
      }
    ],
    "destinations": [
      {
        "address": "0xd399fe8c3914c9dc9f218c912c264d616e32a5ab",
        "amount": "100.00",
        "asset": "USDT"
      }
    ],
    "type": "CONSOLIDATION",
    "asset": "USDT",
    "amount": "100.00",
    "hash": "0x74b832f44c3405846bd9a881feca9f9903bf78cca42d5706bc1cec6bc7871685",
    "networkDetail": {
      "block": {
        "number": 5865626,
        "timestamp": "2024-05-09T06:11:24Z"
      },
      "fee": {
        "amount": "0.00023986962523329",
        "asset": "ETH"
      }
    },
    "createdAt": "2024-05-09T06:11:13.690Z",
    "updatedAt": "2024-05-09T06:12:29.545914Z"
  }
}
{
  "event": "layer1:digital:consolidation:status-change",
  "timestamp": "2024-05-09T06:12:29.702705023Z",
  "data": {
    "id": "018f5bfa2e9a74edbcbb60fccbe7e842a4e464fb30554fe2a5cb4ed39a14408969",
    "address": {
      "id": "a4e464fb-3055-4fe2-a5cb-4ed39a144089",
      "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
      "assetPoolId": "b85cdc60-29da-4b2a-b28c-248e38cef764",
      "network": "ETHEREUM",
      "keyPairId": "59d0e545-2985-46c2-a834-7ab5199abbd4",
      "reference": "REF-127558124LT181Y1I"
    },
    "reference": "consolidation-018f5bf8-f9c3-77bb-abc7-0b0597001ba1",
    "status": "SUCCESS",
    "sources": [
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "100.00",
        "asset": "USDT"
      },
      {
        "address": "0x1bade4a7ab3f43ef98ee90045d72f70031904c84",
        "amount": "0.00023986962523329",
        "asset": "ETH"
      }
    ],
    "destinations": [
      {
        "address": "0xd399fe8c3914c9dc9f218c912c264d616e32a5ab",
        "amount": "100.00",
        "asset": "USDT"
      }
    ],
    "type": "CONSOLIDATION",
    "asset": "USDT",
    "amount": "100.00",
    "hash": "0x74b832f44c3405846bd9a881feca9f9903bf78cca42d5706bc1cec6bc7871685",
    "networkDetail": {
      "block": {
        "number": 5865626,
        "timestamp": "2024-05-09T06:11:24Z"
      },
      "fee": {
        "amount": "0.00023986962523329",
        "asset": "ETH"
      }
    },
    "createdAt": "2024-05-09T06:11:13.690Z",
    "updatedAt": "2024-05-09T06:12:29.680325Z"
  }
}

Field Descriptions

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

FieldTypeDescription
eventstringIdentifies the type of event, e.g., "layer1:digital:consolidation:status-change"
timestampstringISO 8601 formatted date and time when the event was generated.
dataobjectContains detailed information about the event.
data.idstringUnique identifier for the event.
data.addressobjectDetails of the address involved in the consolidation.
data.address.idstringUnique identifier for the address object.
data.address.addressstringThe cryptocurrency address involved.
data.address.assetPoolIdstringIdentifier of the asset pool this address belongs to, in GUID format.
data.address.networkstringThe network for the cryptocurrency address.
data.address.keyPairIdstringIdentifier for the key pair associated with the address, in GUID format.
data.address.referencestringA reference identifier linked to the address.
data.referencestringA general reference identifier for the consolidation event.
data.statusstringCurrent status of the consolidation [CREATED, SIGNED, DETECTED, UNCONFIRMED, CONFIRMED, SUCCESS].
data.sources[]arrayArray of source addresses and amounts involved in the consolidation.
data.sources[].addressstringThe source address involved in the transaction.
data.sources[].amountstringThe amount of the asset being transferred from the source address.
data.sources[].assetstringType of asset being transferred.
data.destinations[]arrayArray of destination addresses and amounts being transferred.
data.destinations[].addressstringThe destination address involved in the transaction.
data.destinations[].amountstringThe amount of the asset being transferred to the destination address.
data.destinations[].assetstringType of asset being transferred.
data.typestringType of transaction.
data.assetstringType of asset involved in the transaction.
data.amountstringTotal amount of the asset being consolidated.
data.hashstringTransaction hash.
data.networkDetailobjectAdditional details about the network state at the time of the transaction.
data.networkDetail.blockobjectBlock information relevant to the transaction.
data.networkDetail.block.numberstringBlock number associated with the transaction.
data.networkDetail.block.timestampstringTimestamp of the block.
data.networkDetail.feeobjectFee information related to the transaction.
data.networkDetail.fee.amountstringAmount of the fee charged.
data.networkDetail.fee.assetstringAsset type of the fee.
data.createdAtstringISO 8601 formatted date and time when the data was created.
data.updatedAtstringISO 8601 formatted date and time when the data was last updated.