Update payment method type check for charge.succeeded (#4084)

* Update payment method type check for charge.succeeded

* Add changelog and readme entries

* Fix unit tests

* Define sync methods array for better readability

Co-authored-by: Malith Senaweera <[email protected]>

* Include event ID in message log for missing charge object.

Co-authored-by: Malith Senaweera <[email protected]>

---------

Co-authored-by: Malith Senaweera <[email protected]>

Author: annemirasol

changelog.txt

@@ -19,6 +19,7 @@
 * Update - Update payment method type for Amazon Pay orders.
 * Fix - Compatibility with email preview in the Auth Requested email
 * Update - Update Alipay and bank debit icons.
+* Tweak - Update payment method type check for charge.succeeded webhook.
 
 = 9.3.1 - 2025-03-14 =
 * Fix - Temporarily disables the subscriptions detached notice feature due to long loading times on stores with many subscriptions.

includes/class-wc-stripe-webhook-handler.php

@@ -525,15 +525,30 @@ public function process_webhook_capture( $notification ) {
 	 * @param object $notification
 	 */
 	public function process_webhook_charge_succeeded( $notification ) {
-		// The following payment methods are synchronous so does not need to be handle via webhook.
-		if ( ( isset( $notification->data->object->source->type ) && WC_Stripe_Payment_Methods::CARD === $notification->data->object->source->type ) || ( isset( $notification->data->object->source->type ) && 'three_d_secure' === $notification->data->object->source->type ) ) {
+		if ( empty( $notification->data->object ) ) {
+			WC_Stripe_Logger::log( 'Missing charge object in charge.succeeded webhook, Event ID: %s', $notification->id ?? 'unknown' );
 			return;
 		}
 
-		$order = WC_Stripe_Helper::get_order_by_charge_id( $notification->data->object->id );
+		// https://docs.stripe.com/api/events/types#event_types-charge.succeeded
+		$charge = $notification->data->object;
+
+		// The following payment methods are synchronous so does not need to be handled via webhook.
+		$payment_method_type = $this->get_payment_method_type_from_charge( $charge );
+		$synchronous_methods = [
+			WC_Stripe_Payment_Methods::CARD,
+			WC_Stripe_Payment_Methods::AMAZON_PAY,
+			'three_d_secure',
+		];
+
+		if ( in_array( $payment_method_type, $synchronous_methods, true ) ) {
+			return;
+		}
+
+		$order = WC_Stripe_Helper::get_order_by_charge_id( $charge->id );
 
 		if ( ! $order ) {
-			WC_Stripe_Logger::log( 'Could not find order via charge ID: ' . $notification->data->object->id );
+			WC_Stripe_Logger::log( 'Could not find order via charge ID: ' . $charge->id );
 			return;
 		}
 
@@ -545,15 +560,15 @@ public function process_webhook_charge_succeeded( $notification ) {
 		// setting is enabled, Stripe API still sends a "charge.succeeded" webhook but
 		// the payment has not been captured, yet. This ensures that the payment has been
 		// captured, before completing the payment.
-		if ( ! $notification->data->object->captured ) {
+		if ( ! $charge->captured ) {
 			return;
 		}
 
 		// Store other data such as fees
-		$order->set_transaction_id( $notification->data->object->id );
+		$order->set_transaction_id( $charge->id );
 
-		if ( isset( $notification->data->object->balance_transaction ) ) {
-			$this->update_fees( $order, $notification->data->object->balance_transaction );
+		if ( isset( $charge->balance_transaction ) ) {
+			$this->update_fees( $order, $charge->balance_transaction );
 		}
 
 		/**
@@ -568,10 +583,10 @@ public function process_webhook_charge_succeeded( $notification ) {
 		 * to ensure the review.closed event handler will update the status to the proper status.
 		 */
 		if ( 'manual_review' !== $this->get_risk_outcome( $notification ) ) {
-			$order->payment_complete( $notification->data->object->id );
+			$order->payment_complete( $charge->id );
 
 			/* translators: transaction id */
-			$order->add_order_note( sprintf( __( 'Stripe charge complete (Charge ID: %s)', 'woocommerce-gateway-stripe' ), $notification->data->object->id ) );
+			$order->add_order_note( sprintf( __( 'Stripe charge complete (Charge ID: %s)', 'woocommerce-gateway-stripe' ), $charge->id ) );
 		}
 
 		if ( is_callable( [ $order, 'save' ] ) ) {
@@ -1358,6 +1373,27 @@ private function get_order_from_intent( $intent ) {
 		// Fall back to finding the order via the intent ID.
 		return WC_Stripe_Helper::get_order_by_intent_id( $intent->id );
 	}
+
+	/**
+	 * Get the payment method type from the charge object.
+	 * https://docs.stripe.com/api/charges/object
+	 *
+	 * @param object $charge The charge object from Stripe
+	 * @return string|null The payment method type, or null if not found
+	 */
+	private function get_payment_method_type_from_charge( $charge ) {
+		// We don't expect $charge->source to be set,
+		// but we keep it here to ensure backwards compatibility.
+		if ( isset( $charge->source->type ) ) {
+			return $charge->source->type;
+		}
+
+		if ( isset( $charge->payment_method_details->type ) ) {
+			return $charge->payment_method_details->type;
+		}
+
+		return null;
+	}
 }
 
 new WC_Stripe_Webhook_Handler();

readme.txt

@@ -129,5 +129,6 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 * Update - Update payment method type for Amazon Pay orders.
 * Fix - Compatibility with email preview in the Auth Requested email
 * Update - Update Alipay and bank debit icons.
+* Tweak - Update payment method type check for charge.succeeded webhook.
 
 [See changelog for all versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).

tests/phpunit/test-wc-stripe-webhook-handler.php

@@ -54,6 +54,7 @@ private function mock_webhook_handler( $exclude_methods = [] ) {
 			'get_intent_from_order',
 			'get_latest_charge_from_intent',
 			'process_response',
+			'update_fees',
 		];
 
 		$methods = array_diff( $methods, $exclude_methods );
@@ -624,4 +625,64 @@ public function provide_test_process_payment_intent() {
 			],
 		];
 	}
+
+	/**
+	 * Test for `process_webhook_charge_succeeded`, that it is skipped for synchronous payment methods.
+	 *
+	 * @param string $payment_method_type The payment method type.
+	 * @return void
+	 * @dataProvider provide_test_process_webhook_charge_succeeded_skipped_for_synchronous_payment_methods
+	 */
+	public function test_process_webhook_charge_succeeded_skipped_for_synchronous_payment_methods( $payment_method_type ) {
+		$charge_id    = 'ch_mock9G5K2X1Q';
+		$notification = (object) [
+			'type' => 'charge.succeeded',
+			'data' => (object) [
+				'object' => (object) [
+					'id'                     => $charge_id,
+					'payment_method_details' => (object) [
+						'type' => $payment_method_type,
+					],
+					'captured'               => true,
+					'balance_transaction'    => (object) [
+						'fee' => 100,
+					],
+				],
+			],
+		];
+
+		// We want to assert an early return by checking that we don't run the next line, i.e.
+		// retrieving the order by charge ID. However, we are using WC_Stripe_Helper::get_order_by_charge_id()
+		// which is a static method, and phpunit does not natively support mocking static methods.
+
+		// We will instead create the mock order for the charge ID, so we are able to retrieve an order,
+		// and make sure the next few checks pass so that it reaches the line that calls update_fees()
+		// which we can mock and check if it was called.
+		$order = WC_Helper_Order::create_order();
+		$order->set_status( 'on-hold' );
+		$order->set_transaction_id( $charge_id );
+		$order->save();
+
+		if ( WC_Stripe_Payment_Methods::SEPA_DEBIT === $payment_method_type ) {
+			$this->mock_webhook_handler->expects( $this->once() )->method( 'update_fees' );
+		} else {
+			$this->mock_webhook_handler->expects( $this->never() )->method( 'update_fees' );
+		}
+
+		$this->mock_webhook_handler->process_webhook_charge_succeeded( $notification );
+	}
+
+	/**
+	 * Provider for `test_process_webhook_charge_succeeded_skipped_for_synchronous_payment_methods`.
+	 *
+	 * @return array
+	 */
+	public function provide_test_process_webhook_charge_succeeded_skipped_for_synchronous_payment_methods() {
+		return [
+			'card'           => [ WC_Stripe_Payment_Methods::CARD ],
+			'amazon_pay'     => [ WC_Stripe_Payment_Methods::AMAZON_PAY ],
+			'three_d_secure' => [ 'three_d_secure' ],
+			'sepa_debit'     => [ WC_Stripe_Payment_Methods::SEPA_DEBIT ],
+		];
+	}
 }