Allow saved credit cards with a source ID (src_) to be used/displayed with the new checkout experience (#3513)

* Introduce new function to determine valid payment method IDs

* don't remove valid source token (i.e those with card payment method type

* Create new saved tokens for sources, but only if they belong to card method type

* add changelog entries

* Use strpos instead of a function that requires PHP 8+

* Fix typo in changelog entry

Author: mattallan

changelog.txt

@@ -32,6 +32,7 @@
 * Fix - Update Cash App payments to avoid confirming on creation, resolving issues with generic payment failures in live mode.
 * Tweak - Add order lock for redirect payments.
 * Fix - Missing Stripe Fee and Stripe Payout details on orders that were captured manually.
+* Fix - Allow legacy `src_` payment methods linked to a saved credit card to be displayed on the checkout and My Account pages when the new checkout experience is enabled.
 
 = 8.7.0 - 2024-09-16 =
 * Add - Introduces a new promotional surface to encourage merchants with the legacy checkout experience and APMs enabled to use the new checkout experience.

includes/class-wc-stripe-payment-tokens.php

@@ -270,10 +270,10 @@ public function woocommerce_get_customer_upe_payment_tokens( $tokens, $user_id,
 
 					// Remove the following deprecated tokens:
 					// - APM tokens from before Split PE was in place.
-					// - Tokens using the sources API. Payments using these will fail with the PaymentMethods API.
+					// - Non-credit card tokens using the sources API. Payments using these will fail with the PaymentMethods API.
 					if (
 						( 'stripe' === $token->get_gateway_id() && WC_Stripe_Payment_Methods::SEPA === $token->get_type() ) ||
-						str_starts_with( $token->get_token(), 'src_' )
+						! $this->is_valid_payment_method_id( $token->get_token(), $this->get_payment_method_type_from_token( $token ) )
 					) {
 						$deprecated_tokens[ $token->get_token() ] = $token;
 						continue;
@@ -316,11 +316,11 @@ public function woocommerce_get_customer_upe_payment_tokens( $tokens, $user_id,
 
 				// Create a new token when:
 				// - The payment method doesn't have an associated token in WooCommerce.
-				// - The payment method is not a source.
+				// - The payment method is a valid PaymentMethodID (i.e. only support IDs starting with "src_" when using the card payment method type.
 				// - The payment method belongs to the gateway ID being retrieved or the gateway ID is empty (meaning we're looking for all payment methods).
 				if (
 					! isset( $stored_tokens[ $payment_method->id ] ) &&
-					! str_starts_with( $payment_method->id, 'src_' ) &&
+					$this->is_valid_payment_method_id( $payment_method->id, $payment_method_type ) &&
 					( $this->is_valid_payment_method_type_for_gateway( $payment_method_type, $gateway_id ) || empty( $gateway_id ) )
 				) {
 					$token                      = $this->add_token_to_user( $payment_method, $customer );
@@ -602,6 +602,24 @@ public static function update_token_from_method_details( $user_id, $payment_meth
 		}
 	}
 
+	/**
+	 * Returns true if the payment method ID is valid for the given payment method type.
+	 *
+	 * Payment method IDs beginning with 'src_' are only valid for card payment methods.
+	 *
+	 * @param string $payment_method_id   The payment method ID (e.g. 'pm_123' or 'src_123').
+	 * @param string $payment_method_type The payment method type.
+	 *
+	 * @return bool
+	 */
+	public function is_valid_payment_method_id( $payment_method_id, $payment_method_type = '' ) {
+		if ( 0 === strpos( $payment_method_id, 'pm_' ) ) {
+			return true;
+		}
+
+		return 0 === strpos( $payment_method_id, 'src_' ) && WC_Stripe_Payment_Methods::CARD === $payment_method_type;
+	}
+
 	/**
 	 * Controls the output for SEPA on the my account page.
 	 *

readme.txt

@@ -160,5 +160,6 @@ If you get stuck, you can ask for help in the Plugin Forum.
 * Fix - Update Cash App payments to avoid confirming on creation, resolving issues with generic payment failures in live mode.
 * Tweak - Add order lock for redirect payments.
 * Fix - Missing Stripe Fee and Stripe Payout details on orders that were captured manually.
+* Fix - Allow legacy `src_` payment methods linked to a saved credit card to be displayed on the checkout and My Account pages when the new checkout experience is enabled.
 
 [See changelog for all versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).

tests/phpunit/test-class-wc-stripe-payment-tokens.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ * Class WC_Stripe_Payment_Tokens tests.
+ */
+class WC_Stripe_Payment_Tokens_Test extends WP_UnitTestCase {
+
+	/**
+	 * WC_Stripe_Payment_Tokens instance.
+	 *
+	 * @var WC_Stripe_Payment_Tokens
+	 */
+	private $stripe_payment_tokens;
+
+	public function set_up() {
+		parent::set_up();
+		$this->stripe_payment_tokens = new WC_Stripe_Payment_Tokens();
+	}
+
+	public function test_is_valid_payment_method_id() {
+		$this->assertTrue( $this->stripe_payment_tokens->is_valid_payment_method_id( 'pm_1234567890' ) );
+		$this->assertTrue( $this->stripe_payment_tokens->is_valid_payment_method_id( 'pm_1234567890', 'card' ) );
+		$this->assertTrue( $this->stripe_payment_tokens->is_valid_payment_method_id( 'pm_1234567890', 'sepa' ) );
+
+		// Test with source id (only card payment method type is valid).
+		$this->assertTrue( $this->stripe_payment_tokens->is_valid_payment_method_id( 'src_1234567890', 'card' ) );
+		$this->assertFalse( $this->stripe_payment_tokens->is_valid_payment_method_id( 'src_1234567890', 'sepa' ) );
+		$this->assertFalse( $this->stripe_payment_tokens->is_valid_payment_method_id( 'src_1234567890', 'giropay' ) );
+	}
+}