Webhook Body (Events, Source and Data)

The body of a webhook can be divided into three different sections, source, event , and data. Source will tell you the product source of the webhook, the event will be what event has occurred within that source, and data will be all of the relevant payment information sent with the webhook.

Not all event types exist in each source, check the use case guides to see what webhooks apply to each type of use case.

Source types:

Source	Description
channel	Webhook is associated with a channel payment.
payment	Webhook associated with either a payment in/deposit, or payment out/withdrawal

Event types:

Event	Description
`layer1:payment:checkout:status-change`	Happens twice, the status of the payment has changed, either from `pending` to `processing`, or from `processing` to `complete`.
`layer1:payment:checkout:transaction-confirmed`	The payment the end-user sent has been confirmed on the blockchain and funds have been credited to your merchant account.
`layer1:payment:checkout:transaction-detected`	The end-user has sent a payment and it has been detected on the blockchain but has not yet had the required number of block confirmations.
`layer1:payment:checkout:transaction-late`	The end-user has sent funds to a payment that is already in an `expired`, `complete`, or `underpaid` state, or completed multiple payments to the same address.
`layer1:payment:checkout:transaction-held`	A payment has been placed on hold for screening.
`layer1:payment:checkout:transaction-settled`	A payment has been settled.

Data types

Data in each webhook will have changing fields depending on the source of webhook, but we will highlight some of the most important fields here:

Field	Description
`uuid`	UUID of the linked payment, will remain the same across all webhook types for that payment.
`type`	The type of payment, can be in for deposit or OUT for withdrawal
`status`	The current status of the payment. `EXPIRED`, `UNDERPAID` and `COMPLETE` statuses are all final.
`displayCurrency`	The amounts in the selected display currency that the end user will see.
`paidCurrency`	The amounts in the currency actually sent by the end user when fulfilling the payment.
`walletCurrency`	The amounts in the settlement or wallet currency linked to the payment.
`amount`	The amount requested when creating a payment.
`actual`	The actual amount of money sent once the payment is confirmed on the blockchain.
`transactions`	The array of transactions linked to the payment, if multiple payments are sent to the same address, they will all appear here.

Examples of Webhook Types:

Payment In Webhooks

{
  "source": "payment",
  "event": "layer1:payment:checkout:transaction-detected",
  "data": {
    "uuid": "d993b0bc-dace-4742-81d8-6ae629dab063",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709895600000,
    "expiryDate": 1709982000000,
    "quoteExpiryDate": 1709982000000,
    "acceptanceExpiryDate": 1709895667000,
    "quoteStatus": "ACCEPTED",
    "reference": "test_reference_in_0plkzH",
    "type": "IN",
    "subType": "merchantPayIn",
    "status": "PENDING",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 0
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276415,
      "actual": 0
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.00276415,
      "actual": 0
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00002764,
      "actual": 0
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 3617.748674999548
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0xc4d8b4b0e0601f49c88f41c4a9490f0d7f4ceed0",
      "tag": null,
      "protocol": "ETH",
      "uri": "ethereum:0xc4d8b4b0e0601f49c88f41c4a9490f0d7f4ceed0?value=2.76415E+15",
      "alternatives": []
    },
    "returnUrl": "https://www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709895679212,
        "dateConfirmed": null,
        "hash": "0x3d8ff17b4a2be304eff0ece0373f538f5e1a19e637652466c9ab15c599b6d91b",
        "amount": 0,
        "risk": null,
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": null,
        "sources": null,
        "displayRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 3617.748674999548
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": "ETH",
        "isOnHold": false
      }
    ],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:status-change",
  "data": {
    "uuid": "d993b0bc-dace-4742-81d8-6ae629dab063",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709895600000,
    "expiryDate": 1709982000000,
    "quoteExpiryDate": 1709982000000,
    "acceptanceExpiryDate": 1709895667000,
    "quoteStatus": "ACCEPTED",
    "reference": "test_reference_in_0plkzH",
    "type": "IN",
    "subType": "merchantPayIn",
    "status": "PROCESSING",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 0
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276415,
      "actual": 0
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.00276415,
      "actual": 0
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00002764,
      "actual": 0
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 3617.748674999548
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0xc4d8b4b0e0601f49c88f41c4a9490f0d7f4ceed0",
      "tag": null,
      "protocol": "ETH",
      "uri": "ethereum:0xc4d8b4b0e0601f49c88f41c4a9490f0d7f4ceed0?value=2.76415E+15",
      "alternatives": []
    },
    "returnUrl": "https://www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709895679212,
        "dateConfirmed": null,
        "hash": "0x3d8ff17b4a2be304eff0ece0373f538f5e1a19e637652466c9ab15c599b6d91b",
        "amount": 0,
        "risk": null,
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": null,
        "sources": null,
        "displayRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 3617.748674999548
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": "ETH",
        "isOnHold": false
      }
    ],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:transaction-confirmed",
  "data": {
    "uuid": "d993b0bc-dace-4742-81d8-6ae629dab063",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709895600000,
    "expiryDate": 1709982000000,
    "quoteExpiryDate": 1709982000000,
    "acceptanceExpiryDate": 1709895667000,
    "quoteStatus": "ACCEPTED",
    "reference": "test_reference_in_0plkzH",
    "type": "IN",
    "subType": "merchantPayIn",
    "status": "PROCESSING",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 0
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276415,
      "actual": 0
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.00276415,
      "actual": 0.00276415
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00002764,
      "actual": 0
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 3617.748674999548
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0xc4d8b4b0e0601f49c88f41c4a9490f0d7f4ceed0",
      "tag": null,
      "protocol": "ETH",
      "uri": "ethereum:0xc4d8b4b0e0601f49c88f41c4a9490f0d7f4ceed0?value=2.76415E+15",
      "alternatives": []
    },
    "returnUrl": "https://www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709895679000,
        "dateConfirmed": 1709895776194,
        "hash": "0x3d8ff17b4a2be304eff0ece0373f538f5e1a19e637652466c9ab15c599b6d91b",
        "amount": 0.00276415,
        "risk": {
          "level": "LOW",
          "resourceName": null,
          "resourceCategory": null,
          "alerts": []
        },
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": 0.000033940950855,
        "sources": [
          "0x84a4a239805d06c685219801b82bea7c76702214"
        ],
        "displayRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 3617.748674999548
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": "ETH",
        "isOnHold": false
      }
    ],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:status-change",
  "data": {
    "uuid": "d993b0bc-dace-4742-81d8-6ae629dab063",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709895600000,
    "expiryDate": 1709982000000,
    "quoteExpiryDate": 1709982000000,
    "acceptanceExpiryDate": 1709895667000,
    "quoteStatus": "ACCEPTED",
    "reference": "test_reference_in_0plkzH",
    "type": "IN",
    "subType": "merchantPayIn",
    "status": "COMPLETE",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 10
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276415,
      "actual": 0.00276415
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.00276415,
      "actual": 0.00276415
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00002764,
      "actual": 0.00002764
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 3617.748674999548
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0xc4d8b4b0e0601f49c88f41c4a9490f0d7f4ceed0",
      "tag": null,
      "protocol": "ETH",
      "uri": "ethereum:0xc4d8b4b0e0601f49c88f41c4a9490f0d7f4ceed0?value=2.76415E+15",
      "alternatives": []
    },
    "returnUrl": "https://www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709895679000,
        "dateConfirmed": 1709895776000,
        "hash": "0x3d8ff17b4a2be304eff0ece0373f538f5e1a19e637652466c9ab15c599b6d91b",
        "amount": 0.00276415,
        "risk": {
          "level": "LOW",
          "resourceName": null,
          "resourceCategory": null,
          "alerts": []
        },
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": 0.00003394,
        "sources": [
          "0x84a4a239805d06c685219801b82bea7c76702214"
        ],
        "displayRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 3617.748674999548
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": "ETH",
        "isOnHold": false
      }
    ],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:status-change",
  "data": {
    "uuid": "c11b0f66-2e7f-4ff0-9963-e485511ae49f",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709896743000,
    "expiryDate": 1709896862203,
    "quoteExpiryDate": null,
    "acceptanceExpiryDate": null,
    "quoteStatus": "TEMPLATE",
    "reference": "test_reference_in_ewmnnj",
    "type": "IN",
    "subType": "merchantPayIn",
    "status": "EXPIRED",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 0
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276456,
      "actual": 0
    },
    "paidCurrency": {
      "currency": null,
      "amount": 0,
      "actual": 0
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0,
      "actual": 0
    },
    "displayRate": null,
    "exchangeRate": null,
    "address": null,
    "returnUrl": "https://www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:status-change",
  "data": {
    "uuid": "83e3287c-540e-4f43-8953-e5b2db646ca5",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709895979000,
    "expiryDate": 1709982379000,
    "quoteExpiryDate": 1709982379000,
    "acceptanceExpiryDate": 1709896020000,
    "quoteStatus": "ACCEPTED",
    "reference": "test_reference_in_LGkyRO",
    "type": "IN",
    "subType": "merchantPayIn",
    "status": "UNDERPAID",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 3.62
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276601,
      "actual": 0.001
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.00276601,
      "actual": 0.001
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00002766,
      "actual": 0.00001
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 3615.315924382052
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0xe4828053f59d310ee50984d0cd84b622cc03b19f",
      "tag": null,
      "protocol": "ETH",
      "uri": "ethereum:0xe4828053f59d310ee50984d0cd84b622cc03b19f?value=2.76601E+15",
      "alternatives": []
    },
    "returnUrl": "https://www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709896040000,
        "dateConfirmed": 1709896133000,
        "hash": "0xb8a33c20e4e0c6f747e87e1e632e9cdf22e62f0a99a18faefc7e327b85f8537d",
        "amount": 0.001,
        "risk": {
          "level": "LOW",
          "resourceName": null,
          "resourceCategory": null,
          "alerts": []
        },
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": 0.0000355,
        "sources": [
          "0x84a4a239805d06c685219801b82bea7c76702214"
        ],
        "displayRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 3615.315924382052
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": "ETH",
        "isOnHold": false
      }
    ],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:transaction-late",
  "data": {
    "uuid": "1401c32a-f8c1-49d9-a24c-5ae81b0ea2b3",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709897205000,
    "expiryDate": 1709897284000,
    "quoteExpiryDate": 1709897265000,
    "acceptanceExpiryDate": 1709897245000,
    "quoteStatus": "ACCEPTED",
    "reference": "test_reference_in_d1plQ7",
    "type": "IN",
    "subType": "merchantPayIn",
    "status": "EXPIRED",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 10
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.0027682,
      "actual": 0.0027682
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.0027682,
      "actual": 0.0027682
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00002768,
      "actual": 0.00002768
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 3612.455747417094
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0x8c12686c4277ae7b48a2cf19256cc29ba2184bf5",
      "tag": null,
      "protocol": "ETH",
      "uri": "ethereum:0x8c12686c4277ae7b48a2cf19256cc29ba2184bf5?value=2.7682E+15",
      "alternatives": []
    },
    "returnUrl": "https://www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709897305000,
        "dateConfirmed": 1709897394000,
        "hash": "0x8aa160b0b175624b5381f100d9b9ffbff199e65c6e53335b596aee926d831b42",
        "amount": 0.0027682,
        "risk": {
          "level": "LOW",
          "resourceName": null,
          "resourceCategory": null,
          "alerts": []
        },
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": 0.00005765,
        "sources": [
          "0x84a4a239805d06c685219801b82bea7c76702214"
        ],
        "displayRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 3612.455747417094
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": "ETH",
        "isOnHold": false
      }
    ],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:transaction-held",
  "data": {
    "uuid": "b078499c-0c6c-4e3f-8a32-66dca1d2676b",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709543074000,
    "expiryDate": 1709715874000,
    "quoteExpiryDate": 1709715874000,
    "acceptanceExpiryDate": 1709543139000,
    "quoteStatus": "ACCEPTED",
    "reference": "REF958403",
    "type": "IN",
    "subType": "merchantPayIn",
    "status": "PROCESSING",
    "displayCurrency": {
      "currency": "ETH",
      "amount": 0.01,
      "actual": 0
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.01,
      "actual": 0
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.01,
      "actual": 0
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.0001,
      "actual": 0
    },
    "displayRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0xc643e89d9499d1e888c0be5c89b0d49973115d8a",
      "tag": null,
      "protocol": "ETH",
      "uri": "ethereum:0xc643e89d9499d1e888c0be5c89b0d49973115d8a?value=1E+16",
      "alternatives": []
    },
    "returnUrl": "",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709543141000,
        "dateConfirmed": null,
        "hash": "0xfc403fb78ce3d05205c90ae91ddaf5f9760fd00ca15714b01951415ff3dbd172",
        "amount": 0.01,
        "risk": null,
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": null,
        "sources": null,
        "displayRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": "ETH",
        "isOnHold": true
      }
    ],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:status-change",
  "data": {
    "uuid": "d993b0bc-dace-4742-81d8-6ae629dab063",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709895600000,
    "expiryDate": 1709982000000,
    "quoteExpiryDate": 1709982000000,
    "acceptanceExpiryDate": 1709895667000,
    "quoteStatus": "ACCEPTED",
    "reference": "test_reference_in_0plkzH",
    "type": "IN",
    "subType": "merchantPayIn",
    "status": "CANCELLED",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 10
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276415,
      "actual": 0.00276415
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.00276415,
      "actual": 0.00276415
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00002764,
      "actual": 0.00002764
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 3617.748674999548
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0xc4d8b4b0e0601f49c88f41c4a9490f0d7f4ceed0",
      "tag": null,
      "protocol": "ETH",
      "uri": "ethereum:0xc4d8b4b0e0601f49c88f41c4a9490f0d7f4ceed0?value=2.76415E+15",
      "alternatives": []
    },
    "returnUrl": "https://www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709895679000,
        "dateConfirmed": 1709895776000,
        "hash": "0x3d8ff17b4a2be304eff0ece0373f538f5e1a19e637652466c9ab15c599b6d91b",
        "amount": 0.00276415,
        "risk": {
          "level": "LOW",
          "resourceName": null,
          "resourceCategory": null,
          "alerts": []
        },
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": 0.00003394,
        "sources": [
          "0x84a4a239805d06c685219801b82bea7c76702214"
        ],
        "displayRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 3617.748674999548
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": "ETH",
        "isOnHold": false
      }
    ],
    "refund": null,
    "refunds": []
  }
}

Payment Out Webhooks

{
  "source": "payment",
  "event": "layer1:payment:checkout:status-change",
  "data": {
    "uuid": "07905528-d72e-40dd-a1b4-fb8ec2f748c8",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709896869000,
    "expiryDate": 1709900469000,
    "quoteExpiryDate": 1709900469000,
    "acceptanceExpiryDate": 1709896938000,
    "quoteStatus": "ACCEPTED",
    "reference": "test_reference_out_mH9LBR1",
    "type": "OUT",
    "subType": "merchantPayOut",
    "status": "PROCESSING",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 0
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276456,
      "actual": 0.00276456
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.00276456,
      "actual": 0
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00002765,
      "actual": 0
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 3617.212142257719
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0x84A4a239805d06c685219801B82BEA7c76702214",
      "tag": null,
      "protocol": null,
      "uri": "ethereum:0x84A4a239805d06c685219801B82BEA7c76702214?value=2.76456E+15",
      "alternatives": []
    },
    "returnUrl": "www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:status-change",
  "data": {
    "uuid": "07905528-d72e-40dd-a1b4-fb8ec2f748c8",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709896869000,
    "expiryDate": 1709900469000,
    "quoteExpiryDate": 1709900469000,
    "acceptanceExpiryDate": 1709896938000,
    "quoteStatus": "ACCEPTED",
    "reference": "test_reference_out_mH9LBR1",
    "type": "OUT",
    "subType": "merchantPayOut",
    "status": "COMPLETE",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 10
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276456,
      "actual": 0.00276456
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.00276456,
      "actual": 0.00276456
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00002765,
      "actual": 0.00002765
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 3617.212142257719
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0x84A4a239805d06c685219801B82BEA7c76702214",
      "tag": null,
      "protocol": null,
      "uri": "ethereum:0x84A4a239805d06c685219801B82BEA7c76702214?value=2.76456E+15",
      "alternatives": []
    },
    "returnUrl": "www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709897097718,
        "dateConfirmed": 1709897097718,
        "hash": "0x30c18d5eed6c02418506d69d87c59ee52c2e10753bbccea035346b81c1e1a7e0",
        "amount": 0.00276456,
        "risk": {
          "level": "LOW",
          "resourceName": null,
          "resourceCategory": null,
          "alerts": []
        },
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": 0,
        "sources": [],
        "displayRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 3617.212142257719
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": null,
        "isOnHold": false
      }
    ],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:transaction-held",
  "data": {
    "uuid": "da19a0a7-73de-4033-b042-e3545682c06d",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709548454000,
    "expiryDate": 1709721254000,
    "quoteExpiryDate": 1709721254000,
    "acceptanceExpiryDate": 1709548500000,
    "quoteStatus": "ACCEPTED",
    "reference": "REF286000",
    "type": "OUT",
    "subType": "merchantPayOut",
    "status": "PROCESSING",
    "displayCurrency": {
      "currency": "ETH",
      "amount": 0.011,
      "actual": 0
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.011,
      "actual": 0.011
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.011,
      "actual": 0
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00011,
      "actual": 0
    },
    "displayRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0x84A4a239805d06c685219801B82BEA7c76702214",
      "tag": null,
      "protocol": null,
      "uri": "ethereum:0x84A4a239805d06c685219801B82BEA7c76702214?value=1.1E+16",
      "alternatives": []
    },
    "returnUrl": "",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709548507628,
        "dateConfirmed": null,
        "hash": null,
        "amount": 0.011,
        "risk": null,
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": 0,
        "sources": [],
        "displayRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": null,
        "isOnHold": true
      }
    ],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:status-change",
  "data": {
    "uuid": "b627afcb-664a-4755-94c2-babc9593db30",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709896504000,
    "expiryDate": 1709896683371,
    "quoteExpiryDate": null,
    "acceptanceExpiryDate": null,
    "quoteStatus": "TEMPLATE",
    "reference": "test_reference_out_bf1r6O1",
    "type": "OUT",
    "subType": "merchantPayOut",
    "status": "EXPIRED",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 0
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276243,
      "actual": 0
    },
    "paidCurrency": {
      "currency": null,
      "amount": 0,
      "actual": 0
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0,
      "actual": 0
    },
    "displayRate": null,
    "exchangeRate": null,
    "address": null,
    "returnUrl": "www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [],
    "refund": null,
    "refunds": []
  }
}

{
  "source": "payment",
  "event": "layer1:payment:checkout:status-change",
  "data": {
    "uuid": "07905528-d72e-40dd-a1b4-fb8ec2f748c8",
    "merchantDisplayName": "ETH Merchant ",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "dateCreated": 1709896869000,
    "expiryDate": 1709900469000,
    "quoteExpiryDate": 1709900469000,
    "acceptanceExpiryDate": 1709896938000,
    "quoteStatus": "ACCEPTED",
    "reference": "test_reference_out_mH9LBR1",
    "type": "OUT",
    "subType": "merchantPayOut",
    "status": "CANCELLED",
    "displayCurrency": {
      "currency": "EUR",
      "amount": 10,
      "actual": 10
    },
    "walletCurrency": {
      "currency": "ETH",
      "amount": 0.00276456,
      "actual": 0.00276456
    },
    "paidCurrency": {
      "currency": "ETH",
      "amount": 0.00276456,
      "actual": 0.00276456
    },
    "feeCurrency": {
      "currency": "ETH",
      "amount": 0.00002765,
      "actual": 0.00002765
    },
    "displayRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 3617.212142257719
    },
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "address": {
      "address": "0x84A4a239805d06c685219801B82BEA7c76702214",
      "tag": null,
      "protocol": null,
      "uri": "ethereum:0x84A4a239805d06c685219801B82BEA7c76702214?value=2.76456E+15",
      "alternatives": []
    },
    "returnUrl": "www.your-url-here.com",
    "redirectUrl": "",
    "transactions": [
      {
        "dateCreated": 1709897098000,
        "dateConfirmed": 1709897098000,
        "hash": "0x30c18d5eed6c02418506d69d87c59ee52c2e10753bbccea035346b81c1e1a7e0",
        "amount": 0.00276456,
        "risk": {
          "level": "LOW",
          "resourceName": null,
          "resourceCategory": null,
          "alerts": []
        },
        "networkFeeCurrency": "ETH",
        "networkFeeAmount": 0,
        "sources": null,
        "displayRate": {
          "base": "ETH",
          "counter": "EUR",
          "rate": 3617.212142257719
        },
        "exchangeRate": {
          "base": "ETH",
          "counter": "ETH",
          "rate": 1
        },
        "protocol": null,
        "isOnHold": false
      }
    ],
    "refund": null,
    "refunds": []
  }
}

Channel Webhooks

❗️
Please note that the address property is being phased out and a new addressDetails property is being phased in. This change is available in Sandbox and Production.

{
  "event": "layer1:payment:channel:transaction-detected",
  "source": "channel",
  "data": {
    "channelId": "326bf4e4-866e-4ec5-80e8-5233b7d29af5",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "merchantDisplayName": "ETH Merchant ",
    "reference": "Channel Test",
    "dateCreated": 1709556819750,
    "lastUpdated": 1709556819750,
    "status": "DETECTED",
    "uuid": "2d04095f-29b0-4434-89af-573759f8f248",
    "hash": "0x8ad672efcb337fb5a2025149e5e6f22e8af17f71b5270e904de28cee44de00e6",
    "address": "0xf210435eb347b9c79361b97fae333abf7cba1d9b",
    "tag": null,
    "paidCurrency": "ETH",
    "displayCurrency": "USD",
    "walletCurrency": "ETH",
    "feeCurrency": "ETH",
    "paidAmount": 0,
    "displayAmount": 0,
    "walletAmount": 0,
    "feeAmount": 0,
    "exchangeRate": null,
    "displayRate": null,
    "risk": {
      "level": "UNKNOWN",
      "resourceName": "UNKNOWN",
      "resourceCategory": "UNKNOWN",
      "alerts": []
    },
    "sources": null,
    "networkFee": {
      "paidCurrency": null,
      "paidAmount": 0,
      "displayCurrency": null,
      "displayAmount": 0
    }
  }
}

{
  "event": "layer1:payment:channel:transaction-confirmed",
  "source": "channel",
  "data": {
    "channelId": "326bf4e4-866e-4ec5-80e8-5233b7d29af5",
    "merchantId": "a7eddadd-fd9b-45fb-82a1-dc12eaa14cba",
    "merchantDisplayName": "ETH Merchant ",
    "reference": "Channel Test",
    "dateCreated": 1709556820000,
    "lastUpdated": 1709556909163,
    "status": "COMPLETE",
    "uuid": "2d04095f-29b0-4434-89af-573759f8f248",
    "hash": "0x8ad672efcb337fb5a2025149e5e6f22e8af17f71b5270e904de28cee44de00e6",
    "address": "0xf210435eb347b9c79361b97fae333abf7cba1d9b",
    "tag": null,
    "paidCurrency": "ETH",
    "displayCurrency": "USD",
    "walletCurrency": "ETH",
    "feeCurrency": "ETH",
    "paidAmount": 0.01234,
    "displayAmount": 43.28,
    "walletAmount": 0.01234,
    "feeAmount": 0.0001234,
    "exchangeRate": {
      "base": "ETH",
      "counter": "ETH",
      "rate": 1
    },
    "displayRate": {
      "base": "ETH",
      "counter": "USD",
      "rate": 3507.29
    },
    "risk": {
      "level": "UNKNOWN",
      "resourceName": "UNKNOWN",
      "resourceCategory": "UNKNOWN",
      "alerts": []
    },
    "sources": [
      "0x84a4a239805d06c685219801b82bea7c76702214"
    ],
    "networkFee": {
      "paidCurrency": "ETH",
      "paidAmount": 0.000033576139821,
      "displayCurrency": "USD",
      "displayAmount": 0.11
    }
  }
}

{
  "event": "layer1:payment:channel:transaction-detected",
  "eventId": "01944f8f-1470-730b-ac5c-efdbbd13b195",
  "timestamp": "2025-01-10T09:32:44.528416487Z",
  "data": {
    "tag": null,
    "hash": "0x75f2638443458717fd25aeb726b5f9ec7c46890571fc4fbbd5d6329d6d198131",
    "risk": {
      "level": "UNKNOWN",
      "alerts": [],
      "resourceName": "UNKNOWN",
      "resourceCategory": "UNKNOWN"
    },
    "uuid": "01944f8f-140b-760b-af26-edb78533e7b5",
    "status": "DETECTED",
    "address": "0xfd20790c9616857c75de3134f8a50c1bb84cb936",
    "sources": [
      "0xddcd0aa2c21d2d02ec0977565d037abc67f7f151",
      "0xddcd0aa2c21d2d02ec0977565d037abc67f7f151"
    ],
    "channelId": "01933f34-481a-79e5-95db-779289aae653",
    "feeAmount": 0,
    "reference": "bvnk_USDT_chan_03",
    "merchantId": "c7d66752-a9b8-4f3f-9ea2-8b1484415a59",
    "networkFee": {
      "paidAmount": 0,
      "paidCurrency": "USDT",
      "displayAmount": 0,
      "displayCurrency": "USDT"
    },
    "paidAmount": 25,
    "dateCreated": 1736501564427,
    "displayRate": {
      "base": "USDT",
      "rate": 0,
      "counter": "USDT"
    },
    "feeCurrency": "ETH",
    "lastUpdated": 1736501564427,
    "exchangeRate": {
      "base": "USDT",
      "rate": 0,
      "counter": "ETH"
    },
    "paidCurrency": "USDT",
    "walletAmount": 0,
    "displayAmount": 0,
    "addressDetails": {
      "address": "0xfd20790c9616857c75de3134f8a50c1bb84cb936",
      "network": "ETHEREUM"
    },
    "walletCurrency": "ETH",
    "displayCurrency": "USDT",
    "merchantDisplayName": "ETH wallet"
  }
}

{
  "event": "layer1:payment:channel:transaction-confirmed",
  "eventId": "01944f8f-521e-77c7-81f2-1c5067c27b38",
  "timestamp": "2025-01-10T09:33:00.318340311Z",
  "data": {
    "tag": null,
    "hash": "0x75f2638443458717fd25aeb726b5f9ec7c46890571fc4fbbd5d6329d6d198131",
    "risk": {
      "level": "UNKNOWN",
      "alerts": [],
      "resourceName": "UNKNOWN",
      "resourceCategory": "UNKNOWN"
    },
    "uuid": "01944f8f-140b-760b-af26-edb78533e7b5",
    "status": "COMPLETE",
    "address": "0xfd20790c9616857c75de3134f8a50c1bb84cb936",
    "sources": [
      "0xddcd0aa2c21d2d02ec0977565d037abc67f7f151",
      "0xddcd0aa2c21d2d02ec0977565d037abc67f7f151"
    ],
    "channelId": "01933f34-481a-79e5-95db-779289aae653",
    "feeAmount": 0.000131001793439552,
    "reference": "bvnk_USDT_chan_03",
    "merchantId": "c7d66752-a9b8-4f3f-9ea2-8b1484415a59",
    "networkFee": {
      "paidAmount": 0.000767,
      "paidCurrency": "USDT",
      "displayAmount": 0.000762,
      "displayCurrency": "USDT"
    },
    "paidAmount": 25,
    "dateCreated": 1736501564427,
    "displayRate": {
      "base": "USDT",
      "rate": 0.993856,
      "counter": "USDT"
    },
    "feeCurrency": "ETH",
    "lastUpdated": 1736501564730,
    "exchangeRate": {
      "base": "USDT",
      "rate": 0.000300654347516419,
      "counter": "ETH"
    },
    "paidCurrency": "USDT",
    "walletAmount": 0.007516358687910479,
    "displayAmount": 24.846405,
    "addressDetails": {
      "address": "0xfd20790c9616857c75de3134f8a50c1bb84cb936",
      "network": "ETHEREUM"
    },
    "walletCurrency": "ETH",
    "displayCurrency": "USDT",
    "merchantDisplayName": "ETH wallet"
  }
}

Updated about 1 year ago