Webhooks
Webhook events
Webhooks
Webhook events
We currently send webhooks for the following events. The event name is only available in our latest release with
larger payloads.
| Resource | Payload name | Description |
|---|---|---|
| Buyer | buyer.created | A buyer was created successfully. |
| Buyer | buyer.updated | A buyer was updated successfully. This does not include it’s shipping details, see shipping-details.deleted. |
| Buyer | buyer.deleted | A buyer was deleted. |
| Gift card | gift-card.deleted | A stored gift card was deleted. |
| Payment method | payment-method.paused | A stored payment method (e.g. card) was paused. |
| Payment method | payment-method.resumed | A stored payment method (e.g. card) was resumed. |
| Payment method | payment-method.updated | A stored payment method (e.g. card) was updated, likely due to an account update. |
| Refund | refund.declined | A refund for a transaction was declined by the payment service. |
| Refund | refund.failed | A refund for a transaction was otherwise rejected by the payment service. |
| Refund | refund.pending | A refund for a transaction is pending. |
| Refund | refund.succeeded | A refund for a transaction succeeded. |
| Report execution | report-execution.failed | A report failed to generate. |
| Report execution | report-execution.succeeded | A report was generated. |
| Shipping details | shipping-details.created | A buyer successfully had it’s shipping details added. |
| Shipping details | shipping-details.updated | A buyer’s shipping details were updated successfully. |
| Shipping details | shipping-details.deleted | A buyer’s shipping details were deleted. |
| Transaction | transaction.authenticated | A transaction was successfully authenticated. |
| Transaction | transaction.authentication-pending | A transaction is pending authentication. |
| Transaction | transaction.authorized | A transaction is authorized (through 3DS or otherwise) but has not yet been authenticated. |
| Transaction | transaction.capture-failed | An authorized transaction failed to capture. |
| Transaction | transaction.capture-pending | An authorized transaction is pending capture. |
| Transaction | transaction.captured | An authorized transaction was captured. |
| Transaction | transaction.declined | A transaction was declined. |
| Transaction | transaction.failed | A transaction failed due to an internal or external reason. Please check the error_code for the cause. |
| Transaction | transaction.review-accepted | A transaction that was held in anti-fraud review has been accepted but it’s status has not changed, only the pending_review property has been set to false. |
| Transaction | transaction.settled | A transaction has been reported settled. This is currently only supported by The Giving Block. |
| Transaction | transaction.void-declined | An authorized transaction had it’s request to void the authorization declined by the payment service. |
| Transaction | transaction.void-failed | An authorized transaction had it’s request to void the authorization otherwise rejected by the payment service. |
| Transaction | transaction.void-pending | An authorized transaction has a pending void request. |
| Transaction | transaction.voided | An authorized transaction has been voided. |
| Payout | payout.succeeded | A payout has been created successfully. |
| Payout | payout.pending | A payout is pending a notification from the payment service. |
| Payout | payout.declined | A payout was declined. |
| Payout | payout.failed | A payout failed due to an internal or external reason |
We will be adding additional webhooks to cover all the remaining events in the payment lifecycle in a very near release.
Was this page helpful?