Webhooks
List outbound webhook event types
Static catalogue of every outbound webhook event the platform can emit, with a realistic example payload per type. Authoritative source for the closed event-type union; SDKs and merchant handlers should switch exhaustively over this list. No authentication: this is a contract surface, not merchant data.
Static catalogue of every outbound webhook event the platform can emit, with a realistic example payload per type. Authoritative source for the closed event-type union; SDKs and merchant handlers should switch exhaustively over this list. No authentication: this is a contract surface, not merchant data.
Response Body
application/json
curl -X GET "https://example.com/webhook_events"{ "events": [ { "description": "A payment intent was refunded after a successful capture.", "event": "payment_intent.refunded", "payload": { "checkout_mode": "hosted", "failure_code": null, "failure_message": null, "merchant_reference": "order-2026-05-09-0001", "payment_intent_id": "dord_01HZXABC123", "status": "refunded" } }, { "description": "A payment intent reached terminal `succeeded`. Funds are credited to the merchant wallet.", "event": "payment_intent.succeeded", "payload": { "checkout_mode": "hosted", "failure_code": null, "failure_message": null, "merchant_reference": "order-2026-05-09-0001", "payment_intent_id": "dord_01HZXABC123", "status": "succeeded" } }, { "description": "A payment intent reached terminal `failed`.", "event": "payment_intent.failed", "payload": { "checkout_mode": "hosted", "failure_code": "provider_declined", "failure_message": "psp_declined", "merchant_reference": "order-2026-05-09-0001", "payment_intent_id": "dord_01HZXABC123", "status": "failed" } }, { "description": "A payment intent expired without payment within its window.", "event": "payment_intent.expired", "payload": { "checkout_mode": "hosted", "failure_code": "expired", "failure_message": "expired", "merchant_reference": "order-2026-05-09-0001", "payment_intent_id": "dord_01HZXABC123", "status": "expired" } }, { "description": "A payout intent settled at the PSP and left the merchant wallet.", "event": "payout_intent.succeeded", "payload": { "failure_code": null, "failure_message": null, "merchant_reference": "payout-2026-05-09-0001", "payout_intent_id": "word_01HZXABC123", "status": "succeeded" } }, { "description": "A payout intent failed at the PSP after dispatch.", "event": "payout_intent.failed", "payload": { "failure_code": "provider_declined", "failure_message": "psp_error", "merchant_reference": "payout-2026-05-09-0001", "payout_intent_id": "word_01HZXABC123", "status": "failed" } }, { "description": "A payout intent was cancelled before dispatch.", "event": "payout_intent.cancelled", "payload": { "failure_code": "cancelled", "failure_message": "operator_rejected", "merchant_reference": "payout-2026-05-09-0001", "payout_intent_id": "word_01HZXABC123", "status": "cancelled" } }, { "description": "A payout intent expired before the PSP returned a terminal result.", "event": "payout_intent.expired", "payload": { "failure_code": "expired", "failure_message": "expired", "merchant_reference": "payout-2026-05-09-0001", "payout_intent_id": "word_01HZXABC123", "status": "expired" } }, { "description": "A payout intent was returned after dispatch and the held funds were reversed.", "event": "payout_intent.reversed", "payload": { "failure_code": "reversed", "failure_message": "returned", "merchant_reference": "payout-2026-05-09-0001", "payout_intent_id": "word_01HZXABC123", "status": "reversed" } } ]}