From: Matthew Wire <mjw@mjwconsult.co.uk>
Date: Tue, 5 Dec 2023 00:19:36 +0000 (+0000)
Subject: Clarify doRefund() signature
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=1cb557e2f39a43f5e5ae223e3ba6433b15bce44a;p=civicrm-core.git

Clarify doRefund() signature
---

diff --git a/CRM/Core/Payment.php b/CRM/Core/Payment.php
index 373f8d1c63..bc9a08b140 100644
--- a/CRM/Core/Payment.php
+++ b/CRM/Core/Payment.php
@@ -1512,13 +1512,14 @@ abstract class CRM_Core_Payment {
   /**
    * Refunds payment
    *
-   * Payment processors should set payment_status_id if it set the status to Refunded in case the transaction is successful
-   *
    * @param array $params
    *
-   * @throws \Civi\Payment\Exception\PaymentProcessorException
+   * @return array
+   *   Result array (containing at least the key refund_status)
    */
-  public function doRefund(&$params) {}
+  public function doRefund(&$params) {
+    return ['refund_status' => 'Completed'];
+  }
 
   /**
    * Query payment processor for details about a transaction.