Fixing and simplifying payment tokens comparison (#4667)

wjrosa · daledupreez · web-flow · commit 67c924b86e9f · 2025-09-17T09:15:34.000-03:00
* Simplifying payment tokens comparison

* Fix cashapp token gateway ID

* Fix CashApp comparison method

* Changelog and readme entries

* Update includes/payment-tokens/class-wc-stripe-ach-payment-token.php

Co-authored-by: daledupreez &lt;dale.du.preez@automattic.com&gt;

* Update includes/payment-tokens/class-wc-stripe-becs-debit-payment-token.php

Co-authored-by: daledupreez &lt;dale.du.preez@automattic.com&gt;

---------

Co-authored-by: daledupreez &lt;dale.du.preez@automattic.com&gt;
diff --git a/changelog.txt b/changelog.txt
@@ -1,6 +1,7 @@
 *** Changelog ***
 
 = 9.10.0 - xxxx-xx-xx =
+* Fix - Minor fixes and code improvements for the saved payment methods comparison logic
 * Dev - Upgrades Node to v20
 * Add - Allow the purchase of free trials using the Express Payment methods when the product does not require shipping
 * Update - Changes the documentation page URL for the Optimized Checkout feature to https://woocommerce.com/document/stripe/admin-experience/optimized-checkout-suite/
diff --git a/includes/payment-methods/class-wc-stripe-upe-payment-method-cash-app-pay.php b/includes/payment-methods/class-wc-stripe-upe-payment-method-cash-app-pay.php
@@ -74,9 +74,7 @@ public function get_retrievable_type() {
 	public function create_payment_token_for_user( $user_id, $payment_method ) {
 		$token = new WC_Payment_Token_CashApp();
 
-		$gateway_id = $this->is_oc_enabled() ? 'stripe' : $this->id;
-
-		$token->set_gateway_id( $gateway_id );
+		$token->set_gateway_id( WC_Stripe_Payment_Tokens::UPE_REUSABLE_GATEWAYS_BY_PAYMENT_METHOD[ self::STRIPE_ID ] );
 		$token->set_token( $payment_method->id );
 		$token->set_user_id( $user_id );
 
diff --git a/includes/payment-tokens/class-wc-stripe-ach-payment-token.php b/includes/payment-tokens/class-wc-stripe-ach-payment-token.php
@@ -161,12 +161,11 @@ public function set_last4( $last4 ) {
 	 * @inheritDoc
 	 */
 	public function is_equal_payment_method( $payment_method ): bool {
-		if (
-			WC_Stripe_Payment_Methods::ACH === $payment_method->type
-			&& ( $payment_method->{WC_Stripe_Payment_Methods::ACH}->fingerprint ?? null ) === $this->get_fingerprint() ) {
-			return true;
+		if ( WC_Stripe_Payment_Methods::ACH !== $payment_method->type ) {
+			return false;
 		}
 
-		return false;
+		// ACH uses the `us_bank_account` property
+		return ( $payment_method->us_bank_account->fingerprint ?? null ) === $this->get_fingerprint();
 	}
 }
diff --git a/includes/payment-tokens/class-wc-stripe-acss-payment-token.php b/includes/payment-tokens/class-wc-stripe-acss-payment-token.php
@@ -41,12 +41,11 @@ class WC_Payment_Token_ACSS extends WC_Payment_Token implements WC_Stripe_Paymen
 	 * @return bool
 	 */
 	public function is_equal_payment_method( $payment_method ): bool {
-		if ( WC_Stripe_Payment_Methods::ACSS_DEBIT === $payment_method->type
-			&& ( $payment_method->acss_debit->fingerprint ?? null ) === $this->get_fingerprint() ) {
-			return true;
+		if ( WC_Stripe_Payment_Methods::ACSS_DEBIT !== $payment_method->type ) {
+			return false;
 		}
 
-		return false;
+		return ( $payment_method->acss_debit->fingerprint ?? null ) === $this->get_fingerprint();
 	}
 
 	/**
diff --git a/includes/payment-tokens/class-wc-stripe-amazon-pay-payment-token.php b/includes/payment-tokens/class-wc-stripe-amazon-pay-payment-token.php
@@ -79,11 +79,10 @@ public function set_email( $email ) {
 	 * @inheritDoc
 	 */
 	public function is_equal_payment_method( $payment_method ): bool {
-		if ( WC_Stripe_Payment_Methods::AMAZON_PAY === $payment_method->type
-			&& ( $payment_method->billing_details->email ?? null ) === $this->get_email() ) {
-			return true;
+		if ( WC_Stripe_Payment_Methods::AMAZON_PAY !== $payment_method->type ) {
+			return false;
 		}
 
-		return false;
+		return ( $payment_method->billing_details->email ?? null ) === $this->get_email();
 	}
 }
diff --git a/includes/payment-tokens/class-wc-stripe-bacs-payment-token.php b/includes/payment-tokens/class-wc-stripe-bacs-payment-token.php
@@ -40,12 +40,11 @@ class WC_Payment_Token_Bacs_Debit extends WC_Payment_Token implements WC_Stripe_
 	 * @return bool
 	 */
 	public function is_equal_payment_method( $payment_method ): bool {
-		if ( WC_Stripe_Payment_Methods::BACS_DEBIT === $payment_method->type
-			&& ( $payment_method->bacs_debit->fingerprint ?? null ) === $this->get_fingerprint() ) {
-			return true;
+		if ( WC_Stripe_Payment_Methods::BACS_DEBIT !== $payment_method->type ) {
+			return false;
 		}
 
-		return false;
+		return ( $payment_method->bacs_debit->fingerprint ?? null ) === $this->get_fingerprint();
 	}
 
 	/**
diff --git a/includes/payment-tokens/class-wc-stripe-becs-debit-payment-token.php b/includes/payment-tokens/class-wc-stripe-becs-debit-payment-token.php
@@ -111,12 +111,11 @@ public function set_last4( $last4 ) {
 	 * @inheritDoc
 	 */
 	public function is_equal_payment_method( $payment_method ): bool {
-		if (
-			WC_Stripe_Payment_Methods::BECS_DEBIT === $payment_method->type
-			&& ( $payment_method->{WC_Stripe_Payment_Methods::BECS_DEBIT}->fingerprint ?? null ) === $this->get_fingerprint() ) {
-			return true;
+		if ( WC_Stripe_Payment_Methods::BECS_DEBIT !== $payment_method->type ) {
+			return false;
 		}
 
-		return false;
+		// Becs Debit uses the au_becs_debit property.
+		return ( $payment_method->au_becs_debit->fingerprint ?? null ) === $this->get_fingerprint();
 	}
 }
diff --git a/includes/payment-tokens/class-wc-stripe-cash-app-payment-token.php b/includes/payment-tokens/class-wc-stripe-cash-app-payment-token.php
@@ -67,12 +67,11 @@ public function get_cashtag() {
 	 * @inheritDoc
 	 */
 	public function is_equal_payment_method( $payment_method ): bool {
-		if ( WC_Stripe_Payment_Methods::CASHAPP_PAY === $this->get_type()
-			&& ( $payment_method->cashapp->cashtag ?? null ) === $this->get_cashtag() ) {
-			return true;
+		if ( WC_Stripe_Payment_Methods::CASHAPP_PAY !== $payment_method->type ) {
+			return false;
 		}
 
-		return false;
+		return ( $payment_method->cashapp->cashtag ?? null ) === $this->get_cashtag();
 	}
 
 	/**
diff --git a/includes/payment-tokens/class-wc-stripe-cc-payment-token.php b/includes/payment-tokens/class-wc-stripe-cc-payment-token.php
@@ -35,11 +35,10 @@ public function __construct( $token = '' ) {
 	 * @inheritDoc
 	 */
 	public function is_equal_payment_method( $payment_method ): bool {
-		if ( WC_Stripe_Payment_Methods::CARD === $payment_method->type
-			&& ( $payment_method->card->fingerprint ?? null ) === $this->get_fingerprint() ) {
-			return true;
+		if ( WC_Stripe_Payment_Methods::CARD !== $payment_method->type ) {
+			return false;
 		}
 
-		return false;
+		return ( $payment_method->card->fingerprint ?? null ) === $this->get_fingerprint();
 	}
 }
diff --git a/includes/payment-tokens/class-wc-stripe-link-payment-token.php b/includes/payment-tokens/class-wc-stripe-link-payment-token.php
@@ -98,11 +98,10 @@ public function set_email( $email ) {
 	 * @inheritDoc
 	 */
 	public function is_equal_payment_method( $payment_method ): bool {
-		if ( WC_Stripe_Payment_Methods::LINK === $payment_method->type
-			&& ( $payment_method->link->email ?? null ) === $this->get_email() ) {
-			return true;
+		if ( WC_Stripe_Payment_Methods::LINK !== $payment_method->type ) {
+			return false;
 		}
 
-		return false;
+		return ( $payment_method->link->email ?? null ) === $this->get_email();
 	}
 }
diff --git a/includes/payment-tokens/class-wc-stripe-sepa-payment-token.php b/includes/payment-tokens/class-wc-stripe-sepa-payment-token.php
@@ -135,11 +135,10 @@ public function get_payment_method_type( $context = 'view' ) {
 	 * @inheritDoc
 	 */
 	public function is_equal_payment_method( $payment_method ): bool {
-		if ( WC_Stripe_Payment_Methods::SEPA_DEBIT === $payment_method->type
-			&& ( $payment_method->sepa_debit->fingerprint ?? null ) === $this->get_fingerprint() ) {
-			return true;
+		if ( WC_Stripe_Payment_Methods::SEPA_DEBIT !== $payment_method->type ) {
+			return false;
 		}
 
-		return false;
+		return ( $payment_method->sepa_debit->fingerprint ?? null ) === $this->get_fingerprint();
 	}
 }
diff --git a/readme.txt b/readme.txt
@@ -111,6 +111,7 @@ If you get stuck, you can ask for help in the [Plugin Forum](https://wordpress.o
 == Changelog ==
 
 = 9.10.0 - xxxx-xx-xx =
+* Fix - Minor fixes and code improvements for the saved payment methods comparison logic
 * Dev - Upgrades Node to v20
 * Add - Allow the purchase of free trials using the Express Payment methods when the product does not require shipping
 * Update - Changes the documentation page URL for the Optimized Checkout feature to https://woocommerce.com/document/stripe/admin-experience/optimized-checkout-suite/

Original file line number	Diff line number	Diff line change
`@@ -161,12 +161,11 @@ public function set_last4( $last4 ) {`
`161`	`161`	`* @inheritDoc`
`162`	`162`	`*/`
`163`	`163`	`public function is_equal_payment_method( $payment_method ): bool {`
`164`		`- if (`
`165`		`- WC_Stripe_Payment_Methods::ACH === $payment_method->type`
`166`		`- && ( $payment_method->{WC_Stripe_Payment_Methods::ACH}->fingerprint ?? null ) === $this->get_fingerprint() ) {`
`167`		`- return true;`
	`164`	`+ if ( WC_Stripe_Payment_Methods::ACH !== $payment_method->type ) {`
	`165`	`+ return false;`
`168`	`166`	`}`
`169`	`167`
`170`		`- return false;`
	`168`	+ // ACH uses the `us_bank_account` property
	`169`	`+ return ( $payment_method->us_bank_account->fingerprint ?? null ) === $this->get_fingerprint();`
`171`	`170`	`}`
`172`	`171`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,12 +41,11 @@ class WC_Payment_Token_ACSS extends WC_Payment_Token implements WC_Stripe_Paymen`
`41`	`41`	`* @return bool`
`42`	`42`	`*/`
`43`	`43`	`public function is_equal_payment_method( $payment_method ): bool {`
`44`		`- if ( WC_Stripe_Payment_Methods::ACSS_DEBIT === $payment_method->type`
`45`		`- && ( $payment_method->acss_debit->fingerprint ?? null ) === $this->get_fingerprint() ) {`
`46`		`- return true;`
	`44`	`+ if ( WC_Stripe_Payment_Methods::ACSS_DEBIT !== $payment_method->type ) {`
	`45`	`+ return false;`
`47`	`46`	`}`
`48`	`47`
`49`		`- return false;`
	`48`	`+ return ( $payment_method->acss_debit->fingerprint ?? null ) === $this->get_fingerprint();`
`50`	`49`	`}`
`51`	`50`
`52`	`51`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -79,11 +79,10 @@ public function set_email( $email ) {`
`79`	`79`	`* @inheritDoc`
`80`	`80`	`*/`
`81`	`81`	`public function is_equal_payment_method( $payment_method ): bool {`
`82`		`- if ( WC_Stripe_Payment_Methods::AMAZON_PAY === $payment_method->type`
`83`		`- && ( $payment_method->billing_details->email ?? null ) === $this->get_email() ) {`
`84`		`- return true;`
	`82`	`+ if ( WC_Stripe_Payment_Methods::AMAZON_PAY !== $payment_method->type ) {`
	`83`	`+ return false;`
`85`	`84`	`}`
`86`	`85`
`87`		`- return false;`
	`86`	`+ return ( $payment_method->billing_details->email ?? null ) === $this->get_email();`
`88`	`87`	`}`
`89`	`88`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,12 +40,11 @@ class WC_Payment_Token_Bacs_Debit extends WC_Payment_Token implements WC_Stripe_`
`40`	`40`	`* @return bool`
`41`	`41`	`*/`
`42`	`42`	`public function is_equal_payment_method( $payment_method ): bool {`
`43`		`- if ( WC_Stripe_Payment_Methods::BACS_DEBIT === $payment_method->type`
`44`		`- && ( $payment_method->bacs_debit->fingerprint ?? null ) === $this->get_fingerprint() ) {`
`45`		`- return true;`
	`43`	`+ if ( WC_Stripe_Payment_Methods::BACS_DEBIT !== $payment_method->type ) {`
	`44`	`+ return false;`
`46`	`45`	`}`
`47`	`46`
`48`		`- return false;`
	`47`	`+ return ( $payment_method->bacs_debit->fingerprint ?? null ) === $this->get_fingerprint();`
`49`	`48`	`}`
`50`	`49`
`51`	`50`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -111,12 +111,11 @@ public function set_last4( $last4 ) {`
`111`	`111`	`* @inheritDoc`
`112`	`112`	`*/`
`113`	`113`	`public function is_equal_payment_method( $payment_method ): bool {`
`114`		`- if (`
`115`		`- WC_Stripe_Payment_Methods::BECS_DEBIT === $payment_method->type`
`116`		`- && ( $payment_method->{WC_Stripe_Payment_Methods::BECS_DEBIT}->fingerprint ?? null ) === $this->get_fingerprint() ) {`
`117`		`- return true;`
	`114`	`+ if ( WC_Stripe_Payment_Methods::BECS_DEBIT !== $payment_method->type ) {`
	`115`	`+ return false;`
`118`	`116`	`}`
`119`	`117`
`120`		`- return false;`
	`118`	`+ // Becs Debit uses the au_becs_debit property.`
	`119`	`+ return ( $payment_method->au_becs_debit->fingerprint ?? null ) === $this->get_fingerprint();`
`121`	`120`	`}`
`122`	`121`	`}`
Original file line number	Diff line number	Diff line change
`@@ -67,12 +67,11 @@ public function get_cashtag() {`
`67`	`67`	`* @inheritDoc`
`68`	`68`	`*/`
`69`	`69`	`public function is_equal_payment_method( $payment_method ): bool {`
`70`		`- if ( WC_Stripe_Payment_Methods::CASHAPP_PAY === $this->get_type()`
`71`		`- && ( $payment_method->cashapp->cashtag ?? null ) === $this->get_cashtag() ) {`
`72`		`- return true;`
	`70`	`+ if ( WC_Stripe_Payment_Methods::CASHAPP_PAY !== $payment_method->type ) {`
	`71`	`+ return false;`
`73`	`72`	`}`
`74`	`73`
`75`		`- return false;`
	`74`	`+ return ( $payment_method->cashapp->cashtag ?? null ) === $this->get_cashtag();`
`76`	`75`	`}`
`77`	`76`
`78`	`77`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -35,11 +35,10 @@ public function __construct( $token = '' ) {`
`35`	`35`	`* @inheritDoc`
`36`	`36`	`*/`
`37`	`37`	`public function is_equal_payment_method( $payment_method ): bool {`
`38`		`- if ( WC_Stripe_Payment_Methods::CARD === $payment_method->type`
`39`		`- && ( $payment_method->card->fingerprint ?? null ) === $this->get_fingerprint() ) {`
`40`		`- return true;`
	`38`	`+ if ( WC_Stripe_Payment_Methods::CARD !== $payment_method->type ) {`
	`39`	`+ return false;`
`41`	`40`	`}`
`42`	`41`
`43`		`- return false;`
	`42`	`+ return ( $payment_method->card->fingerprint ?? null ) === $this->get_fingerprint();`
`44`	`43`	`}`
`45`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,11 +98,10 @@ public function set_email( $email ) {`
`98`	`98`	`* @inheritDoc`
`99`	`99`	`*/`
`100`	`100`	`public function is_equal_payment_method( $payment_method ): bool {`
`101`		`- if ( WC_Stripe_Payment_Methods::LINK === $payment_method->type`
`102`		`- && ( $payment_method->link->email ?? null ) === $this->get_email() ) {`
`103`		`- return true;`
	`101`	`+ if ( WC_Stripe_Payment_Methods::LINK !== $payment_method->type ) {`
	`102`	`+ return false;`
`104`	`103`	`}`
`105`	`104`
`106`		`- return false;`
	`105`	`+ return ( $payment_method->link->email ?? null ) === $this->get_email();`
`107`	`106`	`}`
`108`	`107`	`}`