layer1:crypto:deposit:status-change

Webhook Payload Structure

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

{
  event: "layer1:crypto:deposit:status-change",
  timestamp: "2024-05-01T11:55:23.676068369Z",
  data: {
    id: "018f3402631176798ab2d431929f53b938d51d4b3ef64c809cb73eb884cc7c306f",
    address: {
      id: "38d51d4b-3ef6-4c80-9cb7-3eb884cc7c30",
      address: "0xf6483454996bce404d62656eb3cbcf87232dc153",
      assetPoolId: "e0579d29-987a-440c-b78b-26067b49bc96",
      network: "ETHEREUM",
      keyPairId: "173cfb47-3ce1-4550-98bc-2da2f1cb866b",
      reference: "fcd4687e-5bc7-41e0-ba5a-d2f13a857ee7",
    },
    reference: null,
    status: "DETECTED",
    sources: [
      {
        address: "0xae9e8a1235e1113f936a38492c70fbb4ee297cdb",
        amount: "0.001",
      },
    ],
    destinations: [
      {
        address: "0xf6483454996bce404d62656eb3cbcf87232dc153",
        amount: "0.001",
      },
    ],
    type: "DEPOSIT",
    asset: "ETH",
    amount: "0.001",
    hash: "0x5fee8f91e72d6baba7b95af5a031ea3b3e1ae527009f401b5403a3c2f3294530",
    networkDetail: null,
    metadata: null,
    createdAt: "2024-05-01T11:55:22.769Z",
    updatedAt: "2024-05-01T11:55:23.545773Z",
  },
};

{
  event: "layer1:crypto:deposit:status-change",
  timestamp: "2024-05-01T11:55:28.579411700Z",
  data: {
    id: "018f3402631176798ab2d431929f53b938d51d4b3ef64c809cb73eb884cc7c306f",
    address: {
      id: "38d51d4b-3ef6-4c80-9cb7-3eb884cc7c30",
      address: "0xf6483454996bce404d62656eb3cbcf87232dc153",
      assetPoolId: "e0579d29-987a-440c-b78b-26067b49bc96",
      network: "ETHEREUM",
      keyPairId: "173cfb47-3ce1-4550-98bc-2da2f1cb866b",
      reference: "fcd4687e-5bc7-41e0-ba5a-d2f13a857ee7",
    },
    reference: null,
    status: "UNCONFIRMED",
    sources: [
      {
        address: "0xae9e8a1235e1113f936a38492c70fbb4ee297cdb",
        amount: "0.000038485390062",
      },
      {
        address: "0xae9e8a1235e1113f936a38492c70fbb4ee297cdb",
        amount: "0.001",
      },
    ],
    destinations: [
      {
        address: "0xf6483454996bce404d62656eb3cbcf87232dc153",
        amount: "0.001",
      },
    ],
    type: "DEPOSIT",
    asset: "ETH",
    amount: "0.001",
    hash: "0x5fee8f91e72d6baba7b95af5a031ea3b3e1ae527009f401b5403a3c2f3294530",
    networkDetail: {
      block: { number: 5814953, timestamp: "2024-05-01T11:55:24Z" },
      fee: { amount: "0.000038485390062", asset: "ETH" },
    },
    metadata: null,
    createdAt: "2024-05-01T11:55:22.769Z",
    updatedAt: "2024-05-01T11:55:28.535125Z",
  },
};

{
  event: "layer1:crypto:deposit:status-change",
  timestamp: "2024-05-01T11:55:28.579411700Z",
  data: {
    id: "018f3402631176798ab2d431929f53b938d51d4b3ef64c809cb73eb884cc7c306f",
    address: {
      id: "38d51d4b-3ef6-4c80-9cb7-3eb884cc7c30",
      address: "0xf6483454996bce404d62656eb3cbcf87232dc153",
      assetPoolId: "e0579d29-987a-440c-b78b-26067b49bc96",
      network: "ETHEREUM",
      keyPairId: "173cfb47-3ce1-4550-98bc-2da2f1cb866b",
      reference: "fcd4687e-5bc7-41e0-ba5a-d2f13a857ee7",
    },
    reference: null,
    status: "CONFIRMED",
    sources: [
      {
        address: "0xae9e8a1235e1113f936a38492c70fbb4ee297cdb",
        amount: "0.000038485390062",
      },
      {
        address: "0xae9e8a1235e1113f936a38492c70fbb4ee297cdb",
        amount: "0.001",
      },
    ],
    destinations: [
      {
        address: "0xf6483454996bce404d62656eb3cbcf87232dc153",
        amount: "0.001",
      },
    ],
    type: "DEPOSIT",
    asset: "ETH",
    amount: "0.001",
    hash: "0x5fee8f91e72d6baba7b95af5a031ea3b3e1ae527009f401b5403a3c2f3294530",
    networkDetail: {
      block: { number: 5814953, timestamp: "2024-05-01T11:55:24Z" },
      fee: { amount: "0.000038485390062", asset: "ETH" },
    },
    metadata: null,
    createdAt: "2024-05-01T11:55:22.769Z",
    updatedAt: "2024-05-01T11:55:28.535125Z",
  },
};

{
  event: "layer1:crypto:deposit:status-change",
  timestamp: "2024-05-01T11:56:29.064464799Z",
  data: {
    id: "018f3402631176798ab2d431929f53b938d51d4b3ef64c809cb73eb884cc7c306f",
    address: {
      id: "38d51d4b-3ef6-4c80-9cb7-3eb884cc7c30",
      address: "0xf6483454996bce404d62656eb3cbcf87232dc153",
      assetPoolId: "e0579d29-987a-440c-b78b-26067b49bc96",
      network: "ETHEREUM",
      keyPairId: "173cfb47-3ce1-4550-98bc-2da2f1cb866b",
      reference: "fcd4687e-5bc7-41e0-ba5a-d2f13a857ee7",
    },
    reference: null,
    status: "SCREENING_REQUESTED",
    sources: [
      {
        address: "0xae9e8a1235e1113f936a38492c70fbb4ee297cdb",
        amount: "0.000038485390062",
      },
      {
        address: "0xae9e8a1235e1113f936a38492c70fbb4ee297cdb",
        amount: "0.001",
      },
    ],
    destinations: [
      {
        address: "0xf6483454996bce404d62656eb3cbcf87232dc153",
        amount: "0.001",
      },
    ],
    type: "DEPOSIT",
    asset: "ETH",
    amount: "0.001",
    hash: "0x5fee8f91e72d6baba7b95af5a031ea3b3e1ae527009f401b5403a3c2f3294530",
    networkDetail: {
      block: { number: 5814953, timestamp: "2024-05-01T11:55:24Z" },
      fee: { amount: "0.000038485390062", asset: "ETH" },
    },
    metadata: null,
    createdAt: "2024-05-01T11:55:22.769Z",
    updatedAt: "2024-05-01T11:56:28.994764Z",
  },
};

{
  event: "layer1:crypto:deposit:status-change",
  timestamp: "2024-05-01T11:56:36.625504360Z",
  data: {
    id: "018f3402631176798ab2d431929f53b938d51d4b3ef64c809cb73eb884cc7c306f",
    address: {
      id: "38d51d4b-3ef6-4c80-9cb7-3eb884cc7c30",
      address: "0xf6483454996bce404d62656eb3cbcf87232dc153",
      assetPoolId: "e0579d29-987a-440c-b78b-26067b49bc96",
      network: "ETHEREUM",
      keyPairId: "173cfb47-3ce1-4550-98bc-2da2f1cb866b",
      reference: "fcd4687e-5bc7-41e0-ba5a-d2f13a857ee7",
    },
    reference: null,
    status: "SUCCESS",
    sources: [
      {
        address: "0xae9e8a1235e1113f936a38492c70fbb4ee297cdb",
        amount: "0.000038485390062",
      },
      {
        address: "0xae9e8a1235e1113f936a38492c70fbb4ee297cdb",
        amount: "0.001",
      },
    ],
    destinations: [
      {
        address: "0xf6483454996bce404d62656eb3cbcf87232dc153",
        amount: "0.001",
      },
    ],
    type: "DEPOSIT",
    asset: "ETH",
    amount: "0.001",
    hash: "0x5fee8f91e72d6baba7b95af5a031ea3b3e1ae527009f401b5403a3c2f3294530",
    networkDetail: {
      block: { number: 5814953, timestamp: "2024-05-01T11:55:24Z" },
      fee: { amount: "0.000038485390062", asset: "ETH" },
    },
    metadata: null,
    createdAt: "2024-05-01T11:55:22.769Z",
    updatedAt: "2024-05-01T11:56:36.513590Z",
  },
};

Field Descriptions

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

Field	Type	Description
`event`	string	Identifies the type of event. Example: "layer1:crypto:deposit:status-change"
`timestamp`	string	ISO 8601 formatted date and time when the event was generated.
`data`	object	Contains detailed information about the event.
`data.id`	string	Unique identifier for the event.
`data.address`	object	Detailed information about the address involved in the deposit.
`data.address.id`	string	Unique identifier for the address object, in GUID format.
`data.address.address`	string	The cryptocurrency address involved.
`data.address.assetPoolId`	string	Identifier of the asset pool this address belongs to, in GUID format.
`data.address.network`	string	The network for the cryptocurrency address
`data.address.keyPairId`	string	Identifier for the key pair associated with the address, in GUID format.
`data.address.reference`	string	A reference identifier linked to the creation of this address.
`data.reference`	null/string	A general reference identifier, can be null.
`data.status`	string	Current status of the deposit [DETECTED, UNCONFIRMED, CONFIRMED, SCREENING_REQUESTED, SUCCESS].
`data.sources[]`	array	Array of source addresses and amounts involved in the transaction.
`data.destinations[]`	array	Array of destination addresses and amounts involved in the transaction.
`data.type`	string	Type of transaction.
`data.asset`	string	Type of asset involved in the transaction.
`data.amount`	string	Amount of the asset involved in the transaction.
`data.hash`	string	Transaction hash.
`data.networkDetail`	null	Additional network-specific details, can be null.
`data.metadata`	null	Additional metadata related to the event, can be null.
`data.createdAt`	string	ISO 8601 formatted date and time when the data was created.
`data.updatedAt`	string	ISO 8601 formatted date and time when the data was last updated.