Guides
Channel payment callbacks
Handling callbacks correctly is crucial to ensure your integration’s business logic works as expected. It is highly recommended to validate payment statuses and callbacks before acting on it inside your system.
Refer to this section to get more information on what callbacks are and how to validate them before acting on it inside your system.
Callback event
Description
createdA customer has just broadcast their transaction on the network
completedThe transaction has just been confirmed on the network. The channel payment status has been changed to
completedon_holdThe received cryptocurrency transaction evaluated as High-Risk, therefore the Channel Payment transaction has been put on hold. Our Transaction Monitoring team will review this transaction to make a decision on whether we will be able to process this payment and add the funds to your merchant account balance or we will have to send the funds back to a sender. Refer to the Risks section to get more details on what High-Risk transactions are and why we take it very seriously
refundedThe funds have been returned back to the sender
cancelledThe transaction was on the network but hasn't been confirmed within 14 days. The channel payment status has been changed to
cancelledcreated
completed
on_hold
refunded
cancelled
1
{
2
"type": "ChannelPayment",
3
"event": "created",
4
"data": {
5
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
6
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
7
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
8
"paid_amount": "0.02",
9
"paid_currency": "BTC",
10
"received_amount": "0.0",
11
"received_currency": "EUR",
12
"fee": "0.0",
13
"fee_currency": "EUR",
14
"status": "pending",
15
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
16
"custom_id": "631044494",
17
"customer_id": "customerID",
18
"risk": {
19
"score": 0.0,
20
"level": "low",
21
"resource_name": "Bitstamp",
22
"resource_category": "Exchange"
23
},
24
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967",
25
"created_at": "2019-05-02T11:00:01+00:00"
26
}
27
}
Copied!
1
{
2
"type": "ChannelPayment",
3
"event": "completed",
4
"data": {
5
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
6
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
7
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
8
"paid_amount": "0.02",
9
"paid_currency": "BTC",
10
"received_amount": "97.26",
11
"received_currency": "EUR",
12
"fee": "0.99",
13
"fee_currency": "EUR",
14
"exchange": {
15
"fee": "0.0",
16
"pair": "BTCEUR",
17
"rate": "4912.8021",
18
"fee_currency": "EUR"
19
},
20
"status": "completed",
21
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
22
"custom_id": "631044494",
23
"customer_id": "customerID",
24
"risk": {
25
"score": 0.0,
26
"level": "low",
27
"resource_name": "Bitstamp",
28
"resource_category": "Exchange"
29
},
30
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967",
31
"created_at": "2019-05-02T11:00:01+00:00"
32
}
33
}
Copied!
1
{
2
"type": "ChannelPayment",
3
"event": "on_hold",
4
"data": {
5
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
6
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
7
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
8
"paid_amount": "0.02",
9
"paid_currency": "BTC",
10
"received_amount": "0.0",
11
"received_currency": "EUR",
12
"fee": "0.0",
13
"fee_currency": "EUR",
14
"status": "on_hold",
15
"status_context": "illicit_resource",
16
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
17
"custom_id": "631044494",
18
"customer_id": "customerID",
19
"risk": {
20
"score": 8.45,
21
"level": "high",
22
"resource_name": "Silk Road",
23
"resource_category": "Dark Market - Centralised"
24
},
25
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967",
26
"created_at": "2019-05-02T11:00:01+00:00"
27
}
28
}
Copied!
1
{
2
"type": "ChannelPayment",
3
"event": "refunded",
4
"data": {
5
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
6
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
7
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
8
"paid_amount": "0.02",
9
"paid_currency": "BTC",
10
"received_amount": "0.02",
11
"received_currency": "BTC",
12
"fee": "0.0",
13
"fee_currency": "BTC",
14
"status": "refunded",
15
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
16
"custom_id": "631044494",
17
"customer_id": "customerID",
18
"refund_address": "2N4BGqUxiHDkfwscbxcaQ1VcQuo3xjFZRvJ",
19
"risk": {
20
"score": 8.45,
21
"level": "high",
22
"resource_name": "Silk Road",
23
"resource_category": "Dark Market - Centralised"
24
},
25
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967",
26
"created_at": "2019-05-02T11:00:01+00:00"
27
}
28
}
Copied!
1
{
2
"type": "ChannelPayment",
3
"event": "cancelled",
4
"data": {
5
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
6
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
7
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
8
"paid_amount": "0.02",
9
"paid_currency": "BTC",
10
"received_amount": "0.0",
11
"received_currency": "EUR",
12
"fee": "0.0",
13
"fee_currency": "EUR",
14
"status": "cancelled",
15
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
16
"custom_id": "631044494",
17
"customer_id": "customerID",
18
"risk": {
19
"score": 0.0,
20
"level": "low",
21
"resource_name": "Bitstamp",
22
"resource_category": "Exchange"
23
},
24
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967",
25
"created_at": "2019-05-02T11:00:01+00:00"
26
}
27
}
Copied!
​
Last modified 3mo ago
Copy link