Show payment methods available in the PMC on settings page (#4252)

* get available payment methods list from pmc

* move if condition to the gateway class function

* rename method

* add changelog

* force fetch pmc only once

* revert cleanup

* add sepa_debit in list of upe available methods

* fix settings controller tests

* remove sepa duplicate entry

* mock configuration and fix tests

* remove unused param

* add comments

* bail if pmc is not enabled

Author: Mayisha

changelog.txt

@@ -23,6 +23,7 @@
 * Dev - Improve SPE e2e tests to reduce flakiness
 * Fix - Prevents fatal errors for cases where we fail to load product details
 * Fix - Address an edge case with webhook URL comparisons
+* Add - Only show payment methods in Stripe settings that are available for the connected Stripe account.
 * Fix - Show correct gateway name in non payments settings pages.
 * Update - Add support for customer order notes and express checkout
 * Dev - Minor fix to e2e setup code

includes/admin/class-wc-rest-stripe-settings-controller.php

@@ -244,9 +244,13 @@ public function register_routes() {
 	 */
 	public function get_settings() {
 		$is_upe_enabled               = WC_Stripe_Feature_Flags::is_upe_checkout_enabled();
+		// When UPE and the payment method configurations API are enabled, fetch the enabled payment methods from the payment method configurations API.
+		// We force a refresh of the enabled payment methods (by passing true) when on the settings page to ensure the latest data.
+		// The available payment methods are also fetched from the payment method configurations API under similar conditions,
+		// but we do not force a refresh for available methods, since calling get_upe_enabled_payment_method_ids first already ensures the list is up to date.
+		$enabled_payment_method_ids   = $is_upe_enabled ? $this->gateway->get_upe_enabled_payment_method_ids( true ) : WC_Stripe_Helper::get_legacy_enabled_payment_method_ids();
 		$available_payment_method_ids = $is_upe_enabled ? $this->gateway->get_upe_available_payment_methods() : WC_Stripe_Helper::get_legacy_available_payment_method_ids();
 		$ordered_payment_method_ids   = $is_upe_enabled ? WC_Stripe_Helper::get_upe_ordered_payment_method_ids( $this->gateway ) : $available_payment_method_ids;
-		$enabled_payment_method_ids   = $is_upe_enabled ? $this->gateway->get_upe_enabled_payment_method_ids( true ) : WC_Stripe_Helper::get_legacy_enabled_payment_method_ids();
 
 		return new WP_REST_Response(
 			[

includes/class-wc-stripe-payment-method-configurations.php

@@ -143,6 +143,31 @@ public static function get_parent_configuration_id() {
 		return self::get_primary_configuration()->parent ?? null;
 	}
 
+	/**
+	 * Get the UPE available payment method IDs.
+	 *
+	 * @return array
+	 */
+	public static function get_upe_available_payment_method_ids() {
+		// Bail if the payment method configurations API is not enabled.
+		if ( ! self::is_enabled() ) {
+			return [];
+		}
+
+		$available_payment_method_ids          = [];
+		$merchant_payment_method_configuration = self::get_primary_configuration();
+
+		if ( $merchant_payment_method_configuration ) {
+			foreach ( $merchant_payment_method_configuration as $payment_method_id => $payment_method ) {
+				if ( isset( $payment_method->display_preference->value ) && isset( WC_Stripe_UPE_Payment_Gateway::UPE_AVAILABLE_METHODS[ $payment_method_id ] ) ) {
+					$available_payment_method_ids[] = $payment_method_id;
+				}
+			}
+		}
+
+		return $available_payment_method_ids;
+	}
+
 	/**
 	 * Get the UPE enabled payment method IDs.
 	 *

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

@@ -37,7 +37,7 @@ class WC_Stripe_UPE_Payment_Gateway extends WC_Gateway_Stripe {
 		WC_Stripe_Payment_Methods::BOLETO            => WC_Stripe_UPE_Payment_Method_Boleto::class,
 		WC_Stripe_Payment_Methods::IDEAL             => WC_Stripe_UPE_Payment_Method_Ideal::class,
 		WC_Stripe_Payment_Methods::OXXO              => WC_Stripe_UPE_Payment_Method_Oxxo::class,
-		WC_Stripe_Payment_Methods::SEPA              => WC_Stripe_UPE_Payment_Method_Sepa::class,
+		WC_Stripe_Payment_Methods::SEPA_DEBIT        => WC_Stripe_UPE_Payment_Method_Sepa::class,
 		WC_Stripe_Payment_Methods::P24               => WC_Stripe_UPE_Payment_Method_P24::class,
 		WC_Stripe_Payment_Methods::SOFORT            => WC_Stripe_UPE_Payment_Method_Sofort::class,
 		WC_Stripe_Payment_Methods::MULTIBANCO        => WC_Stripe_UPE_Payment_Method_Multibanco::class,
@@ -684,16 +684,21 @@ public function get_upe_enabled_at_checkout_payment_method_ids( $order_id = null
 	 * @return string[]
 	 */
 	public function get_upe_available_payment_methods() {
-		$available_payment_methods = [];
+		// If the payment method configurations API is not enabled, fall back to determining available payment methods
+		// based on the plugin's internal logic.
+		if ( ! WC_Stripe_Payment_Method_Configurations::is_enabled() ) {
+			$available_payment_methods = [];
 
-		foreach ( $this->payment_methods as $payment_method ) {
-			if ( is_callable( [ $payment_method, 'is_available_for_account_country' ] ) && ! $payment_method->is_available_for_account_country() ) {
-				continue;
+			foreach ( $this->payment_methods as $payment_method ) {
+				if ( is_callable( [ $payment_method, 'is_available_for_account_country' ] ) && ! $payment_method->is_available_for_account_country() ) {
+					continue;
+				}
+				$available_payment_methods[] = $payment_method->get_id();
 			}
-			$available_payment_methods[] = $payment_method->get_id();
+			return $available_payment_methods;
 		}
 
-		return $available_payment_methods;
+		return WC_Stripe_Payment_Method_Configurations::get_upe_available_payment_method_ids();
 	}
 
 	/**
@@ -742,6 +747,12 @@ private function get_stripe_supported_payment_methods() {
 		$supported_stripe_ids         = [];
 		$available_payment_method_ids = $this->get_upe_available_payment_methods();
 
+		// Return the list if the payment method configurations API is enabled.
+		// We don't need any additional filtering as the list is already fetched from the payment method configurations API..
+		if ( WC_Stripe_Payment_Method_Configurations::is_enabled() ) {
+			return $available_payment_method_ids;
+		}
+
 		foreach ( self::UPE_AVAILABLE_METHODS as $gateway_class ) {
 			$gateway = new $gateway_class();
 

readme.txt

@@ -133,6 +133,7 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 * Dev - Improve SPE e2e tests to reduce flakiness
 * Fix - Prevents fatal errors for cases where we fail to load product details
 * Fix - Address an edge case with webhook URL comparisons
+* Add - Only show payment methods in Stripe settings that are available for the connected Stripe account.
 * Fix - Show correct gateway name in non payments settings pages.
 * Update - Add support for customer order notes and express checkout
 * Dev - Minor fix to e2e setup code

tests/phpunit/admin/test-class-wc-rest-stripe-settings-controller-gb.php

@@ -90,7 +90,6 @@ public function set_up() {
 		$upe_helper = new UPE_Test_Helper();
 		$upe_helper->enable_upe();
 		$upe_helper->reload_payment_gateways();
-		$this->mock_payment_method_configurations( [ 'card' ], [] );
 
 		$this->controller = new WC_REST_Stripe_Settings_Controller( new WC_Stripe_UPE_Payment_Gateway() );
 
@@ -117,6 +116,7 @@ public function test_get_settings_returns_available_payment_method_ids_for_gb()
 			WC_Stripe_Payment_Methods::ACSS_DEBIT,
 			WC_Stripe_Payment_Methods::BACS_DEBIT,
 		];
+		$this->mock_payment_method_configurations( $expected_method_ids, [] );
 
 		$response             = $this->rest_get_settings();
 		$available_method_ids = $response->get_data()['available_payment_method_ids'];
@@ -148,6 +148,7 @@ public function test_get_settings_returns_ordered_payment_method_ids_for_gb() {
 			WC_Stripe_Payment_Methods::ACSS_DEBIT,
 			WC_Stripe_Payment_Methods::BACS_DEBIT,
 		];
+		$this->mock_payment_method_configurations( $expected_ordered_method_ids, [] );
 
 		$response = $this->rest_get_settings();
 

tests/phpunit/admin/test-class-wc-rest-stripe-settings-controller.php

@@ -112,7 +112,7 @@ public function test_get_stripe_payment_method_configurations_settings( $enabled
 	 */
 	public function test_update_stripe_payment_method_configurations_settings() {
 		// Set up initial state with only card enabled
-		$this->mock_payment_method_configurations( [ 'card' ], [] );
+		$this->mock_payment_method_configurations( [ 'card' ], [ 'amazon_pay', 'google_pay', 'apple_pay' ] );
 
 		// Set pmc_enabled to yes to prevent migration
 		$stripe_settings = WC_Stripe_Helper::get_stripe_settings();
@@ -285,8 +285,6 @@ public function test_individual_payment_method_settings() {
 	}
 
 	public function test_get_settings_returns_available_payment_method_ids() {
-		$response = $this->rest_get_settings();
-
 		$expected_method_ids  = [
 			WC_Stripe_Payment_Methods::CARD,
 			WC_Stripe_Payment_Methods::ACH,
@@ -308,6 +306,9 @@ public function test_get_settings_returns_available_payment_method_ids() {
 			WC_Stripe_Payment_Methods::CASHAPP_PAY,
 			WC_Stripe_Payment_Methods::ACSS_DEBIT,
 		];
+		$this->mock_payment_method_configurations( $expected_method_ids, [] );
+
+		$response             = $this->rest_get_settings();
 		$available_method_ids = $response->get_data()['available_payment_method_ids'];
 
 		$this->assertEquals(
@@ -357,6 +358,7 @@ public function test_get_settings_returns_ordered_payment_method_ids() {
 			WC_Stripe_Payment_Methods::CASHAPP_PAY,
 			WC_Stripe_Payment_Methods::ACSS_DEBIT,
 		];
+		$this->mock_payment_method_configurations( $expected_method_ids, [] );
 
 		$response           = $this->rest_get_settings();
 		$ordered_method_ids = $response->get_data()['ordered_payment_method_ids'];

tests/phpunit/payment-methods/test-class-wc-stripe-upe-payment-gateway-gb.php

@@ -64,6 +64,7 @@ public function tear_down() {
 	 * @dataProvider get_upe_available_payment_methods_provider
 	 */
 	public function test_get_upe_available_payment_methods_for_gb( $country, $available_payment_methods ) {
+		$this->mock_payment_method_configurations( $available_payment_methods );
 		$expected = $this->mock_gateway->get_upe_available_payment_methods();
 
 		$this->assertSame( $available_payment_methods, $expected );

tests/phpunit/payment-methods/test-class-wc-stripe-upe-payment-gateway.php

@@ -253,6 +253,7 @@ private function get_order_details( $order ) {
 	 * @dataProvider get_upe_available_payment_methods_provider
 	 */
 	public function test_get_upe_available_payment_methods( $country, $available_payment_methods ) {
+		$this->mock_payment_method_configurations( $available_payment_methods );
 		$this->set_stripe_account_data( [ 'country' => $country ] ); // TODO: Verify if the country is actually changing in the gateway.
 		$this->assertSame( $available_payment_methods, $this->mock_gateway->get_upe_available_payment_methods(), "Available payment methods are not the same for $country" );
 	}