API Docs
Webhooks
API ReferenceWebhooksWebhook Event Types

Webhook Event Types

All available webhook event types.

Payment Events

EventDescription
payment_succeededPayment completed successfully
payment_failedPayment failed
payment_processingPayment is being processed
payment_cancelledPayment was cancelled before capture
payment_cancelled_post_capturePayment was cancelled after capture
payment_authorizedPayment was authorized and requires capture
payment_partially_authorizedPayment was partially authorized and requires capture
payment_capturedPayment was captured
payment_expiredPayment authorization expired
action_requiredPayment requires merchant or customer action

Refund Events

EventDescription
refund_succeededRefund completed successfully
refund_failedRefund failed

Dispute Events

EventDescription
dispute_openedA dispute was opened
dispute_expiredA dispute expired
dispute_acceptedA dispute was accepted
dispute_cancelledA dispute was cancelled
dispute_challengedA dispute was challenged
dispute_wonA dispute was won
dispute_lostA dispute was lost

Mandate Events

EventDescription
mandate_activeA mandate became active
mandate_revokedA mandate was revoked

Payout Events

EventDescription
payout_successPayout completed successfully
payout_failedPayout failed
payout_initiatedPayout was initiated
payout_processingPayout is being processed
payout_cancelledPayout was cancelled
payout_expiredPayout expired
payout_reversedPayout was reversed

Subscription Events

EventDescription
invoice_paidA subscription payment succeeded, at signup or on renewal
invoice_payment_failedA renewal payment was declined. Sent once per attempt, whether or not retries remain. Also sent when a first payment fails after 3D Secure
subscription_unpaidBilling stopped because a renewal could not be collected: the retries ran out, the decline cannot be retried, or the saved card was removed
subscription_cancelledA subscription ended: cancelled now, at the end of its paid period, or after its last paid period

Subscription events have content.type subscription_details. The payload is the subscription with its billing state (status, billing_cycle_count, next_billing_at, cancel_at_period_end), its latest invoice (including period_start, period_end, attempt_count, last_error_code and last_error_message), and the payment when there is one. When a renewal stops because the card was removed, payment is null and the reason is in invoice.last_error_code. See Subscriptions.