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.
{
"type": "ChannelPayment",
"event": "created",
"data": {
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"network": "bitcoin",
"paid_amount": "0.02",
"paid_currency": "BTC",
"received_amount": "0.0",
"received_currency": "EUR",
"fee": "0.0",
"fee_currency": "EUR",
"status": "pending",
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
"custom_id": "631044494",
"customer_id": "customerID",
"risk": {
"score": 0.0,
"level": "low",
"resource_name": "Bitstamp",
"resource_category": "Exchange"
},
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967",
"created_at": "2019-05-02T11:00:01+00:00"
}
}
{
"type": "ChannelPayment",
"event": "completed",
"data": {
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"network": "bitcoin",
"paid_amount": "0.02",
"paid_currency": "BTC",
"received_amount": "97.26",
"received_currency": "EUR",
"fee": "0.99",
"fee_currency": "EUR",
"exchange": {
"fee": "0.0",
"pair": "BTCEUR",
"rate": "4912.8021",
"fee_currency": "EUR"
},
"status": "completed",
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
"custom_id": "631044494",
"customer_id": "customerID",
"risk": {
"score": 0.0,
"level": "low",
"resource_name": "Bitstamp",
"resource_category": "Exchange"
},
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967",
"created_at": "2019-05-02T11:00:01+00:00"
}
}
{
"type": "ChannelPayment",
"event": "on_hold",
"data": {
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"network": "bitcoin",
"paid_amount": "0.02",
"paid_currency": "BTC",
"received_amount": "0.0",
"received_currency": "EUR",
"fee": "0.0",
"fee_currency": "EUR",
"status": "on_hold",
"status_context": "illicit_resource",
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
"custom_id": "631044494",
"customer_id": "customerID",
"risk": {
"score": 8.45,
"level": "high",
"resource_name": "Silk Road",
"resource_category": "Dark Market - Centralised"
},
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967",
"created_at": "2019-05-02T11:00:01+00:00"
}
}
{
"type": "ChannelPayment",
"event": "refunded",
"data": {
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"network": "bitcoin",
"paid_amount": "0.02",
"paid_currency": "BTC",
"received_amount": "0.02",
"received_currency": "BTC",
"fee": "0.0",
"fee_currency": "BTC",
"status": "refunded",
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
"custom_id": "631044494",
"customer_id": "customerID",
"refund_address": "2N4BGqUxiHDkfwscbxcaQ1VcQuo3xjFZRvJ",
"risk": {
"score": 8.45,
"level": "high",
"resource_name": "Silk Road",
"resource_category": "Dark Market - Centralised"
},
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967",
"created_at": "2019-05-02T11:00:01+00:00"
}
}
{
"type": "ChannelPayment",
"event": "cancelled",
"data": {
"id": "284d4b79-fea6-46ce-bc2f-0f9cbed6367e",
"txid": "09723bf75253f3d2bf2f150fd8b5da5bc3026b95f1fe50b1f5f76f43d67a2e30",
"address": "2N9uVK2MDFNgBVqPnvCTV66Dinx3cp5J7S4",
"network": "bitcoin",
"paid_amount": "0.02",
"paid_currency": "BTC",
"received_amount": "0.0",
"received_currency": "EUR",
"fee": "0.0",
"fee_currency": "EUR",
"status": "cancelled",
"channel_id": "50eb5775-f77e-4c64-870b-dc93624b5967",
"custom_id": "631044494",
"customer_id": "customerID",
"risk": {
"score": 0.0,
"level": "low",
"resource_name": "Bitstamp",
"resource_category": "Exchange"
},
"hosted_page_url": "https://business-hosted.cryptopay.me/channels/50eb5775-f77e-4c64-870b-dc93624b5967",
"created_at": "2019-05-02T11:00:01+00:00"
}
}
Last updated