| Resource | Payload name | Description |
|---|---|---|
| API key pair | api-key-pair.created | An API key pair was created. |
| API key pair | api-key-pair.updated | An API key pair was updated. |
| API key pair | api-key-pair.deleted | An API key pair was deleted. |
| Buyer | buyer.created | A buyer was created successfully. |
| Buyer | buyer.updated | A buyer was updated successfully. This does not include its shipping details, see shipping-details.deleted. |
| Buyer | buyer.deleted | A buyer was deleted. |
| Capture | capture.pending | An individual capture against a transaction is pending. Sent per capture, including when a transaction has more than one capture. |
| Capture | capture.succeeded | An individual capture against a transaction succeeded. |
| Capture | capture.declined | An individual capture against a transaction was declined by the payment service. |
| Capture | capture.failed | An individual capture against a transaction failed due to an internal or external reason. |
| Gift card | gift-card.created | A stored gift card was created. |
| Gift card | gift-card.deleted | A stored gift card was deleted. |
| Monitoring incident | monitoring.incident.created | A monitoring incident has been created. |
| Monitoring incident | monitoring.incident.closed | A monitoring incident has been closed. |
| Payment method | payment-method.paused | The payment service paused the agreement or mandate behind a stored payment method. The payment method can’t be used until it’s resumed. |
| Payment method | payment-method.resumed | A paused stored payment method was resumed and can be used again. |
| Payment method | payment-method.updated | A stored payment method was updated, for example when an account updater replaced the card number or expiry date. The payment method keeps the same ID. |
| Payment method | payment-method.authorization-expiring | The underlying agreement or mandate for a stored payment method is close to expiring. |
| Payment method | payment-method.authorization-update-required | The underlying agreement or mandate for a stored payment method has expired and needs reauthorization. |
| Payment method | payment-method.authorization-updated | The underlying agreement or mandate for a stored payment method is no longer expired or expiring because it was reauthorized. |
| Payment method | payment-method.deleted | The payment service reported that a stored payment method was removed on its side, and Gr4vy deleted the payment method. This applies to payment methods that rely on a payment service token, such as redirect payment methods. This event isn’t sent for stored cards, or when you delete a payment method through the API. |
| 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. You might need to re-create the report. |
| Report execution | report-execution.succeeded | A report was generated. |
| Shipping details | shipping-details.created | A buyer successfully had its 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.canceled | A pending transaction was canceled, for example with Cancel transaction. The payload reports the status as authorization_failed. |
| Transaction | transaction.cancel-failed | The payment service rejected a request to cancel a pending transaction. The transaction status doesn’t change. |
| 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.modified | A transaction was updated, for example by Gr4vy support on your behalf, or when an incremental authorization succeeds. |
| Transaction | transaction.review-accepted | A transaction that was held in anti-fraud review has been accepted but its status has not changed, only the pending_review property has been set to false. This event isn’t sent for every review. See webhooks during a review. |
| 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 its request to void the authorization declined by the payment service. |
| Transaction | transaction.void-failed | An authorized transaction had its 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. |
| Payment link | payment-link.created | A payment link has been created successfully. |
| Payment link | payment-link.updated | A payment link has been updated or expired. |
failed status. See
payment method statuses.
Additional webhooks covering all the remaining events in the payment lifecycle
are planned for a very near release.