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

created

A customer has just broadcast their transaction on the network

completed

The transaction has just been confirmed on the network. The channel payment status has been changed to completed

on_hold

refunded

The funds have been returned back to the sender

cancelled

The transaction was on the network but hasn't been confirmed within 14 days. The channel payment status has been changed to cancelled

{
  "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"
  }
}

Last updated