Broadleaf Microservices
  • v1.0.0-latest-prod

Supported Stripe Webhook Events

charge.succeeded

This event is triggered when successful Authorize or AuthorizeAndCapture transactions are executed.

  • If an Authorize transaction was executed, then captured = false & amountCaptured = 0.

  • If an AuthorizeAndCapture transaction was executed, then captured = true & amountCaptured > 0.

Note
This event is used to understand successful transaction results for ACH-based AuthorizeAndCapture transactions.

charge.failed

This event is triggered when an Authorize or AuthorizeAndCapture transaction fails.

{
  ...
  "failure_code": "card_declined",
  "failure_message": "Your card was declined. Your request was in test mode, but used a non test (live) card. For a list of valid test cards, visit: https://stripe.com/docs/testing.",
  ...
}
Note
This event is used to understand failed transaction results for ACH-based AuthorizeAndCapture transactions.

charge.captured

This event is triggered when previously authorized charge is captured.

charge.refunded

This event is triggered when previously captured charge is refunded.

payment_intent.payment_failed

This event is triggered when a transaction fails to execute.

Note
This even gets triggered for ACH payment failures, but in those cases, we prefer to respond to charge.failed events instead.

In the case of a 3DS verification failure, the event payload includes the following:

{
  ...
  "last_payment_error": {
    "code": "payment_intent_authentication_failure",
    "doc_url": "https://stripe.com/docs/error-codes/payment-intent-authentication-failure",
    "message": "The provided PaymentMethod has failed authentication. You can provide payment_method_data or a new PaymentMethod to attempt to fulfill this PaymentIntent again."
  },
  ...
}

review.closed

This event is triggered when a manual fraud review is closed (approved or rejected).