Fix refunds on Stripe API 2022-11-15 (#2499)

* Fix refunds on Stripe API 2022-11-15

* Add changelog entry

* Add comments to `get_refund_object`

Author: ricardo

changelog.txt

@@ -2,6 +2,7 @@
 
 = 7.1.0 - 2022-xx-xx =
 * Fix - Expand charges object from incoming webhooks using Stripe API version 2022-11-15.
+* Fix - Expand refunds on charge object from incoming webhooks using Stripe API version 2022-11-15.
 
 = 7.0.1 - 2022-11-11 =
 * Fix - Issue where subscription renewal payments were being charged twice no longer present.

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

@@ -648,16 +648,17 @@ public function get_source_object( $source_id = '' ) {
 	 *
 	 * @since x.x.x
 	 * @param string $charge_id The charge ID to get charge object for.
+	 * @param array  $params    The parameters to pass to the request.
 	 *
 	 * @throws WC_Stripe_Exception Error while retrieving charge object.
 	 * @return string|object
 	 */
-	public function get_charge_object( $charge_id = '' ) {
+	public function get_charge_object( $charge_id = '', $params = [] ) {
 		if ( empty( $charge_id ) ) {
 			return '';
 		}
 
-		$charge_object = WC_Stripe_API::retrieve( 'charges/' . $charge_id );
+		$charge_object = WC_Stripe_API::request( $params, 'charges/' . $charge_id, 'GET' );
 
 		if ( ! empty( $charge_object->error ) ) {
 			throw new WC_Stripe_Exception( print_r( $charge_object, true ), $charge_object->error->message );

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

@@ -402,7 +402,8 @@ public function process_webhook_capture( $notification ) {
 				if ( $this->is_partial_capture( $notification ) ) {
 					$partial_amount = $this->get_partial_amount_to_charge( $notification );
 					$order->set_total( $partial_amount );
-					$this->update_fees( $order, $notification->data->object->refunds->data[0]->balance_transaction );
+					$refund_object = $this->get_refund_object( $notification );
+					$this->update_fees( $order, $refund_object->balance_transaction );
 					/* translators: partial captured amount */
 					$order->add_order_note( sprintf( __( 'This charge was partially captured via Stripe Dashboard in the amount of: %s', 'woocommerce-gateway-stripe' ), $partial_amount ) );
 				} else {
@@ -554,11 +555,12 @@ public function process_webhook_refund( $notification ) {
 		$order_id = $order->get_id();
 
 		if ( 'stripe' === $order->get_payment_method() ) {
-			$charge     = $order->get_transaction_id();
-			$captured   = $order->get_meta( '_stripe_charge_captured' );
-			$refund_id  = $order->get_meta( '_stripe_refund_id' );
-			$currency   = $order->get_currency();
-			$raw_amount = $notification->data->object->refunds->data[0]->amount;
+			$charge        = $order->get_transaction_id();
+			$captured      = $order->get_meta( '_stripe_charge_captured' );
+			$refund_id     = $order->get_meta( '_stripe_refund_id' );
+			$currency      = $order->get_currency();
+			$refund_object = $this->get_refund_object( $notification );
+			$raw_amount    = $refund_object->amount;
 
 			if ( ! in_array( strtolower( $currency ), WC_Stripe_Helper::no_decimal_currencies(), true ) ) {
 				$raw_amount /= 100;
@@ -580,7 +582,7 @@ public function process_webhook_refund( $notification ) {
 			}
 
 			// If the refund ID matches, don't continue to prevent double refunding.
-			if ( $notification->data->object->refunds->data[0]->id === $refund_id ) {
+			if ( $refund_object->id === $refund_id ) {
 				return;
 			}
 
@@ -600,14 +602,14 @@ public function process_webhook_refund( $notification ) {
 					WC_Stripe_Logger::log( $refund->get_error_message() );
 				}
 
-				$order->update_meta_data( '_stripe_refund_id', $notification->data->object->refunds->data[0]->id );
+				$order->update_meta_data( '_stripe_refund_id', $refund_object->id );
 
-				if ( isset( $notification->data->object->refunds->data[0]->balance_transaction ) ) {
-					$this->update_fees( $order, $notification->data->object->refunds->data[0]->balance_transaction );
+				if ( isset( $refund_object->balance_transaction ) ) {
+					$this->update_fees( $order, $refund_object->balance_transaction );
 				}
 
 				/* translators: 1) amount (including currency symbol) 2) transaction id 3) refund message */
-				$order->add_order_note( sprintf( __( 'Refunded %1$s - Refund ID: %2$s - %3$s', 'woocommerce-gateway-stripe' ), $amount, $notification->data->object->refunds->data[0]->id, $reason ) );
+				$order->add_order_note( sprintf( __( 'Refunded %1$s - Refund ID: %2$s - %3$s', 'woocommerce-gateway-stripe' ), $amount, $refund_object->id, $reason ) );
 			}
 		}
 	}
@@ -768,6 +770,25 @@ public function is_partial_capture( $notification ) {
 		return 0 < $notification->data->object->amount_refunded;
 	}
 
+	/**
+	 * Gets the first refund object from charge notification.
+	 *
+	 * @since x.x.x
+	 * @param object $notification
+	 *
+	 * @return object
+	 */
+	public function get_refund_object( $notification ) {
+		// Since API version 2022-11-15, the Charge object no longer expands `refunds` by default.
+		// We can remove this once we drop support for API versions prior to 2022-11-15.
+		if ( ! empty( $notification->data->object->refunds->data[0] ) ) {
+			return $notification->data->object->refunds->data[0];
+		}
+
+		$charge = $this->get_charge_object( $notification->data->object->id, [ 'expand' => [ 'refunds' ] ] );
+		return $charge->refunds->data[0];
+	}
+
 	/**
 	 * Gets the amount refunded.
 	 *
@@ -777,10 +798,11 @@ public function is_partial_capture( $notification ) {
 	 */
 	public function get_refund_amount( $notification ) {
 		if ( $this->is_partial_capture( $notification ) ) {
-			$amount = $notification->data->object->refunds->data[0]->amount / 100;
+			$refund_object = $this->get_refund_object( $notification );
+			$amount        = $refund_object->amount / 100;
 
 			if ( in_array( strtolower( $notification->data->object->currency ), WC_Stripe_Helper::no_decimal_currencies() ) ) {
-				$amount = $notification->data->object->refunds->data[0]->amount;
+				$amount = $refund_object->amount;
 			}
 
 			return $amount;

readme.txt

@@ -130,6 +130,7 @@ If you get stuck, you can ask for help in the Plugin Forum.
 
 = 7.1.0 - 2022-xx-xx =
 * Fix - Expand charges object from incoming webhooks using Stripe API version 2022-11-15.
+* Fix - Expand refunds on charge object from incoming webhooks using Stripe API version 2022-11-15.
 
 
 [See changelog for all versions](https://raw.githubusercontent.com/woocommerce/woocommerce-gateway-stripe/trunk/changelog.txt).