FC#0132520 - add config options to change capture trigger, disable automatic refunds (#81)

SebastianGoral-fc · web-flow · commit 321da64a946f · 2026-04-13T14:12:05.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## Version 9.0.0 - WIP
+
+* FC#0132520 - add config options to change capture trigger, disable automatic refunds
+
 ## Version 8.0.0 - Released on 2025-09-18
 
 * RATESWSX-332: add Shopware 6.7.x.x compatibility
diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "ratepay/shopware6-module",
     "description": "Ratepay payment methods for Shopware 6",
-    "version": "8.0.0",
+    "version": "9.0.0",
     "license": "MIT",
     "authors": [
         {
diff --git a/src/Components/StateMachine/Subscriber/TransitionSubscriber.php b/src/Components/StateMachine/Subscriber/TransitionSubscriber.php
@@ -14,6 +14,7 @@
 use Exception;
 use Psr\Log\LoggerInterface;
 use Ratepay\RpayPayments\Components\RatepayApi\Dto\OrderOperationData;
+use Ratepay\RpayPayments\Components\RatepayApi\Service\Request\AbstractModifyRequest;
 use Ratepay\RpayPayments\Components\RatepayApi\Service\Request\PaymentCancelService;
 use Ratepay\RpayPayments\Components\RatepayApi\Service\Request\PaymentDeliverService;
 use Ratepay\RpayPayments\Components\RatepayApi\Service\Request\PaymentReturnService;
@@ -25,6 +26,9 @@
 use Shopware\Core\Checkout\Order\Aggregate\OrderDelivery\OrderDeliveryDefinition;
 use Shopware\Core\Checkout\Order\Aggregate\OrderDelivery\OrderDeliveryEntity;
 use Shopware\Core\Checkout\Order\Aggregate\OrderDelivery\OrderDeliveryStates;
+use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionDefinition;
+use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionEntity;
+use Shopware\Core\Checkout\Order\Aggregate\OrderTransaction\OrderTransactionStates;
 use Shopware\Core\Checkout\Order\OrderEntity;
 use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
 use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
@@ -38,6 +42,7 @@ class TransitionSubscriber implements EventSubscriberInterface
 
     public function __construct(
         private readonly EntityRepository $orderDeliveryRepository,
+        private readonly EntityRepository $orderTransactionRepository,
         private readonly EntityRepository $orderRepository,
         private readonly PluginConfigService $configService,
         private readonly PaymentDeliverService $paymentDeliverService,
@@ -56,7 +61,60 @@ public static function getSubscribedEvents(): array
 
     public function onTransition(StateMachineTransitionEvent $event): void
     {
-        if ($event->getEntityName() !== OrderDeliveryDefinition::ENTITY_NAME || !$this->configService->isAutoOperationBasedOnDeliveryStatusEnabled()) {
+        if ($event->getEntityName() === OrderTransactionDefinition::ENTITY_NAME) {
+            $this->onTransactionStatusTransition($event);
+        } else if ($event->getEntityName() === OrderDeliveryDefinition::ENTITY_NAME) {
+            $this->onDeliveryStatusTransition($event);
+        }
+    }
+
+    protected function onTransactionStatusTransition(StateMachineTransitionEvent $event): void
+    {
+        if ($this->configService->getCaptureTrigger() !== 'pay') {
+            return;
+        }
+
+        /** @var ArrayStruct|null $struct */
+        $struct = $event->getContext()->getExtension('ratepay');
+        if ($struct?->get(self::PREVENT_BIDIRECTIONALITY) === true) {
+            return;
+        }
+
+        /** @var OrderTransactionEntity $orderTransaction */
+        $orderTransaction = $this->orderTransactionRepository->search(new Criteria([$event->getEntityId()]), $event->getContext())->first();
+        /** @var OrderEntity $order */
+        $order = $this->orderRepository->search(CriteriaHelper::getCriteriaForOrder($orderTransaction->getOrderId()), $event->getContext())->first();
+
+        if (!MethodHelper::isRatepayOrder($order)) {
+            return;
+        }
+
+        $ratepayData = $order->getExtension(OrderExtension::EXTENSION_NAME);
+
+        if (!$ratepayData instanceof RatepayOrderDataEntity) {
+            $this->logger->warning('Error during bidirectionality: No Ratepay Data was found.', [
+                'order'       => $order->getId(),
+                'orderNumber' => $order->getOrderNumber(),
+            ]);
+            return;
+        }
+
+        switch ($event->getToPlace()->getTechnicalName()) {
+            case OrderTransactionStates::STATE_PAID:
+                $operation = OrderOperationData::OPERATION_DELIVER;
+                $service   = $this->paymentDeliverService;
+                break;
+            default:
+                // do nothing
+                return;
+        }
+
+        $this->performOperation($event, $order, $operation, $service, $ratepayData);
+    }
+
+    protected function onDeliveryStatusTransition(StateMachineTransitionEvent $event): void
+    {
+        if (!$this->configService->isAutoOperationBasedOnDeliveryStatusEnabled()) {
             return;
         }
 
@@ -79,30 +137,47 @@ public function onTransition(StateMachineTransitionEvent $event): void
 
         if (!$ratepayData instanceof RatepayOrderDataEntity) {
             $this->logger->warning('Error during bidirectionality: No Ratepay Data was found.', [
-                'order' => $order->getId(),
+                'order'       => $order->getId(),
                 'orderNumber' => $order->getOrderNumber(),
             ]);
             return;
         }
 
         switch ($event->getToPlace()->getTechnicalName()) {
             case OrderDeliveryStates::STATE_SHIPPED:
+                if ($this->configService->getCaptureTrigger() !== 'deliver') {
+                    // do nothing
+                    return;
+                }
                 $operation = OrderOperationData::OPERATION_DELIVER;
-                $service = $this->paymentDeliverService;
+                $service   = $this->paymentDeliverService;
                 break;
             case OrderDeliveryStates::STATE_CANCELLED:
+                if (!$this->configService->isTransactionRefundsOnDeliveryStatusChange()) {
+                    // do nothing
+                    return;
+                }
                 $operation = OrderOperationData::OPERATION_CANCEL;
-                $service = $this->paymentCancelService;
+                $service   = $this->paymentCancelService;
                 break;
             case OrderDeliveryStates::STATE_RETURNED:
+                if (!$this->configService->isTransactionRefundsOnDeliveryStatusChange()) {
+                    // do nothing
+                    return;
+                }
                 $operation = OrderOperationData::OPERATION_RETURN;
-                $service = $this->paymentReturnService;
+                $service   = $this->paymentReturnService;
                 break;
             default:
                 // do nothing
                 return;
         }
+        $this->performOperation($event, $order, $operation, $service, $ratepayData);
+
+    }
 
+    protected function performOperation(StateMachineTransitionEvent $event, OrderEntity $order, string $operation, AbstractModifyRequest $service, RatepayOrderDataEntity $ratepayData): void
+    {
         // we need this to prevent endless recursion if update-delivery-status is enabled.
         // this should never happen, because shopware can not change the status to the actual status again and so this subscriber should never called again.
         $event->getContext()->addExtension('ratepay', new ArrayStruct([
@@ -114,17 +189,17 @@ public function onTransition(StateMachineTransitionEvent $event): void
             $response = $service->doRequest($orderOperationData);
             if (!$response->getResponse()->isSuccessful()) {
                 $this->logger->error('Error during bidirectionality. (Exception: ' . $response->getResponse()->getReasonMessage() . ')', [
-                    'order' => $order->getId(),
-                    'transactionId' => $ratepayData->getTransactionId(),
-                    'orderNumber' => $order->getOrderNumber(),
+                    'order'          => $order->getId(),
+                    'transactionId'  => $ratepayData->getTransactionId(),
+                    'orderNumber'    => $order->getOrderNumber(),
                     'itemsToProcess' => $orderOperationData->getItems(),
                 ]);
             }
         } catch (Exception $exception) {
             $this->logger->critical('Exception during bidirectionality. (Exception: ' . $exception->getMessage() . ')', [
-                'order' => $order->getId(),
-                'transactionId' => $ratepayData->getTransactionId(),
-                'orderNumber' => $order->getOrderNumber(),
+                'order'          => $order->getId(),
+                'transactionId'  => $ratepayData->getTransactionId(),
+                'orderNumber'    => $order->getOrderNumber(),
                 'itemsToProcess' => $orderOperationData->getItems(),
             ]);
         }
diff --git a/src/Core/PluginConfigService.php b/src/Core/PluginConfigService.php
@@ -106,6 +106,20 @@ public function isUpdateDeliveryStatusOnOrderItemOperation(): bool
         return (bool) ($config['updateDeliveryStatus'] ?? false);
     }
 
+    public function getCaptureTrigger(): string
+    {
+        $config = $this->getPluginConfiguration();
+
+        return $config['captureTrigger'] ?? 'deliver';
+    }
+
+    public function isTransactionRefundsOnDeliveryStatusChange(): bool
+    {
+        $config = $this->getPluginConfiguration();
+
+        return (bool) ($config['automaticTransactionRefunds'] ?? true);
+    }
+
     protected function getContext(): Context
     {
         return Context::createDefaultContext();
diff --git a/src/Resources/config/config.xml b/src/Resources/config/config.xml
@@ -194,6 +194,24 @@
             <label lang="de-DE">Automatische Versandmeldung von virtuellen Produkten deaktivieren</label>
         </input-field>
 
+        <input-field type="single-select">
+            <name>captureTrigger</name>
+            <options>
+                <option><id>deliver</id><name>On delivery status "Shipped"</name><name lang="de-DE">Bei Lieferungstatus "Versandt"</name></option>
+                <option><id>pay</id><name>On payment status "Paid"</name><name lang="de-DE">Bei Zahlungsstatus "Bezahlt"</name></option>
+            </options>
+            <defaultValue>deliver</defaultValue>
+            <label>Capture trigger</label>
+            <label lang="de-DE">Auslöser Zahlungseinzug</label>
+        </input-field>
+
+        <input-field type="bool">
+            <name>automaticTransactionRefunds</name>
+            <label>Refund transactions automatically when order delivery status changes to "Cancelled" or "Returned".</label>
+            <label lang="de-DE">Transaktionen automatisch erstatten, wenn sich der Lieferstatus auf "Abgebrochen" oder "Retour" ändert.</label>
+            <defaultValue>true</defaultValue>
+        </input-field>
+
         <input-field type="textarea">
             <name>featureFlags</name>
             <label>Feature Flags</label>

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "ratepay/shopware6-module",`
`3`	`3`	`"description": "Ratepay payment methods for Shopware 6",`
`4`		`- "version": "8.0.0",`
	`4`	`+ "version": "9.0.0",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"authors": [`
`7`	`7`	`{`