Listening for channel webhooks

📘
We covered how to create a webhook listener here in the getting setup guide - if you haven't done this already, go back to this step to get ready to receive webhooks.

Webhook Statuses

In the channel workflow, you should expect to see the following webhooks:

Event	Description
`transactionDetected`	When a payment has been sent to a channel you'll receive this webhook detailing the payment.
`transactionConfirmed`	When a payment has settled into the channel completely and funds are present in the merchant account you'll receive this webhook.

Webhook Examples

For example:

{
  "event": "transactionDetected",
  "source": "channel",
  "data": {
    "channelId": "57974283-7285-431b-8105-1c4a5911ec1f",
    "merchantId": "6853fd77-5395-47bc-9fd2-070e9039b068",
    "merchantDisplayName": "BVNK Test",
    "reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
    "dateCreated": 1665758966787,
    "lastUpdated": 1665758966787,
    "status": "DETECTED",
    "uuid": "e945148c-1a94-4db7-b784-820be80b7691",
    "hash": "0xa0d6054d001ab030f7227ed0cb8e71d4c40b12e2915b524a254f9cce06318455",
    "address": "0xEA3bF80d612b5a08BA6681B57d2AB4D20015De46",
    "tag": null,
    "paidCurrency": "ETH",
    "displayCurrency": "GBP",
    "walletCurrency": "GBP",
    "feeCurrency": "GBP",
    "paidAmount": 0,
    "displayAmount": 0,
    "walletAmount": 0,
    "feeAmount": 0,
    "exchangeRate": null,
    "displayRate": null,
    "risk": {
      "level": "LOW",
      "resourceName": "UNKNOWN",
      "resourceCategory": "UNKNOWN",
      "alerts": []
    },
    "sources": null,
    "networkFee": {
      "paidCurrency": null,
      "paidAmount": null,
      "displayCurrency": null,
      "displayAmount": null
    }
  }
}

{
  "event": "transactionConfirmed",
  "source": "channel",
  "data": {
    "channelId": "57974283-7285-431b-8105-1c4a5911ec1f",
    "merchantId": "6853fd77-5395-47bc-9fd2-070e9039b068",
    "merchantDisplayName": "BVNK Test",
    "reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
    "dateCreated": 1665758967000,
    "lastUpdated": 1665758970284,
    "status": "COMPLETE",
    "uuid": "e945148c-1a94-4db7-b784-820be80b7691",
    "hash": "0xa0d6054d001ab030f7227ed0cb8e71d4c40b12e2915b524a254f9cce06318455",
    "address": "0xEA3bF80d612b5a08BA6681B57d2AB4D20015De46",
    "tag": null,
    "paidCurrency": "ETH",
    "displayCurrency": "GBP",
    "walletCurrency": "GBP",
    "feeCurrency": "GBP",
    "paidAmount": 0.1,
    "displayAmount": 115.69,
    "walletAmount": 115.69,
    "feeAmount": 1.15,
    "exchangeRate": {
      "base": "ETH",
      "counter": "GBP",
      "rate": 1156.9
    },
    "displayRate": {
      "base": "ETH",
      "counter": "GBP",
      "rate": 1156.9
    },
    "risk": {
      "level": "LOW",
      "resourceName": "UNKNOWN",
      "resourceCategory": "UNKNOWN",
      "alerts": []
    },
    "sources": [
      "0x602956302D7ddD409227D9fE0A2032dC7461A424"
    ],
    "networkFee": {
      "paidCurrency": "ETH",
      "paidAmount": 0.000045023994813,
      "displayCurrency": "GBP",
      "displayAmount": 0.05
    }
  }
}