[SV-4] Api up 1.40;Introduce Wechatpay: handlepending accounttoaccount

composer.json

@@ -52,4 +52,4 @@
     },
     "author": "PrestaShop",
     "license": "AFL-3.0"
-}
+}

controllers/front/notify.php

@@ -75,13 +75,7 @@ public function postProcess()
         }
 
         if ($cart->orderExists()) {
-            if (method_exists('Order', 'getIdByCartId')) {
-                $orderId = Order::getIdByCartId($cartId);
-            } else {
-                // For PrestaShop 1.6 use the alternative method
-                $orderId = Order::getOrderByCartId($cartId);
-            }
-
+            $orderId = $this->getOrderId($cartId);
             $order = new Order($orderId);
 
             $saferPayAuthorizedStatus = (int) Configuration::get(\Invertus\SaferPay\Config\SaferPayConfig::SAFERPAY_PAYMENT_AUTHORIZED);
@@ -92,24 +86,19 @@ public function postProcess()
             }
         }
 
+        /** @var SaferPayOrderRepository $saferPayOrderRepository */
+        $saferPayOrderRepository = $this->module->getService(SaferPayOrderRepository::class);
+
         try {
             $assertResponseBody = $this->assertTransaction($cartId);
-
-            /** @var SaferPayOrderRepository $saferPayOrderRepository */
-            $saferPayOrderRepository = $this->module->getService(SaferPayOrderRepository::class);
             $saferPayOrderId = $saferPayOrderRepository->getIdByCartId($cartId);
 
             /** @var UpdateSaferPayOrderAction $updateSaferPayOrderAction */
             $updateSaferPayOrderAction = $this->module->getService(UpdateSaferPayOrderAction::class);
             $updateSaferPayOrderAction->run(new SaferPayOrder($saferPayOrderId), self::SAFERPAY_ORDER_AUTHORIZE_ACTION);
 
             // If order does not exist but assertion is valid that means order authorized or captured.
-            if (method_exists('Order', 'getIdByCartId')) {
-                $orderId = Order::getIdByCartId($cartId);
-            } else {
-                // For PrestaShop 1.6 use the alternative method
-                $orderId = Order::getOrderByCartId($cartId);
-            }
+            $orderId = $this->getOrderId($cartId);
             if (!$orderId) {
                 /** @var CheckoutProcessor $checkoutProcessor **/
                 $checkoutProcessor = $this->module->getService(CheckoutProcessor::class);
@@ -153,15 +142,34 @@ public function postProcess()
 
             //NOTE to get latest information possible and not override new information.
             $order = new Order($orderId);
+            $paymentMethod = $assertResponseBody->getPaymentMeans()->getBrand()->getPaymentMethod();
 
-            if ((int) Configuration::get(SaferPayConfig::PAYMENT_BEHAVIOR) === SaferPayConfig::DEFAULT_PAYMENT_BEHAVIOR_CAPTURE &&
+            if (SaferPayConfig::supportsOrderCapture($paymentMethod) && (int) Configuration::get(SaferPayConfig::PAYMENT_BEHAVIOR) === SaferPayConfig::DEFAULT_PAYMENT_BEHAVIOR_CAPTURE &&
                 $assertResponseBody->getTransaction()->getStatus() !== TransactionStatus::CAPTURED
             ) {
                 /** @var SaferPayOrderStatusService $orderStatusService */
                 $orderStatusService = $this->module->getService(SaferPayOrderStatusService::class);
                 $orderStatusService->capture($order);
             }
         } catch (Exception $e) {
+            // this might be executed after pending transaction is declined (e.g. with accountToAccount payment)
+            if (!isset($order)) {
+                $orderId = $this->getOrderId($cartId);
+                $order = new Order($orderId);
+            }
+
+            $saferPayOrderId = $saferPayOrderRepository->getIdByOrderId($order->id);
+            $saferPayOrder = new SaferPayOrder($saferPayOrderId);
+
+            if ($order->id && $saferPayOrder->id) {
+                // assuming order transaction was declined
+                $order->setCurrentState(_SAFERPAY_PAYMENT_AUTHORIZATION_FAILED_);
+                $order->update();
+                $saferPayOrder->authorized = false;
+                $saferPayOrder->pending = false;
+                $saferPayOrder->update();
+            }
+
             PrestaShopLogger::addLog(
                 sprintf(
                     '%s has caught an error: %s',
@@ -187,6 +195,21 @@ private function assertTransaction($cartId) {
         return $transactionAssert->assert($cartId);
     }
 
+    /**
+     * @param int $cartId
+     *
+     * @return bool|int
+     */
+    private function getOrderId($cartId)
+    {
+        if (method_exists('Order', 'getIdByCartId')) {
+            return Order::getIdByCartId($cartId);
+        } else {
+            // For PrestaShop 1.6 use the alternative method
+            return Order::getOrderByCartId($cartId);
+        }
+    }
+
     protected function displayMaintenancePage()
     {
         return true;

controllers/front/return.php

@@ -172,8 +172,9 @@ public function postProcess()
                     true
                 ));
             }
+            $paymentMethod = $response->getPaymentMeans()->getBrand()->getPaymentMethod();
 
-            if ((int) Configuration::get(SaferPayConfig::PAYMENT_BEHAVIOR) === SaferPayConfig::DEFAULT_PAYMENT_BEHAVIOR_CAPTURE &&
+            if (SaferPayConfig::supportsOrderCapture($paymentMethod) && (int) Configuration::get(SaferPayConfig::PAYMENT_BEHAVIOR) === SaferPayConfig::DEFAULT_PAYMENT_BEHAVIOR_CAPTURE &&
                 $response->getTransaction()->getStatus() !== TransactionStatus::CAPTURED
             ) {
                 $orderStatusService->capture(new Order($orderId));

saferpay.config.php

@@ -35,6 +35,10 @@
     /** @var URL to module IMG files directory */
     define('_SAFERPAY_PAYMENT_AUTHORIZED_', Configuration::get(SaferPayConfig::SAFERPAY_PAYMENT_AUTHORIZED));
 }
+if (!defined('_SAFERPAY_PAYMENT_PENDING_')) {
+    /** @var URL to module IMG files directory */
+    define('_SAFERPAY_PAYMENT_PENDING_', Configuration::get(SaferPayConfig::SAFERPAY_PAYMENT_PENDING));
+}
 if (!defined('_SAFERPAY_PAYMENT_REJECTED_')) {
     /** @var URL to module IMG files directory */
     define('_SAFERPAY_PAYMENT_REJECTED_', Configuration::get(SaferPayConfig::SAFERPAY_PAYMENT_REJECTED));

saferpayofficial.php

@@ -42,7 +42,7 @@ public function __construct($name = null)
     {
         $this->name = 'saferpayofficial';
         $this->author = 'Invertus';
-        $this->version = '1.2.2';
+        $this->version = '1.2.3';
         $this->module_key = '3d3506c3e184a1fe63b936b82bda1bdf';
         $this->displayName = 'SaferpayOfficial';
         $this->description = 'Saferpay Payment module';
@@ -116,6 +116,28 @@ public function getService($service)
         return $containerProvider->getService($service);
     }
 
+    public function hookDisplayOrderConfirmation($params)
+    {
+        if (empty($params['order'])) {
+            return '';
+        }
+
+        /** @var Order $psOrder */
+        $psOrder = $params['order'];
+
+        /** @var \Invertus\SaferPay\Repository\SaferPayOrderRepository $repository */
+        $repository = $this->getService(\Invertus\SaferPay\Repository\SaferPayOrderRepository::class);
+
+        $sfOrder = $repository->getByOrderId((int) $psOrder->id);
+        if (!$sfOrder->pending) {
+            return '';
+        }
+
+        //@todo: translate and move to template if needed when requirements are clear
+        return 'Your payment is still being processed by your bank. This can take up to 5 days (120 hours). Once we receive the final status, we will notify you immediately.
+Thank you for your patience!';
+    }
+
     public function hookActionObjectOrderPaymentAddAfter($params)
     {
         if (!isset($params['object'])) {

src/Api/Request/AssertService.php

@@ -29,6 +29,7 @@
 use Invertus\SaferPay\DTO\Response\Assert\AssertBody;
 use Invertus\SaferPay\EntityBuilder\SaferPayAssertBuilder;
 use Invertus\SaferPay\Exception\Api\SaferPayApiException;
+use Invertus\SaferPay\Exception\Api\TransactionDeclinedException;
 use Invertus\SaferPay\Service\Response\AssertResponseObjectCreator;
 use SaferPayOrder;
 

src/Config/SaferPayConfig.php

@@ -50,7 +50,7 @@ class SaferPayConfig
     const CONFIGURATION_NAME = 'SAFERPAY_CONFIGURATION_NAME';
     const CSS_FILE = 'SAFERPAY_CSS_FILE';
     const TEST_SUFFIX = '_TEST';
-    const API_VERSION = 1.37;
+    const API_VERSION = '1.40';
     const PAYMENT_METHODS = [
         self::PAYMENT_ALIPAY,
         self::PAYMENT_AMEX,
@@ -77,6 +77,8 @@ class SaferPayConfig
         self::PAYMENT_APPLEPAY,
         self::PAYMENT_KLARNA,
         self::PAYMENT_WLCRYPTOPAYMENTS,
+        self::PAYMENT_WECHATPAY,
+        self::PAYMENT_ACCOUNTTOACCOUNT,
     ];
 
     const PAYMENT_ALIPAY = 'ALIPAY';
@@ -111,6 +113,7 @@ class SaferPayConfig
     const PAYMENT_PAYCONIQ = 'PAYCONIQ';
     const PAYMENT_CARD = 'CARD';
     const PAYMENT_POSTFINANCE_PAY = 'POSTFINANCEPAY';
+    const PAYMENT_WECHATPAY = 'WECHATPAY';
 
     const WALLET_PAYMENT_METHODS = [
         self::PAYMENT_APPLEPAY,
@@ -141,6 +144,7 @@ class SaferPayConfig
         'Payconiq' => self::PAYMENT_PAYCONIQ,
         'Card' => self::PAYMENT_CARD,
         'PostFinancePay' => self::PAYMENT_POSTFINANCE_PAY,
+        'WeChatPay' => self::PAYMENT_WECHATPAY,
     ];
 
     const FIELD_SUPPORTED_PAYMENT_METHODS = [
@@ -152,6 +156,7 @@ class SaferPayConfig
         self::PAYMENT_DINERS,
         self::PAYMENT_JCB,
         self::PAYMENT_MYONE,
+        self::PAYMENT_WECHATPAY,
     ];
 
     const WLCRYPTOPAYMENTS_SUPPORTED_CURRENCIES = [
@@ -214,6 +219,7 @@ class SaferPayConfig
 
     const SAFERPAY_PAYMENT_COMPLETED = 'SAFERPAY_PAYMENT_COMPLETED';
     const SAFERPAY_PAYMENT_AUTHORIZED = 'SAFERPAY_PAYMENT_AUTHORIZED';
+    const SAFERPAY_PAYMENT_PENDING = 'SAFERPAY_PAYMENT_PENDING';
     const SAFERPAY_PAYMENT_REJECTED = 'SAFERPAY_PAYMENT_REJECTED';
     const SAFERPAY_PAYMENT_AWAITING = 'SAFERPAY_PAYMENT_AWAITING';
     const SAFERPAY_PAYMENT_REFUNDED = 'SAFERPAY_PAYMENT_REFUNDED';
@@ -262,6 +268,29 @@ class SaferPayConfig
     const PAYMENT_BEHAVIOR_WITHOUT_3D_CANCEL = 0;
     const PAYMENT_BEHAVIOR_WITHOUT_3D_AUTHORIZE = 1;
 
+    public static function supportsOrderCapture(string $paymentMethod): bool
+    {
+        //payments that DOES NOT SUPPORT capture
+        $unsupportedCapturePayments = [
+            self::PAYMENT_WECHATPAY,
+            self::PAYMENT_ACCOUNTTOACCOUNT,
+        ];
+
+        return !in_array($paymentMethod, $unsupportedCapturePayments);
+    }
+
+    public static function supportsOrderCancel(string $paymentMethod): bool
+    {
+        //payments that DOES NOT SUPPORT order cancel
+        $unsupportedCancelPayments = [
+            self::PAYMENT_WECHATPAY,
+            self::PAYMENT_ACCOUNTTOACCOUNT,
+        ];
+
+        return !in_array($paymentMethod, $unsupportedCancelPayments);
+    }
+
+
     public static function getConfigSuffix()
     {
         if (Configuration::get(self::TEST_MODE)) {
@@ -333,8 +362,8 @@ public static function getBaseUrl()
     public static function getDefaultConfiguration()
     {
         return [
-            RequestHeader::SPEC_VERSION => '1.37',
-            RequestHeader::SPEC_REFUND_VERSION => '1.37',
+            RequestHeader::SPEC_VERSION => SaferPayConfig::API_VERSION,
+            RequestHeader::SPEC_REFUND_VERSION => SaferPayConfig::API_VERSION,
             RequestHeader::RETRY_INDICATOR => 0,
             SaferPayConfig::PAYMENT_BEHAVIOR => 1,
             SaferPayConfig::PAYMENT_BEHAVIOR_WITHOUT_3D => 1,

src/Core/Payment/DTO/CheckoutData.php

@@ -60,8 +60,8 @@ public function __construct(
         $this->fieldToken = $fieldToken;
         $this->successController = $successController;
         $this->isTransaction = $isTransaction;
-        $this->createAfterAuthorization = Configuration::get(SaferPayConfig::SAFERPAY_ORDER_CREATION_AFTER_AUTHORIZATION);
         $this->isAuthorizedOrder = false;
+        $this->setCreateAfterAuthorization($paymentMethod);
     }
 
     public static function create(
@@ -184,4 +184,24 @@ public function setOrderStatus($status)
     {
         $this->status = $status;
     }
-}
+
+    /**
+     * @param string $paymentMethod
+     *
+     * @return void
+     */
+    private function setCreateAfterAuthorization($paymentMethod)
+    {
+        $methodsToForceBeforeAuthorization = [
+            SaferPayConfig::PAYMENT_ACCOUNTTOACCOUNT,
+        ];
+
+        if (in_array($paymentMethod, $methodsToForceBeforeAuthorization, true)) {
+            $this->createAfterAuthorization = false;
+
+            return;
+        }
+
+        $this->createAfterAuthorization = Configuration::get(SaferPayConfig::SAFERPAY_ORDER_CREATION_AFTER_AUTHORIZATION);
+    }
+}

src/Entity/SaferPayOrder.php

@@ -90,6 +90,11 @@ class SaferPayOrder extends ObjectModel
      */
     public $authorized;
 
+    /**
+     * @var bool
+     */
+    public $pending;
+
     /**
      * @var array
      */
@@ -109,6 +114,7 @@ class SaferPayOrder extends ObjectModel
             'canceled' => ['type' => self::TYPE_BOOL, 'validate' => 'isBool'],
             'refunded' => ['type' => self::TYPE_BOOL, 'validate' => 'isBool'],
             'authorized' => ['type' => self::TYPE_BOOL, 'validate' => 'isBool'],
+            'pending' => ['type' => self::TYPE_BOOL, 'validate' => 'isBool'],
         ],
     ];
 }

src/EntityBuilder/SaferPayOrderBuilder.php

@@ -34,7 +34,6 @@
 
 class SaferPayOrderBuilder
 {
-    //TODO to pass $body as InitializeBody.
     public function create($body, $cartId, $customerId, $isTransaction)
     {
         if (method_exists('Order', 'getIdByCartId')) {
@@ -51,6 +50,7 @@ public function create($body, $cartId, $customerId, $isTransaction)
         $saferPayOrder->id_customer = $customerId;
         $saferPayOrder->redirect_url = $this->getRedirectionUrl($body);
         $saferPayOrder->is_transaction = $isTransaction;
+
         $saferPayOrder->add();
 
         return $saferPayOrder;

src/Install/Installer.php

@@ -96,6 +96,7 @@ private function registerHooks()
         $this->module->registerHook('actionAdminControllerSetMedia');
         $this->module->registerHook('actionOrderHistoryAddAfter');
         $this->module->registerHook('actionObjectOrderPaymentAddAfter');
+        $this->module->registerHook('displayOrderConfirmation');
     }
 
     private function installConfiguration()
@@ -321,6 +322,20 @@ private function installOrderRefundTable()
         );
     }
 
+    public function createPendingOrderStatus()
+    {
+        return $this->createOrderStatus(
+            SaferPayConfig::SAFERPAY_PAYMENT_PENDING,
+            'Payment pending by Saferpay',
+            '#ec730a',
+            false,
+            true,
+            false,
+            false,
+            true
+        );
+    }
+
     public function createAllOrderStatus()
     {
         $success = true;
@@ -343,6 +358,7 @@ public function createAllOrderStatus()
             true,
             true
         );
+        $success &= $this->createPendingOrderStatus();
         $success &= $this->createOrderStatus(
             SaferPayConfig::SAFERPAY_PAYMENT_REJECTED,
             'Payment rejected by Saferpay',