Client Webhooks Overview
The CoinPayments API supports subscriptions to the following event types for invoice
related notifications:
- invoiceCreated: triggered when a new invoice is created. Invoice state:
unpaid
- invoicePending: triggered when the transfer amount is detected on the blockchain and the transaction has received at least one confirmation (sent every time a new confirmation is received until confirmation requirement is met). Invoice state:
pending
- invoicePaid: triggered when an invoice has received all required confirmations and funds have been obtained by CoinPayments. Invoice state:
paid
- invoiceCompleted: triggered when the invoice is paid and funds are reflected in the merchant's balance. Invoice state:
completed
- invoiceCancelled: triggered when an invoice is cancelled by the merchant. Invoice state:
cancelled
- invoiceTimedOut: triggered once an invoice has expired. Invoice state:
timedOut
- paymentCreated - The temporary address for payment is created.
- paymentTimedOut - The temporary address for payment is no longer available.
To review the received webhook payload, see Webhook Payload.