[ECP-9639] Refactor API clients, validator and handlers

Gateway/Http/Client/TransactionCancel.php

@@ -3,7 +3,7 @@
  *
  * Adyen Payment module (https://www.adyen.com/)
  *
- * Copyright (c) 2023 Adyen N.V. (https://www.adyen.com/)
+ * Copyright (c) 2025 Adyen N.V. (https://www.adyen.com/)
  * See LICENSE.txt for license details.
  *
  * Author: Adyen <[email protected]>
@@ -22,27 +22,14 @@
 
 class TransactionCancel implements ClientInterface
 {
-    /**
-     * @var Data
-     */
-    private Data $adyenHelper;
-
-    /**
-     * @var Idempotency
-     */
-    private Idempotency $idempotencyHelper;
-
     /**
      * @param Data $adyenHelper
      * @param Idempotency $idempotencyHelper
      */
     public function __construct(
-        Data        $adyenHelper,
-        Idempotency $idempotencyHelper
-    ) {
-        $this->adyenHelper = $adyenHelper;
-        $this->idempotencyHelper = $idempotencyHelper;
-    }
+        private readonly Data $adyenHelper,
+        private readonly Idempotency $idempotencyHelper
+    ) { }
 
     /**
      * @param TransferInterface $transferObject
@@ -58,7 +45,7 @@ public function placeRequest(TransferInterface $transferObject): array
 
         $client = $this->adyenHelper->initializeAdyenClientWithClientConfig($clientConfig);
         $service = $this->adyenHelper->initializeModificationsApi($client);
-        $responseData = [];
+        $responseCollection = [];
 
         foreach ($requests as $request) {
             $idempotencyKey = $this->idempotencyHelper->generateIdempotencyKey(
@@ -83,8 +70,10 @@ public function placeRequest(TransferInterface $transferObject): array
                 $responseData['error'] = $e->getMessage();
                 $this->adyenHelper->logAdyenException($e);
             }
+
+            $responseCollection[] = $responseData;
         }
 
-        return $responseData;
+        return $responseCollection;
     }
 }

Gateway/Http/Client/TransactionCapture.php

@@ -3,7 +3,7 @@
  *
  * Adyen Payment module (https://www.adyen.com/)
  *
- * Copyright (c) 2023 Adyen N.V. (https://www.adyen.com/)
+ * Copyright (c) 2025 Adyen N.V. (https://www.adyen.com/)
  * See LICENSE.txt for license details.
  *
  * Author: Adyen <[email protected]>
@@ -14,53 +14,30 @@
 use Adyen\AdyenException;
 use Adyen\Client;
 use Adyen\Model\Checkout\PaymentCaptureRequest;
-use Adyen\Payment\Api\Data\OrderPaymentInterface;
+use Adyen\Payment\Gateway\Validator\AbstractModificationsResponseValidator;
 use Adyen\Payment\Helper\Data;
 use Adyen\Payment\Helper\Idempotency;
-use Adyen\Payment\Helper\Requests;
 use Adyen\Payment\Logger\AdyenLogger;
-use Adyen\Service\Checkout\ModificationsApi;
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Payment\Gateway\Http\ClientInterface;
 use Magento\Payment\Gateway\Http\TransferInterface;
 
 class TransactionCapture implements ClientInterface
 {
-    const MULTIPLE_AUTHORIZATIONS = 'multiple_authorizations';
-    const FORMATTED_CAPTURE_AMOUNT = 'formatted_capture_amount';
-    const CAPTURE_AMOUNT = 'capture_amount';
+    const CAPTURE_AMOUNT = 'amount';
+    const CAPTURE_VALUE = 'value';
     const ORIGINAL_REFERENCE = 'paymentPspReference';
-    const CAPTURE_RECEIVED = 'received';
-
-    /**
-     * @var Data
-     */
-    private Data $adyenHelper;
-
-    /**
-     * @var AdyenLogger
-     */
-    private AdyenLogger $adyenLogger;
-
-    /**
-     * @var Idempotency
-     */
-    private Idempotency $idempotencyHelper;
 
     /**
      * @param Data $adyenHelper
      * @param AdyenLogger $adyenLogger
      * @param Idempotency $idempotencyHelper
      */
     public function __construct(
-        Data $adyenHelper,
-        AdyenLogger $adyenLogger,
-        Idempotency $idempotencyHelper
-    ) {
-        $this->adyenHelper = $adyenHelper;
-        $this->adyenLogger = $adyenLogger;
-        $this->idempotencyHelper = $idempotencyHelper;
-    }
+        private readonly Data $adyenHelper,
+        private readonly AdyenLogger $adyenLogger,
+        private readonly Idempotency $idempotencyHelper
+    ) { }
 
     /**
      * @param TransferInterface $transferObject
@@ -70,109 +47,61 @@ public function __construct(
      */
     public function placeRequest(TransferInterface $transferObject): array
     {
-        $request = $transferObject->getBody();
+        $requestCollection = $transferObject->getBody();
         $headers = $transferObject->getHeaders();
         $clientConfig = $transferObject->getClientConfig();
 
         $client = $this->adyenHelper->initializeAdyenClientWithClientConfig($clientConfig);
         $service = $this->adyenHelper->initializeModificationsApi($client);
 
-        $requestOptions['headers'] = $headers;
-        $request['applicationInfo'] = $this->adyenHelper->buildApplicationInfo($client);
-
-        if (array_key_exists(self::MULTIPLE_AUTHORIZATIONS, $request)) {
-            return $this->placeMultipleCaptureRequests($service, $request, $requestOptions);
-        }
-
-        $idempotencyKeyExtraData = $request['idempotencyExtraData'];
-        unset($request['idempotencyExtraData']);
-
-        $idempotencyKey = $this->idempotencyHelper->generateIdempotencyKey(
-            $request,
-            $idempotencyKeyExtraData ?? null
-        );
-        $requestOptions['idempotencyKey'] = $idempotencyKey;
-
-        $this->adyenHelper->logRequest($request, Client::API_CHECKOUT_VERSION, '/captures');
-        $paymentCaptureRequest = new PaymentCaptureRequest($request);
-        $responseData = [];
-
-        try {
-            $response = $service->captureAuthorisedPayment(
-                $request['paymentPspReference'],
-                $paymentCaptureRequest,
-                $requestOptions
-            );
+        $responseCollection = [];
 
-            $responseData = $response->toArray();
-            $responseData = $this->copyParamsToResponse($responseData, $request);
-            $this->adyenHelper->logResponse($responseData);
-        } catch (AdyenException $e) {
-            $this->adyenHelper->logAdyenException($e);
-            $responseData['error'] = $e->getMessage();
-        }
-
-        return $responseData;
-    }
-
-    /**
-     * @param ModificationsApi $service
-     * @param array $requestContainer
-     * @param array $requestOptions
-     * @return array
-     */
-    private function placeMultipleCaptureRequests(
-        ModificationsApi $service,
-        array            $requestContainer,
-        array            $requestOptions
-    ): array {
-        $response = [];
-        $applicationInfo = $requestContainer['applicationInfo'];
-
-        foreach ($requestContainer[self::MULTIPLE_AUTHORIZATIONS] as $request) {
+        foreach ($requestCollection as $request) {
             $idempotencyKeyExtraData = $request['idempotencyExtraData'];
             unset($request['idempotencyExtraData']);
             $idempotencyKey = $this->idempotencyHelper->generateIdempotencyKey(
                 $request,
                 $idempotencyKeyExtraData ?? null
             );
 
+            $request['applicationInfo'] = $this->adyenHelper->buildApplicationInfo($client);
+            $requestOptions['headers'] = $headers;
             $requestOptions['idempotencyKey'] = $idempotencyKey;
+
+            $paymentPspReference = $request['paymentPspReference'];
+            unset($request['paymentPspReference']);
+
             try {
-                // Copy merchant account from parent array to every request array
-                $request[Requests::MERCHANT_ACCOUNT] = $requestContainer[Requests::MERCHANT_ACCOUNT];
-                $request['applicationInfo'] = $applicationInfo;
                 $paymentCaptureRequest = new PaymentCaptureRequest($request);
-                $singleResponseObj = $service->captureAuthorisedPayment(
-                    $request['paymentPspReference'],
+                $this->adyenHelper->logRequest($request, Client::API_CHECKOUT_VERSION, '/captures');
+
+                $response = $service->captureAuthorisedPayment(
+                    $paymentPspReference,
                     $paymentCaptureRequest,
                     $requestOptions
                 );
 
-                $singleResponse = $singleResponseObj->toArray();
-                $singleResponse[self::FORMATTED_CAPTURE_AMOUNT] = $request['amount']['currency'] . ' ' .
-                    $this->adyenHelper->originalAmount(
-                        $request['amount']['value'],
-                        $request['amount']['currency']
-                    );
-                $singleResponse = $this->copyParamsToResponse($singleResponse, $request);
-                $response[self::MULTIPLE_AUTHORIZATIONS][] = $singleResponse;
-            } catch (AdyenException $e) {
-                $pspReference = $request[OrderPaymentInterface::PSPREFRENCE] ?? 'pspReference not set';
+                $responseData = $response->toArray();
+                $this->adyenHelper->logResponse($responseData);
 
+                $responseCollection[] = $this->copyParamsToResponse($responseData, $request);
+            } catch (AdyenException $e) {
                 $message = sprintf(
-                    'Exception occurred when attempting to capture multiple authorizations.
-                    Authorization with pspReference %s: %s',
-                    $pspReference,
+                    "An error occurred during the capture attempt%s. %s",
+                    !empty($paymentPspReference) ?
+                        ' of authorisation with pspreference ' . $paymentPspReference :
+                        '',
                     $e->getMessage()
                 );
 
+                $responseData['error'] = $message;
+
                 $this->adyenLogger->error($message);
-                $response[self::MULTIPLE_AUTHORIZATIONS]['error'] = $message;
+                $responseCollection[] = $responseData;
             }
         }
 
-        return $response;
+        return $responseCollection;
     }
 
     /**
@@ -182,8 +111,16 @@ private function placeMultipleCaptureRequests(
      */
     private function copyParamsToResponse(array $response, array $request): array
     {
-        $response[self::CAPTURE_AMOUNT] = $request['amount']['value'];
-        $response[self::ORIGINAL_REFERENCE] = $request[self::ORIGINAL_REFERENCE];
+        $originalAmount = $this->adyenHelper->originalAmount(
+            $request['amount']['value'],
+            $request['amount']['currency']
+        );
+
+        $response[AbstractModificationsResponseValidator::FORMATTED_MODIFICATIONS_AMOUNT] = sprintf(
+            "%s %s",
+            $request['amount']['currency'],
+            $originalAmount
+        );
 
         return $response;
     }

Gateway/Http/Client/TransactionPayment.php

@@ -120,7 +120,6 @@ public function placeRequest(TransferInterface $transferObject): array
         $client = $this->adyenHelper->initializeAdyenClientWithClientConfig($clientConfig);
         $service = $this->adyenHelper->initializePaymentsApi($client);
         $responseCollection = [];
-        $responseCollection['hasOnlyGiftCards'] = false;
 
         try {
             list($requestData, $giftcardResponseCollection) = $this->processGiftcards($requestData, $service);
@@ -130,7 +129,6 @@ public function placeRequest(TransferInterface $transferObject): array
                 $responseCollection = array_merge($responseCollection, $giftcardResponseCollection);
 
                 if ($this->remainingOrderAmount === 0) {
-                    $responseCollection['hasOnlyGiftCards'] = true;
                     return  $responseCollection;
                 }
             }

Gateway/Http/Client/TransactionRefundInterface.php

@@ -9,4 +9,5 @@ interface TransactionRefundInterface extends ClientInterface
     const REFUND_AMOUNT = 'refund_amount';
     const REFUND_CURRENCY = 'refund_currency';
     const ORIGINAL_REFERENCE = 'original_reference';
+    const PSPREFERENCE = 'pspReference';
 }

Gateway/Request/CancelDataBuilder.php

@@ -3,7 +3,7 @@
  *
  * Adyen Payment module (https://www.adyen.com/)
  *
- * Copyright (c) 2015 Adyen BV (https://www.adyen.com/)
+ * Copyright (c) 2025 Adyen N.V. (https://www.adyen.com/)
  * See LICENSE.txt for license details.
  *
  * Author: Adyen <[email protected]>
@@ -16,31 +16,20 @@
 use Magento\Payment\Gateway\Request\BuilderInterface;
 use Adyen\Payment\Model\ResourceModel\Order\Payment;
 use Adyen\Payment\Helper\Data;
-use Adyen\Payment\Helper\Config;
 
 /**
  * Class CustomerDataBuilder
  */
 class CancelDataBuilder implements BuilderInterface
 {
-    /** @var Payment $adyenPaymentResourceModel */
-    private $adyenPaymentResourceModel;
-
-    /** @var Config $configHelper */
-    private $configHelper;
-
-    /** @var Data $adyenHelper */
-    private $adyenHelper;
-
+    /**
+     * @param Payment $adyenPaymentResourceModel
+     * @param Data $adyenHelper
+     */
     public function __construct(
-        Payment      $adyenPaymentResourceModel,
-        Data         $adyenHelper,
-        Config $configHelper
-    ){
-        $this->adyenPaymentResourceModel = $adyenPaymentResourceModel;
-        $this->adyenHelper = $adyenHelper;
-        $this->configHelper = $configHelper;
-    }
+        private readonly Payment $adyenPaymentResourceModel,
+        private readonly Data $adyenHelper
+    ){ }
 
     /**
      * Create cancel_or_refund request