Skip to documentationDocumentation
On this page

Events

The 21 subscribable merchant event types and their versioned payloads.

Subscribe to the event types your integration handles. Each event page describes the business fact, money semantics, complete envelope and data fields, schema versions, and example payloads.

Invoice events#

EventMeaning
invoice.createdInvoice intent created; no funds accepted
invoice.detectedA payment was observed before acceptance
invoice.confirmingAn accepted partial payment leaves the invoice below the paid threshold
invoice.paidThe accepted total meets the payment threshold
invoice.overpaidThe accepted total exceeds the overpayment threshold
invoice.underpaidClosed with part of the amount accepted; usually no new credit, reconcile amount_paid from the invoice
invoice.expiredUnpaid window expired
invoice.invalidAn unaccepted observation was dropped or reorged
invoice.rejectedA timely payment cannot be accepted and nothing was accepted; the invoice is closed
invoice.late_paymentA payment was accepted late
invoice.payment_reversedA previously accepted payment was reversed

Payout events#

EventMeaning
payout.completedTransfer completed
payout.failedTransfer failed; reservation released
payout.reversedCompleted transfer reversed by the chain

Refund events#

EventMeaning
refund.createdRefund created; funds reserved
refund.completedRefund transfer completed
refund.failedRefund failed; reservation released
refund.reversedCompleted refund lost chain confirmation; reconcile delivery

Conversion events (live only)#

EventMeaning
conversion.completedStandalone conversion settled; merchant credit booked
conversion.failedFirst failure; recovery may follow
conversion.source_restoredSource returned/released or refused before debit

Events outside the catalog#

webhook.ping is a synthetic test delivery, not a subscription. There is no merchant balance.credited, payout.created, or merchant-status event in this contract.

Delivery rules are documented in webhooks; processing guidance is in business processes.