Fix wc_gateway_stripe_process_payment action not called for sync payments (#4485)

* Deprecate wc_gateway_stripe_process_redirect_payment
* Deprecate wc_gateway_stripe_process_webhook_payment
* Add new filter wc_gateway_stripe_process_payment_charge

Author: diegocurbelo

changelog.txt

@@ -22,6 +22,7 @@
 * Fix - Set default values for custom field options
 * Fix - Enforce rate limiter for failed add payment method attempts
 * Update - Add the number of pending webhooks to the Account status section
+* Update - Deprecate `wc_gateway_stripe_process_payment`, `wc_gateway_stripe_process_redirect_payment` and `wc_gateway_stripe_process_webhook_payment` actions in favour of `wc_gateway_stripe_process_payment_charge`
 
 = 9.6.0 - 2025-07-07 =
 * Fix - Register Express Checkout script before use to restore buttons on “order-pay” pages

includes/abstracts/abstract-wc-stripe-payment-gateway.php

@@ -534,7 +534,12 @@ public function generate_payment_request( $order, $prepared_payment_method ) {
 	}
 
 	/**
-	 * Store extra meta data for an order from a Stripe Response.
+	 * Store extra meta data for an order from a Stripe charge response.
+	 *
+	 * @param object $response The Charge response from Stripe.
+	 * @param WC_Order $order The Order object.
+	 *
+	 * @return object The Charge response from Stripe.
 	 *
 	 * @throws WC_Stripe_Exception
 	 */
@@ -548,6 +553,14 @@ public function process_response( $response, $order ) {
 			throw new WC_Stripe_Exception( print_r( $response, true ), $localized_message );
 		}
 
+		/**
+		 * Allow third-party code to add custom logic before processing the charge data from Stripe.
+		 *
+		 * @param object $response The Charge response from Stripe.
+		 * @param WC_Order $order The Order object.
+		 */
+		do_action( 'wc_gateway_stripe_process_payment_charge', $response, $order );
+
 		$order_id = $order->get_id();
 		$captured = ( isset( $response->captured ) && $response->captured ) ? 'yes' : 'no';
 

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

@@ -219,7 +219,13 @@ public function process_redirect_payment( $order_id, $retry = true, $previous_er
 				return;
 			}
 
-			do_action( 'wc_gateway_stripe_process_redirect_payment', $response, $order );
+			do_action_deprecated(
+				'wc_gateway_stripe_process_redirect_payment',
+				[ $response, $order ],
+				'9.7.0',
+				'wc_gateway_stripe_process_payment_charge',
+				'The wc_gateway_stripe_process_redirect_payment action is deprecated. Use wc_gateway_stripe_process_payment_charge instead.'
+			);
 
 			$this->process_response( $response, $order );
 

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

@@ -360,7 +360,13 @@ public function process_webhook_payment( $notification, $retry = true ) {
 				return;
 			}
 
-			do_action( 'wc_gateway_stripe_process_webhook_payment', $response, $order );
+			do_action_deprecated(
+				'wc_gateway_stripe_process_webhook_payment',
+				[ $response, $order ],
+				'9.7.0',
+				'wc_gateway_stripe_process_payment_charge',
+				'The wc_gateway_stripe_process_webhook_payment action is deprecated. Use wc_gateway_stripe_process_payment_charge instead.'
+			);
 
 			$response->is_webhook_response = true;
 			$this->process_response( $response, $order );
@@ -1080,7 +1086,13 @@ public function process_payment_intent( $notification ) {
 				if ( $is_voucher_payment || $is_wallet_payment || ( ! $process_webhook_async && ! $is_awaiting_action ) ) {
 					$charge = $this->get_latest_charge_from_intent( $intent );
 
-					do_action( 'wc_gateway_stripe_process_payment', $charge, $order );
+					do_action_deprecated(
+						'wc_gateway_stripe_process_payment',
+						[ $charge, $order ],
+						'9.7.0',
+						'wc_gateway_stripe_process_payment_charge',
+						'The wc_gateway_stripe_process_payment action is deprecated. Use wc_gateway_stripe_process_payment_charge instead.'
+					);
 
 					$charge->is_webhook_response = true;
 					$this->process_response( $charge, $order );
@@ -1286,7 +1298,14 @@ protected function handle_deferred_payment_intent_succeeded( $order, $intent_id
 
 		WC_Stripe_Logger::log( "Processing Stripe PaymentIntent {$intent_id} for order {$order->get_id()} via deferred webhook." );
 
-		do_action( 'wc_gateway_stripe_process_payment', $charge, $order );
+		do_action_deprecated(
+			'wc_gateway_stripe_process_payment',
+			[ $charge, $order ],
+			'9.7.0',
+			'wc_gateway_stripe_process_payment_charge',
+			'The wc_gateway_stripe_process_payment action is deprecated. Use wc_gateway_stripe_process_payment_charge instead.'
+		);
+
 		$charge->is_webhook_response = true;
 		$this->process_response( $charge, $order );
 	}

includes/compat/trait-wc-stripe-subscriptions.php

@@ -571,7 +571,13 @@ public function process_subscription_payment( $amount, $renewal_order, $retry =
 				do_action( 'wc_gateway_stripe_process_payment_subscription_charge_attempt_delayed', $response, $renewal_order );
 			} else {
 				// The charge was successfully captured
-				do_action( 'wc_gateway_stripe_process_payment', $response, $renewal_order );
+				do_action_deprecated(
+					'wc_gateway_stripe_process_payment',
+					[ $response, $renewal_order ],
+					'9.7.0',
+					'wc_gateway_stripe_process_payment_charge',
+					'The wc_gateway_stripe_process_payment action is deprecated. Use wc_gateway_stripe_process_payment_charge instead.'
+				);
 
 				// Use the last charge within the intent or the full response body in case of SEPA.
 				$latest_charge = $this->get_latest_charge_from_intent( $response );

includes/payment-methods/class-wc-gateway-stripe-sepa.php

@@ -373,7 +373,13 @@ public function process_payment( $order_id, $retry = true, $force_save_source =
 					throw new WC_Stripe_Exception( print_r( $response, true ), $localized_message );
 				}
 
-				do_action( 'wc_gateway_stripe_process_payment', $response, $order );
+				do_action_deprecated(
+					'wc_gateway_stripe_process_payment',
+					[ $response, $order ],
+					'9.7.0',
+					'wc_gateway_stripe_process_payment_charge',
+					'The wc_gateway_stripe_process_payment action is deprecated. Use wc_gateway_stripe_process_payment_charge instead.'
+				);
 
 				// Process valid response.
 				$this->process_response( $response, $order );

readme.txt

@@ -132,5 +132,6 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 * Fix - Set default values for custom field options
 * Fix - Enforce rate limiter for failed add payment method attempts
 * Update - Add the number of pending webhooks to the Account status section
+* Update - Deprecate `wc_gateway_stripe_process_payment`, `wc_gateway_stripe_process_redirect_payment` and `wc_gateway_stripe_process_webhook_payment` actions in favour of `wc_gateway_stripe_process_payment_charge`
 
 [See changelog for full details across versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).

tests/phpunit/PaymentMethods/WC_Stripe_UPE_Payment_Gateway_Test.php

@@ -1459,6 +1459,45 @@ public function test_process_response_updates_order_by_charge_status() {
 		$this->assertMatchesRegularExpression( '/Payment processing failed./', $exception->getLocalizedMessage() );
 	}
 
+	/**
+	 * Test that the wc_gateway_stripe_process_payment_charge action is triggered when process_response() is called for synchronous payment paths.
+	 */
+	public function test_process_response_triggers_wc_gateway_stripe_process_payment_charge_action() {
+		$payment_method_id = 'pm_mock';
+		$customer_id       = 'cus_mock';
+		$order             = WC_Helper_Order::create_order();
+		$order_id          = $order->get_id();
+
+		$payment_method_mock                     = self::MOCK_CARD_PAYMENT_METHOD_TEMPLATE;
+		$payment_method_mock['id']               = $payment_method_id;
+		$payment_method_mock['customer']         = $customer_id;
+		$payment_method_mock['card']['exp_year'] = intval( gmdate( 'Y' ) ) + 1;
+
+		$charge_mock                           = self::MOCK_CARD_PAYMENT_INTENT_TEMPLATE['charges']['data'][0];
+		$charge_mock['payment_method_details'] = $payment_method_mock;
+		$charge_mock['captured']               = true;
+		$charge_mock['status']                 = 'succeeded';
+		$charge_mock['id']                     = 'ch_mock_success';
+
+		$mock_action_process_payment = new MockAction();
+		add_action(
+			'wc_gateway_stripe_process_payment_charge',
+			[ &$mock_action_process_payment, 'action' ]
+		);
+
+		$this->mock_gateway->process_response( $this->array_to_object( $charge_mock ), wc_get_order( $order_id ) );
+
+		$final_order = wc_get_order( $order_id );
+
+		// Test the action was called only once.
+		$this->assertEquals( 1, $mock_action_process_payment->get_call_count() );
+
+		// Test the order was processed successfully.
+		$this->assertEquals( OrderStatus::PROCESSING, $final_order->get_status() );
+		$this->assertEquals( 'yes', $final_order->get_meta( '_stripe_charge_captured', true ) );
+		$this->assertEquals( $charge_mock['id'], $final_order->get_transaction_id() );
+	}
+
 	/**
 	 * TESTS FOR SAVED PAYMENTS.
 	 */
@@ -2034,7 +2073,7 @@ public function test_subscription_renewal_is_successful() {
 		// by hooking into it.
 		$mock_action_process_payment = new MockAction();
 		add_action(
-			'wc_gateway_stripe_process_payment',
+			'wc_gateway_stripe_process_payment_charge',
 			[ &$mock_action_process_payment, 'action' ]
 		);
 
@@ -2083,7 +2122,7 @@ public function test_subscription_renewal_is_successful() {
 		// Assert: Our hook was called once.
 		$this->assertEquals( 1, $mock_action_process_payment->get_call_count() );
 		// Assert: Only our hook was called.
-		$this->assertEquals( [ 'wc_gateway_stripe_process_payment' ], $mock_action_process_payment->get_tags() );
+		$this->assertEquals( [ 'wc_gateway_stripe_process_payment_charge' ], $mock_action_process_payment->get_tags() );
 	}
 
 	/**

tests/phpunit/WC_Stripe_Subscription_Renewal_Test.php

@@ -224,7 +224,7 @@ public function test_renewal_successful() {
 		// by hooking into it.
 		$mock_action_process_payment = new MockAction();
 		add_action(
-			'wc_gateway_stripe_process_payment',
+			'wc_gateway_stripe_process_payment_charge',
 			[ &$mock_action_process_payment, 'action' ]
 		);
 
@@ -256,7 +256,7 @@ public function test_renewal_successful() {
 		$this->assertEquals( 1, $mock_action_process_payment->get_call_count() );
 
 		// Assert: Only our hook was called.
-		$this->assertEquals( [ 'wc_gateway_stripe_process_payment' ], $mock_action_process_payment->get_tags() );
+		$this->assertEquals( [ 'wc_gateway_stripe_process_payment_charge' ], $mock_action_process_payment->get_tags() );
 
 		// Clean up.
 		remove_filter( 'pre_http_request', [ $this, 'pre_http_request_response_success' ] );

tests/phpunit/WC_Stripe_Webhook_Handler_Test.php

@@ -75,6 +75,18 @@ private function mock_webhook_handler( $exclude_methods = [] ) {
 		$this->mock_webhook_handler = $this->getMockBuilder( WC_Stripe_Webhook_Handler::class )
 			->setMethods( $methods )
 			->getMock();
+
+		// Set process_response mock to use the real method.
+		// We need to mock this because several tests check that it's not called or called a specific number of times.
+		$this->mock_webhook_handler->expects( $this->any() )
+		->method( 'process_response' )
+		->willReturnCallback(
+			function ( $response, $order ) {
+				// Call the real method
+				$real_handler = new WC_Stripe_Webhook_Handler();
+				return $real_handler->process_response( $response, $order );
+			}
+		);
 	}
 
 	/**
@@ -427,7 +439,7 @@ public function test_process_payment_intent(
 	) {
 		$mock_action_process_payment = new MockAction();
 		add_action(
-			'wc_gateway_stripe_process_payment',
+			'wc_gateway_stripe_process_payment_charge',
 			[ &$mock_action_process_payment, 'action' ]
 		);
 
@@ -590,7 +602,7 @@ public function provide_test_process_payment_intent() {
 				'order locked'                   => false,
 				'payment type'                   => WC_Stripe_Payment_Methods::BOLETO,
 				'order status final'             => false,
-				'expected status'                => OrderStatus::PENDING,
+				'expected status'                => OrderStatus::PROCESSING,
 				'expected note'                  => '',
 				'expected process payment calls' => 1,
 				'expected process payment intent incomplete calls' => 0,