Channel Webhooks
Click the tabs below to view what webhooks you will receive from Coindirect when a merchant's customer completes their payment.
The scenario in this example is the following:
  1. 1.
    The customer broadcasts their transaction on the network to send funds to a channel address that is tied to their user account in the merchant's platform
  2. 2.
    Coindirect detects that inbound cryptocurrency transaction at the channel's adress and sends "event": "transactionDetected" webhook to notify the merchant
  3. 3.
    The cryptocurrency transaction gets the required number of confirmations on the network - it usually takes from a few seconds to several mintues
  4. 4.
    Coindirect then updates the channel payment status from DETECTED to COMPLETE and
    sends "event": "transactionConfirmed" webhook to notify the merchant
  5. 5.
    The merchant will want to look at the displayAmount field to get the amount that the customer's payment resulted in. This is the exact amount that the customer's balance un the merchant's plarform should be increased by
event: transactionDetected
event: transactionConfirmed
1
{
2
"event": "transactionDetected",
3
"source": "channel",
4
"data": {
5
"channelId": "9d1f67f2-a647-404b-9b02-247c77be81d0",
6
"merchantId": "0a12a214-1619-43fa-9be1-0029f6a440a0",
7
"reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
8
"dateCreated": 1631619489277,
9
"lastUpdated": 1631619489277,
10
"status": "DETECTED",
11
"uuid": "c0dc9c14-0312-4a6b-a1a3-a6dcebdcc8a4",
12
"hash": "0x152f2b3a3650a3e2e132abca0f81421c552ae14bc8466fac16889e8d32b3fd6a",
13
"address": "0xb4e8bb9918248007dc9d0dc12ae1142f0d62ef0e",
14
"tag": null,
15
"paidCurrency": "ETH",
16
"displayCurrency": "JPY",
17
"walletCurrency": "EUR",
18
"feeCurrency": "EUR",
19
"paidAmount": 0,
20
"displayAmount": 0,
21
"walletAmount": 0,
22
"feeAmount": 0,
23
"exchangeRate": null,
24
"displayRate": null,
25
"risk": null,
26
"networkFeeCurrency": null,
27
"networkFeeAmount": null,
28
"sources": null
29
}
30
}
Copied!
1
{
2
"event": "transactionConfirmed",
3
"source": "channel",
4
"data": {
5
"channelId": "9d1f67f2-a647-404b-9b02-247c77be81d0",
6
"merchantId": "0a12a214-1619-43fa-9be1-0029f6a440a0",
7
"reference": "c1b933d5-3354-4f83-a05f-0b53f1be85f2",
8
"dateCreated": 1631619489000,
9
"lastUpdated": 1631619562063,
10
"status": "COMPLETE",
11
"uuid": "c0dc9c14-0312-4a6b-a1a3-a6dcebdcc8a4",
12
"hash": "0x152f2b3a3650a3e2e132abca0f81421c552ae14bc8466fac16889e8d32b3fd6a",
13
"address": "0xb4e8bb9918248007dc9d0dc12ae1142f0d62ef0e",
14
"tag": null,
15
"paidCurrency": "ETH",
16
"displayCurrency": "JPY",
17
"walletCurrency": "EUR",
18
"feeCurrency": "EUR",
19
"paidAmount": 0.01,
20
"displayAmount": 3592.27,
21
"walletAmount": 27.62,
22
"feeAmount": 0.27,
23
"exchangeRate": {
24
"base": "ETH",
25
"counter": "EUR",
26
"rate": 2762
27
},
28
"displayRate": {
29
"base": "ETH",
30
"counter": "JPY",
31
"rate": 359227
32
},
33
"risk": null,
34
"networkFeeCurrency": "ETH",
35
"networkFeeAmount": 0.000031500035238,
36
"sources": [
37
"0x1a2e97fd13c0610239c0b1cdbb0806f35adff3f0"
38
]
39
}
40
}
Copied!

Webhook Payload Data

Parameter
Type
Description
address
string
Parent channel's destination address
channelId
string
Parent channel's UUID
dateCreated
number
Payment creation date
displayAmount
number
Payment amount. This is the exact amount that the customer's balance un the merchant's plarform should be increased by
displayCurrency
string
Payment currency e.g. JPY
displayRate
object
Display currency spot rate details
displayRate.base
string
Base currency e.g. EUR
displayRate.counter
string
Counter currency e.g. JPY
displayRate.rate
number
Spot rate
exchangeRate
object
Wallet currency spot rate
exchangeRate.base
string
Base currency e.g. ETH
exchangeRate.counter
string
Counter currency e.g. EUR
exchangeRate.rate
number
Wallet currency spot rate
feeAmount
number
Processing fee amount
feeCurrency
string
Processing fee currency
hash
string
Cryptocurrency transaction hash
lastUpdated
number
Payment last update date
merchantId
string
Merchant ID
paidAmount
number
The amount of received cryptocurrency
See the Webhooks page to get basic information on webhooks and validation.
Channels endpoints.
Copy link