support recurring payment type=RECURRING

Author: darbaoui

config/hyperpay.php

@@ -28,5 +28,6 @@
      * }
      */
     'transaction_model' => 'Devinweb\LaravelHyperpay\Models\Transaction',
-    'notificationUrl' => '/hyperpay/webhook',
+
+    'notificationUrl' => '/hyperpay/webhook'
 ];

src/LaravelHyperpay.php

@@ -47,6 +47,12 @@ class LaravelHyperpay implements Hyperpay
      */
     protected $gateway_url = 'https://test.oppwa.com';
 
+
+    /**
+     * @var bool demand to register the user card
+     */
+    protected $register_user_card = false;
+
     /**
      * Create a new manager instance.
      *
@@ -140,7 +146,7 @@ protected function prepareCheckout(Model $user, array $trackable_data, $request)
         $this->config['merchantTransactionId'] = $this->token;
         $this->config['userAgent'] = $request->server('HTTP_USER_AGENT');
         $result = (new HttpClient($this->client, $this->gateway_url.'/v1/checkouts', $this->config))->post(
-            $parameters = (new HttpParameters())->postParams(Arr::get($trackable_data, 'amount'), $user, $this->config, $this->billing)
+            $parameters = (new HttpParameters())->postParams(Arr::get($trackable_data, 'amount'), $user, $this->config, $this->billing, $this->register_user_card)
         );
 
         $response = (new HttpResponse($result, null, $parameters))
@@ -174,6 +180,20 @@ public function paymentStatus(string $resourcePath, string $checkout_id)
         return $response;
     }
 
+    /**
+     *
+     */
+    public function recurringPayment(string $registration_id, $amount, $checkout_id)
+    {
+        $result = (new HttpClient($this->client, $this->gateway_url.'/v1/registrations/'.$registration_id.'/payments', $this->config))->post(
+            (new HttpParameters())->postRecurringPayment($amount, $this->redirect_url, $checkout_id),
+        );
+        
+        $response = (new HttpResponse($result, null, []))->recurringPayment();
+
+        return $response;
+    }
+
     /**
      * Add merchantTransactionId.
      *
@@ -200,6 +220,18 @@ public function addRedirectUrl($url)
         return $this;
     }
 
+    /**
+     * Set the register user card information, to use it when we prepare the checkout
+     *
+     * @return $this
+     */
+    public function registerUserCard()
+    {
+        $this->register_user_card = true;
+
+        return $this;
+    }
+
     /**
      * Generate the token that used as merchantTransactionId to generate the payment form.
      *

src/Support/HttpParameters.php

@@ -17,10 +17,12 @@ class HttpParameters
      * @param  \Devinweb\LaravelHyperpay\Contracts\BillingInterface  $billing
      * @return array
      */
-    public function postParams($amount, $user, $heyPerPayConfig, $billing): array
+    public function postParams($amount, $user, $heyPerPayConfig, $billing, $register_user): array
     {
         $body = $this->getBodyParameters($amount, $user, $heyPerPayConfig);
-
+        if ($register_user) {
+            $body = array_merge($body, $this->registerPaymentData());
+        }
         $billing_parameters = $this->getBillingParameters($billing);
 
         $parameters = array_merge($body, $billing_parameters);
@@ -41,6 +43,28 @@ public function getParams($checkout_id): array
         return ['entityId' => $entityId];
     }
 
+    /**
+     * Generate the params that used in the recurring payment
+     * @param string $amount
+     * @param string $shopperResultUrl
+     * @param string $checkout_id That define the entity_id related to the registration id.
+     * @return array
+     */
+    public function postRecurringPayment($amount, $shopperResultUrl, $checkout_id)
+    {
+        $currency = config('hyperpay.currency');
+
+        return array_merge([
+            "standingInstruction.mode"=>"REPEATED",
+            "standingInstruction.type" => "RECURRING",
+            "standingInstruction.source"=>"MIT",
+            "amount"=> $amount,
+            "currency" => $currency,
+            "paymentType"=>"PA",
+            "shopperResultUrl" => $shopperResultUrl
+        ], $this->getParams($checkout_id));
+    }
+
     /**
      * Generate the basic user parameters.
      *
@@ -70,6 +94,20 @@ protected function getBodyParameters($amount, Model $user, $heyPerPayConfig): ar
         return $body_parameters;
     }
 
+    /**
+     * The init recurring payment params
+     * @return array
+     */
+    protected function registerPaymentData()
+    {
+        return [
+            "standingInstruction.mode"=>"INITIAL",
+            "standingInstruction.type" => "RECURRING",
+            "standingInstruction.source"=>"CIT",
+            "createRegistration"=>true,
+        ];
+    }
+
     /**
      * Get the billing data from the Billing class if a user generate one.
      *

src/Support/HttpResponse.php

@@ -115,6 +115,18 @@ public function paymentStatus()
         return response()->json($response, $response['status']);
     }
 
+    /**
+     * Get the recurring payment response.
+     *
+     * @return \Illuminate\Support\Facades\Response
+     */
+    public function recurringPayment()
+    {
+        $response = $this->response();
+
+        return  response()->json($response, $response['status']);
+    }
+
     /**
      * Get the body of the response.
      *