Webhooks
API ReferenceWebhooksWebhook Event Types
Webhook Event Types
All available webhook event types.
Payment Events
| Event | Description |
|---|---|
payment_succeeded | Payment completed successfully |
payment_failed | Payment failed |
payment_processing | Payment is being processed |
payment_cancelled | Payment was cancelled before capture |
payment_cancelled_post_capture | Payment was cancelled after capture |
payment_authorized | Payment was authorized and requires capture |
payment_partially_authorized | Payment was partially authorized and requires capture |
payment_captured | Payment was captured |
payment_expired | Payment authorization expired |
action_required | Payment requires merchant or customer action |
Refund Events
| Event | Description |
|---|---|
refund_succeeded | Refund completed successfully |
refund_failed | Refund failed |
Dispute Events
| Event | Description |
|---|---|
dispute_opened | A dispute was opened |
dispute_expired | A dispute expired |
dispute_accepted | A dispute was accepted |
dispute_cancelled | A dispute was cancelled |
dispute_challenged | A dispute was challenged |
dispute_won | A dispute was won |
dispute_lost | A dispute was lost |
Mandate Events
| Event | Description |
|---|---|
mandate_active | A mandate became active |
mandate_revoked | A mandate was revoked |
Payout Events
| Event | Description |
|---|---|
payout_success | Payout completed successfully |
payout_failed | Payout failed |
payout_initiated | Payout was initiated |
payout_processing | Payout is being processed |
payout_cancelled | Payout was cancelled |
payout_expired | Payout expired |
payout_reversed | Payout was reversed |
Subscription Events
| Event | Description |
|---|---|
invoice_paid | A subscription payment succeeded, at signup or on renewal |
invoice_payment_failed | A renewal payment was declined. Sent once per attempt, whether or not retries remain. Also sent when a first payment fails after 3D Secure |
subscription_unpaid | Billing stopped because a renewal could not be collected: the retries ran out, the decline cannot be retried, or the saved card was removed |
subscription_cancelled | A 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.