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.

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.

For example:

{
  "event": "transactionDetected",
  "source": "channel",
  "data": {
    "channelId": "9d1f67f2-a647-404b-9b02-247c77be81d0",
    "merchantId": "0a12a214-1619-43fa-9be1-0029f6a440a0",
    "reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
    "dateCreated": 1631619489277,
    "lastUpdated": 1631619489277,
    "status": "DETECTED",
    "uuid": "c0dc9c14-0312-4a6b-a1a3-a6dcebdcc8a4",
    "hash": "0x152f2b3a3650a3e2e132abca0f81421c552ae14bc8466fac16889e8d32b3fd6a",
    "address": "0xb4e8bb9918248007dc9d0dc12ae1142f0d62ef0e",
    "tag": null,
    "paidCurrency": "ETH",
    "displayCurrency": "JPY",
    "walletCurrency": "EUR",
    "feeCurrency": "EUR",
    "paidAmount": 0,
    "displayAmount": 0,
    "walletAmount": 0,
    "feeAmount": 0,
    "exchangeRate": null,
    "displayRate": null,
    "risk": null,
    "networkFeeCurrency": null,
    "networkFeeAmount": null,
    "sources": null
  }
}
{
  "event": "transactionConfirmed",
  "source": "channel",
  "data": {
    "channelId": "9d1f67f2-a647-404b-9b02-247c77be81d0",
    "merchantId": "0a12a214-1619-43fa-9be1-0029f6a440a0",
    "reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
    "dateCreated": 1631619489000,
    "lastUpdated": 1631619562063,
    "status": "COMPLETE",
    "uuid": "c0dc9c14-0312-4a6b-a1a3-a6dcebdcc8a4",
    "hash": "0x152f2b3a3650a3e2e132abca0f81421c552ae14bc8466fac16889e8d32b3fd6a",
    "address": "0xb4e8bb9918248007dc9d0dc12ae1142f0d62ef0e",
    "tag": null,
    "paidCurrency": "ETH",
    "displayCurrency": "JPY",
    "walletCurrency": "EUR",
    "feeCurrency": "EUR",
    "paidAmount": 0.01,
    "displayAmount": 3592.27,
    "walletAmount": 27.62,
    "feeAmount": 0.27,
    "exchangeRate": {
      "base": "ETH",
      "counter": "EUR",
      "rate": 2762
    },
    "displayRate": {
      "base": "ETH",
      "counter": "JPY",
      "rate": 359227
    },
    "risk": null,
    "networkFeeCurrency": "ETH",
    "networkFeeAmount": 0.000031500035238,
    "sources": [
      "0x1a2e97fd13c0610239c0b1cdbb0806f35adff3f0"
    ]
  }
}

Did this page help you?