Ensure manually captured orders have the Stripe fee and payout meta added to them (#3508)

* Introduce new helper to fetch balance transaction ID from charge object

* Fix manually captured orders missing stripe fee and payout meta

* Add changelog entry

Author: mattallan

changelog.txt

@@ -31,6 +31,7 @@
 * Fix - Set order payment method title to the customizable title setting rather than the default label.
 * 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.
 
 = 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/abstracts/abstract-wc-stripe-payment-gateway.php

@@ -2297,4 +2297,23 @@ private function maybe_attach_source_to_customer( $source, $customer = null ) {
 
 		return true;
 	}
+
+	/**
+	 * Retrieves the balance transaction ID from the Stripe charge.
+	 *
+	 * @param stdClass $charge The charge object.
+	 *
+	 * @return string|null The balance transaction ID.
+	 */
+	public function get_balance_transaction_id_from_charge( $charge ) {
+		$balance_transaction_id = null;
+
+		if ( ! empty( $charge->balance_transaction->id ) ) {
+			$balance_transaction_id = $charge->balance_transaction->id;
+		} elseif ( ! empty( $charge->balance_transaction ) && is_string( $charge->balance_transaction ) ) {
+			$balance_transaction_id = $charge->balance_transaction;
+		}
+
+		return $balance_transaction_id;
+	}
 }

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

@@ -334,7 +334,11 @@ public function capture_payment( $order_id ) {
 						$order->save();
 					}
 
-					$this->update_fees( $order, $result->balance_transaction->id );
+					$balance_transaction_id = $this->get_balance_transaction_id_from_charge( $result );
+
+					if ( ! empty( $balance_transaction_id ) ) {
+						$this->update_fees( $order, $balance_transaction_id );
+					}
 				}
 
 				// This hook fires when admin manually changes order status to processing or completed.

readme.txt

@@ -159,5 +159,6 @@ If you get stuck, you can ask for help in the Plugin Forum.
 * Fix - Set order payment method title to the customizable title setting rather than the default label.
 * 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.
 
 [See changelog for all versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).

tests/phpunit/test-wc-stripe-payment-gateway.php

@@ -525,4 +525,47 @@ private function get_partial_mock_for_gateway( array $methods = [] ) {
 			->setMethods( $methods )
 			->getMock();
 	}
+
+	public function test_get_balance_transaction_id_from_charge() {
+		$expected_balance_transaction_id = 'txn_test123';
+		$balance_transaction_object      = (object) [
+			'id' => $expected_balance_transaction_id,
+		];
+
+		$charge_expanded = (object) [
+			'id'                  => 'ch_test123',
+			'balance_transaction' => $balance_transaction_object,
+		];
+		$this->assertEquals( $expected_balance_transaction_id, $this->gateway->get_balance_transaction_id_from_charge( $charge_expanded ) );
+
+		$charge_non_expanded             = (object) [
+			'id' => 'ch_test123',
+			'balance_transaction' => $expected_balance_transaction_id,
+		];
+		$this->assertEquals( $expected_balance_transaction_id, $this->gateway->get_balance_transaction_id_from_charge( $charge_non_expanded ) );
+
+		/**
+		 * ------------------------------------
+		 * Test invalid cases.
+		 * ------------------------------------
+		 */
+		$charge_no_balance_transaction_id = (object) [
+			'id' => 'ch_test123',
+		];
+		$this->assertEquals( null, $this->gateway->get_balance_transaction_id_from_charge( $charge_no_balance_transaction_id ) );
+
+		$charge_no_balance_transaction = (object) [
+			'id'                  => 'ch_test123',
+			'balance_transaction' => null,
+		];
+		$this->assertEquals( null, $this->gateway->get_balance_transaction_id_from_charge( $charge_no_balance_transaction ) );
+
+		$charge_no_balance_transaction_object = (object) [
+			'id'                  => 'ch_test123',
+			'balance_transaction' => (object) [],
+		];
+		$this->assertEquals( null, $this->gateway->get_balance_transaction_id_from_charge( $charge_no_balance_transaction_object ) );
+
+		$this->assertEquals( null, $this->gateway->get_balance_transaction_id_from_charge( null ) );
+	}
 }