Refund webhooks
Subscribe to refund webhooks for updates on status changes
Upgrade to the latest version
These docs are for version
2023-12-01. We encourage you to upgrade to version2024-10-16to access new features. Please see the changelog for more information.
Refunds
Webhooks can be configured to receive updates on every status change that occurs through the life cycle of a refund.
Refund statuses
Refund webhook payload
The webhook payload data field represents all refund detail fields returned in the get payin endpoint.
Refund events
| Event | Refund Status | Description |
|---|---|---|
refund.created | CREATED | Triggered when a refund is created and waiting approval. |
refund.processing | PROCESSING | Triggered when a refund is approved and is currently processing. |
refund.succeeded | SUCCEEDED | Triggered when a refund has completed processing. |
refund.failed | FAILED | Triggered when a refund unsuccessfully attempted to process. |
refund.canceled | CANCELED | Triggered when a refund is canceled before the refund completes processing. |
refund.in_review | IN_REVIEW | Triggered when a refund is flagged for risk review. |
Updated 4 months ago