fix: Refactor refund transaction

Author: maryamnbyn

src/Provider/AbstractProvider.php

@@ -26,8 +26,10 @@ abstract class AbstractProvider implements ProviderContract
     public const URL_TOKEN = 'token';
     public const URL_VERIFY = 'verify';
     public const URL_REFUND = 'refund';
+    public const URL_CANSEL = 'cansel';
     public const URL_MULTIPLEX = 'multiplex';
 
+    protected bool $provideTransactionResult = true;
     /**
      * shaparak operation environment
      *
@@ -273,4 +275,12 @@ protected function log(string $message, array $params = [], string $level = 'deb
 
         Shaparak::log($message, $params, $level);
     }
+
+    /**
+     * @return bool
+     */
+    public function getTransactionResult(): bool
+    {
+        return $this->provideTransactionResult;
+    }
 }

src/Provider/AsanPardakhtProvider.php

@@ -65,28 +65,44 @@ public function getUrlFor(string $action): string
                 {
                     return 'https:///ipgrest.asanpardakht.ir/v1/Settlement';
                 }
+                case self::URL_REFUND:
+                {
+                    return 'https:///ipgrest.asanpardakht.ir/v1/Reverse';
+                }
+                case self::URL_CANSEL:
+                {
+                    return 'https:///ipgrest.asanpardakht.ir/v1/Cancel';
+                }
             }
         } else {
             switch ($action) {
                 case self::URL_GATEWAY:
                 {
-                    return $this->bankTestBaseUrl . '/ap/asan.shaparak.ir';
+                    return $this->bankTestBaseUrl.'/ap/asan.shaparak.ir';
                 }
                 case self::URL_TOKEN:
                 {
-                    return $this->bankTestBaseUrl . '/ap/ipgrest.asanpardakht.ir/v1/Token';
+                    return $this->bankTestBaseUrl.'/ap/ipgrest.asanpardakht.ir/v1/Token';
                 }
                 case self::URL_VERIFY:
                 {
-                    return $this->bankTestBaseUrl . '/ap/ipgrest.asanpardakht.ir/v1/Verify';
+                    return $this->bankTestBaseUrl.'/ap/ipgrest.asanpardakht.ir/v1/Verify';
                 }
                 case self::URL_RESULT:
                 {
-                    return $this->bankTestBaseUrl . '/ap/ipgrest.asanpardakht.ir/v1/TranResult';
+                    return $this->bankTestBaseUrl.'/ap/ipgrest.asanpardakht.ir/v1/TranResult';
                 }
                 case self::URL_SETTLEMENT:
                 {
-                    return $this->bankTestBaseUrl . '/ap/ipgrest.asanpardakht.ir/v1/Settlement';
+                    return $this->bankTestBaseUrl.'/ap/ipgrest.asanpardakht.ir/v1/Settlement';
+                }
+                case self::URL_REFUND:
+                {
+                    return $this->bankTestBaseUrl.'/ap/ipgrest.asanpardakht.ir/v1/Reverse';
+                }
+                case self::URL_CANSEL:
+                {
+                    return $this->bankTestBaseUrl.'/ap/ipgrest.asanpardakht.ir/v1/Cancel';
                 }
             }
         }
@@ -148,16 +164,16 @@ public function requestTokenData(): array
             'merchantConfigurationId' => $this->getParameters('terminal_id'),
             'localInvoiceId' => $this->getGatewayOrderId(),
             'amountInRials' => $this->getAmount(),
-            'localDate' => $this->getParameters('local_date') . ' ' . $this->getParameters('local_time'),
+            'localDate' => $this->getParameters('local_date').' '.$this->getParameters('local_time'),
             'callbackURL' => $this->getCallbackUrl(),
             'paymentId' => 0,
         ];
     }
 
     /**
-     * @param array $params
-     * @param string $url
-     * @param string $method
+     * @param  array  $params
+     * @param  string  $url
+     * @param  string  $method
      * @return mixed
      */
     public function sendParamToAp(array $params, string $url, string $method): mixed
@@ -200,7 +216,7 @@ public function verifyTransaction(): bool
             $this->log($e->getMessage(), [], 'error');
 
             throw new VerificationException(
-                'verifyTransaction: ' . $e->getMessage() . ' #' . $e->getCode(),
+                'verifyTransaction: '.$e->getMessage().' #'.$e->getCode(),
                 $e->getCode()
             );
         }
@@ -228,9 +244,8 @@ public function getTransactionResult(): bool
             $this->getTransaction()->setReferenceId($response->json('refID'));
 
             return true;
-        } else {
-            throw new Exception(sprintf('shaparak::asanpardakhtRest.error_%s', $response->status()));
         }
+        return false;
     }
 
     /**
@@ -266,7 +281,7 @@ public function settleTransaction(): bool
         } catch (\Exception $e) {
             $this->log($e->getMessage(), [], 'error');
             throw new SettlementException(
-                'settleTransaction: ' . $e->getMessage() . ' #' . $e->getCode(),
+                'settleTransaction: '.$e->getMessage().' #'.$e->getCode(),
                 $e->getCode()
             );
         }
@@ -285,16 +300,21 @@ public function refundTransaction(): bool
             'password',
             'terminal_id',
         ]);
-
         if ($this->getTransaction()->isReadyForRefund() === false) {
-            throw new RefundException('shaparak::shaparak.could_not_refund_payment');
+            throw new RefundException(trans('shaparak::shaparak.could_not_refund_payment'));
         }
 
         try {
-            $response = $this->generateComplementaryOperation(self::URL_REFUND);
+            if ($this->getTransaction()->isReadyForReverse()) {
+                $response = $this->generateComplementaryOperation(self::URL_REFUND);
+            } elseif ($this->getTransaction()->isReadyForCancel()) {
+                $response = $this->generateComplementaryOperation(self::URL_CANSEL);
+            } else {
+                throw new RefundException(trans('shaparak::shaparak.could_not_refund_payment'));
+            }
 
             if ($response !== true) {
-                throw new Exception('shaparak::asanpardakht.could_not_refund_transaction');
+                throw new Exception(trans('shaparak::shaparak.refund_payment_already_exist'));
             }
 
             $this->getTransaction()->setRefunded(true);
@@ -304,7 +324,7 @@ public function refundTransaction(): bool
             $this->log($e->getMessage(), [], 'error');
 
             throw new RefundException(
-                'refundTransaction: ' . $e->getMessage() . ' #' . $e->getCode(),
+                'refundTransaction: '.$e->getMessage().' #'.$e->getCode(),
                 $e->getCode()
             );
         }

translations/fa/shaparak.php

@@ -1,19 +1,20 @@
 <?php
 
 return [
-    'canceled_by_user'             => 'تراکنش بانکی توسط کاربر لغو شد',
-    'could_not_request_token'      => 'امکان درخواست توکن برای این تراکنش وجود ندارد',
+    'canceled_by_user' => 'تراکنش بانکی توسط کاربر لغو شد',
+    'could_not_request_token' => 'امکان درخواست توکن برای این تراکنش وجود ندارد',
     'could_not_verify_transaction' => 'امکان تایید این تراکنش وجود ندارد',
-    'could_not_inquiry_payment'    => 'امکان استعلام این تراکنش وجود ندارد',
-    'could_not_settle_payment'     => 'امکان تسویه برای این تراکنش وجود ندارد',
-    'could_not_refund_payment'     => 'امکان برگشت زدن این تراکنش وجود ندارد',
-    'gate_not_ready'               => 'درگاه پرداختی یا وجود ندارد یا آماده سرویس دهی نمی باشد',
-    'goto_gate'                    => 'انتقال به درگاه پرداخت',
-    'invalid_response'             => 'پاسخ معتبر از سرور درگاه پرداخت دریافت نشد!',
-    'token_failed'                 => 'درخواست توکن تراکنش با موفقیت انجام نشد!',
-    'verify_failed'                => 'تایید تراکنش با موفقیت انجام نشد!',
-    'inquiry_failed'               => 'بررسی وضعیت تراکنش با موفقیت انجام نشد!',
-    'settle_failed'                => 'تایید بعد از تراکنش با موفقیت انجام نشد!',
-    'refund_failed'                => 'بازگشت تراکنش با موفقیت انجام نشد!',
-    'amounts_not_match'            => 'مقدار فاکتور با مقدار برگشتی از درگاه برابر نیست!',
+    'could_not_inquiry_payment' => 'امکان استعلام این تراکنش وجود ندارد',
+    'could_not_settle_payment' => 'امکان تسویه برای این تراکنش وجود ندارد',
+    'could_not_refund_payment' => 'امکان برگشت زدن این تراکنش وجود ندارد',
+    'refund_payment_already_exist' => 'تراکنش قبلا برگشت خورده است',
+    'gate_not_ready' => 'درگاه پرداختی یا وجود ندارد یا آماده سرویس دهی نمی باشد',
+    'goto_gate' => 'انتقال به درگاه پرداخت',
+    'invalid_response' => 'پاسخ معتبر از سرور درگاه پرداخت دریافت نشد!',
+    'token_failed' => 'درخواست توکن تراکنش با موفقیت انجام نشد!',
+    'verify_failed' => 'تایید تراکنش با موفقیت انجام نشد!',
+    'inquiry_failed' => 'بررسی وضعیت تراکنش با موفقیت انجام نشد!',
+    'settle_failed' => 'تایید بعد از تراکنش با موفقیت انجام نشد!',
+    'refund_failed' => 'بازگشت تراکنش با موفقیت انجام نشد!',
+    'amounts_not_match' => 'مقدار فاکتور با مقدار برگشتی از درگاه برابر نیست!',
 ];