Merge pull request #23 from PaymentHighway/reference_number_for_single_settlements

Kostersson · web-flow · commit 7a43dd10a0cf · 2020-02-12T15:42:16.000+02:00
Reference number for single settlements
diff --git a/src/FormBuilder.php b/src/FormBuilder.php
@@ -152,12 +152,14 @@ public function generateAddCardParameters( $acceptCvcRequired = null, $skipFormN
      * @param string $webhookCancelUrl      The URL the PH server makes request after cancelling the transaction (clicking on the cancel button).
      * @param int $webhookDelay             Delay for webhook in seconds. Between 0-900
      * @param bool $showPaymentMethodSelector
+     * @param string $referenceNumber       Reference number in RF or Finnish reference format, used when settling the transaction to the merchant account. Only used if one-by-ony transaction settling is configured.
+     *
      * @return Form
      */
     public function generatePaymentParameters($amount, $currency, $orderId, $description, $skipFormNotifications = null,
                                               $exitIframeOnResult = null, $exitIframeOn3ds = null, $use3ds = null,
                                               $webhookSuccessUrl = null, $webhookFailureUrl = null, $webhookCancelUrl = null,
-                                              $webhookDelay = null, $showPaymentMethodSelector = null)
+                                              $webhookDelay = null, $showPaymentMethodSelector = null, $referenceNumber = null)
 
     {
         $commonParameters = $this->createFormParameterArray();
@@ -176,6 +178,8 @@ public function generatePaymentParameters($amount, $currency, $orderId, $descrip
             $commonParameters[self::$SPH_USE_THREE_D_SECURE] = $use3ds;
         if(!is_null($showPaymentMethodSelector))
             $commonParameters[self::$SPH_SHOW_PAYMENT_METHOD_SELECTOR] = $showPaymentMethodSelector;
+        if(!is_null($referenceNumber))
+            $commonParameters[self::$SPH_REFERENCE_NUMBER] = $referenceNumber;
 
         $commonParameters = array_merge($commonParameters,
             $this->createWebhookParametersArray($webhookSuccessUrl, $webhookFailureUrl, $webhookCancelUrl, $webhookDelay));
@@ -209,12 +213,13 @@ public function generatePaymentParameters($amount, $currency, $orderId, $descrip
      * @param string $webhookFailureUrl     The URL the PH server makes request after a failure such as an authentication or connectivity error.
      * @param string $webhookCancelUrl      The URL the PH server makes request after cancelling the transaction (clicking on the cancel button).
      * @param int $webhookDelay             Delay for webhook in seconds. Between 0-900
+     * @param string $referenceNumber       Reference number in RF or Finnish reference format, used when settling the transaction to the merchant account. Only used if one-by-ony transaction settling is configured.
      * @return Form
      */
     public function generateAddCardAndPaymentParameters($amount, $currency, $orderId, $description, $skipFormNotifications = null,
                                                         $exitIframeOnResult = null, $exitIframeOn3ds = null, $use3ds = null,
                                                         $webhookSuccessUrl = null, $webhookFailureUrl = null, $webhookCancelUrl = null,
-                                                        $webhookDelay = null)
+                                                        $webhookDelay = null, $referenceNumber = null)
     {
         $commonParameters = $this->createFormParameterArray();
 
@@ -226,6 +231,8 @@ public function generateAddCardAndPaymentParameters($amount, $currency, $orderId
             $commonParameters[self::$SPH_EXIT_IFRAME_ON_THREE_D_SECURE] = $exitIframeOn3ds;
         if(!is_null($use3ds))
             $commonParameters[self::$SPH_USE_THREE_D_SECURE] = $use3ds;
+        if(!is_null($referenceNumber))
+            $commonParameters[self::$SPH_REFERENCE_NUMBER] = $referenceNumber;
 
         $commonParameters = array_merge($commonParameters,
             $this->createWebhookParametersArray($webhookSuccessUrl, $webhookFailureUrl, $webhookCancelUrl, $webhookDelay));
@@ -261,12 +268,13 @@ public function generateAddCardAndPaymentParameters($amount, $currency, $orderId
      * @param string $webhookFailureUrl     The URL the PH server makes request after a failure such as an authentication or connectivity error.
      * @param string $webhookCancelUrl      The URL the PH server makes request after cancelling the transaction (clicking on the cancel button).
      * @param int $webhookDelay             Delay for webhook in seconds. Between 0-900
+     * @param string $referenceNumber       Reference number in RF or Finnish reference format, used when settling the transaction to the merchant account. Only used if one-by-ony transaction settling is configured.
      * @return Form
      */
     public function generatePayWithTokenAndCvcParameters( $tokenId, $amount, $currency, $orderId, $description, $skipFormNotifications = null,
                                                           $exitIframeOnResult = null, $exitIframeOn3ds = null, $use3ds = null,
                                                           $webhookSuccessUrl = null, $webhookFailureUrl = null, $webhookCancelUrl = null,
-                                                          $webhookDelay = null)
+                                                          $webhookDelay = null, $referenceNumber = null)
     {
         $commonParameters = $this->createFormParameterArray();
 
@@ -278,6 +286,8 @@ public function generatePayWithTokenAndCvcParameters( $tokenId, $amount, $curren
             $commonParameters[self::$SPH_EXIT_IFRAME_ON_THREE_D_SECURE] = $exitIframeOn3ds;
         if(!is_null($use3ds))
             $commonParameters[self::$SPH_USE_THREE_D_SECURE] = $use3ds;
+        if(!is_null($referenceNumber))
+            $commonParameters[self::$SPH_REFERENCE_NUMBER] = $referenceNumber;
 
         $commonParameters = array_merge($commonParameters,
             $this->createWebhookParametersArray($webhookSuccessUrl, $webhookFailureUrl, $webhookCancelUrl, $webhookDelay));
@@ -314,13 +324,14 @@ public function generatePayWithTokenAndCvcParameters( $tokenId, $amount, $curren
      * @param string $webhookFailureUrl     The URL the PH server makes request after a failure such as an authentication or connectivity error.
      * @param string $webhookCancelUrl      The URL the PH server makes request after cancelling the transaction (clicking on the cancel button).
      * @param int $webhookDelay             Delay for webhook in seconds. Between 0-900
+     * @param string $referenceNumber       Reference number in RF or Finnish reference format, used when settling the transaction to the merchant account. Only used if one-by-ony transaction settling is configured.
      * @return Form
      */
     public function generatePayWithMobilePayParameters($amount, $currency, $orderId, $description,
                                                        $exitIframeOnResult = null, $shopLogoUrl = null, $phoneNumber = null,
                                                        $shopName = null , $subMerchantId = null, $subMerchantName = null,
                                                        $webhookSuccessUrl = null, $webhookFailureUrl = null, $webhookCancelUrl = null,
-                                                       $webhookDelay = null)
+                                                       $webhookDelay = null, $referenceNumber = null)
     {
         $commonParameters = $this->createFormParameterArray();
 
@@ -342,6 +353,9 @@ public function generatePayWithMobilePayParameters($amount, $currency, $orderId,
         if(!is_null($subMerchantName))
             $commonParameters[self::$SPH_SUB_MERCHANT_NAME] = $subMerchantName;
 
+        if(!is_null($referenceNumber))
+            $commonParameters[self::$SPH_REFERENCE_NUMBER] = $referenceNumber;
+
         $commonParameters = array_merge($commonParameters,
             $this->createWebhookParametersArray($webhookSuccessUrl, $webhookFailureUrl, $webhookCancelUrl, $webhookDelay));
 
@@ -377,12 +391,13 @@ public function generatePayWithMobilePayParameters($amount, $currency, $orderId,
      * @param string $webhookFailureUrl     The URL the PH server makes request after a failure such as an authentication or connectivity error.
      * @param string $webhookCancelUrl      The URL the PH server makes request after cancelling the transaction (clicking on the cancel button).
      * @param int $webhookDelay             Delay for webhook in seconds. Between 0-900
+     * @param string $referenceNumber       Reference number in RF or Finnish reference format, used when settling the transaction to the merchant account. Only used if one-by-ony transaction settling is configured.
      * @return Form
      */
     public function generateMasterpassParameters($amount, $currency, $orderId, $description, $skipFormNotifications = null,
                                                  $exitIframeOnResult = null, $exitIframeOn3ds = null, $use3ds = null,
                                                  $webhookSuccessUrl = null, $webhookFailureUrl = null, $webhookCancelUrl = null,
-                                                 $webhookDelay = null)
+                                                 $webhookDelay = null, $referenceNumber = null)
     {
         $commonParameters = $this->createFormParameterArray();
 
@@ -398,6 +413,8 @@ public function generateMasterpassParameters($amount, $currency, $orderId, $desc
             $commonParameters[self::$SPH_EXIT_IFRAME_ON_THREE_D_SECURE] = $exitIframeOn3ds;
         if(!is_null($use3ds))
             $commonParameters[self::$SPH_USE_THREE_D_SECURE] = $use3ds;
+        if(!is_null($referenceNumber))
+            $commonParameters[self::$SPH_REFERENCE_NUMBER] = $referenceNumber;
 
         $commonParameters = array_merge($commonParameters,
             $this->createWebhookParametersArray($webhookSuccessUrl, $webhookFailureUrl, $webhookCancelUrl, $webhookDelay));
diff --git a/src/Model/Request/CustomerInitiatedTransaction.php b/src/Model/Request/CustomerInitiatedTransaction.php
@@ -23,6 +23,8 @@ class CustomerInitiatedTransaction extends \Solinor\PaymentHighway\Model\JsonSer
 
     public $commit = null;
 
+    public $reference_number = null;
+
     /**
      * @param Card|Token|null $request
      * @param int $amount
@@ -32,9 +34,10 @@ class CustomerInitiatedTransaction extends \Solinor\PaymentHighway\Model\JsonSer
      * @param string $orderId
      * @param \Solinor\PaymentHighway\Model\Splitting $splitting
      * @param bool $commit Whether or not automatically commit the payment. Default true.
+     * @param string $referenceNumber Reference number in RF or Finnish reference format, used when settling the transaction to the merchant account. Only used if one-by-ony transaction settling is configured.
      * @throws \Exception
      */
-    public function __construct( $request, $amount, $currency, $strong_customer_authentication, $blocking = true, $orderId = null, $splitting = null, $commit = true)
+    public function __construct( $request, $amount, $currency, $strong_customer_authentication, $blocking = true, $orderId = null, $splitting = null, $commit = true, $referenceNumber = null)
     {
         $this->amount = $amount;
         $this->currency = $currency;
@@ -43,6 +46,7 @@ public function __construct( $request, $amount, $currency, $strong_customer_auth
         $this->splitting = $splitting;
         $this->strong_customer_authentication = $strong_customer_authentication;
         $this->commit = $commit;
+        $this->reference_number = $referenceNumber;
 
         $this->setRequestByType($request);
     }
diff --git a/src/Model/Request/Transaction.php b/src/Model/Request/Transaction.php
@@ -20,6 +20,8 @@ class Transaction extends \Solinor\PaymentHighway\Model\JsonSerializable
     public $splitting = null;
     public $commit = null;
 
+    public $reference_number = null;
+
     /**
      * @param int $amount
      * @param string $currency
@@ -28,16 +30,18 @@ class Transaction extends \Solinor\PaymentHighway\Model\JsonSerializable
      * @param string $orderId
      * @param \Solinor\PaymentHighway\Model\Splitting $splitting
      * @param bool $commit Whether or not automatically commit the payment. Default true.
+     * @param string $referenceNumber Reference number in RF or Finnish reference format, used when settling the transaction to the merchant account. Only used if one-by-ony transaction settling is configured.
      * @throws \Exception
      */
-    public function __construct( $request, $amount, $currency, $blocking = true, $orderId = null, $splitting = null, $commit = null)
+    public function __construct( $request, $amount, $currency, $blocking = true, $orderId = null, $splitting = null, $commit = null, $referenceNumber = null)
     {
         $this->amount = $amount;
         $this->currency = $currency;
         $this->order = $orderId;
         $this->blocking = $blocking;
         $this->splitting = $splitting;
         $this->commit = $commit;
+        $this->reference_number = $referenceNumber;
 
         $this->setRequestByType($request);
     }
diff --git a/src/PaymentApi.php b/src/PaymentApi.php
@@ -56,7 +56,7 @@ class PaymentApi
      * @param string $merchant
      * @param string $apiversion
      */
-    public function __construct($serviceUrl, $signatureKeyId, $signatureSecret, $account, $merchant, $apiversion = "20180725")
+    public function __construct($serviceUrl, $signatureKeyId, $signatureSecret, $account, $merchant, $apiversion = "20191204")
     {
         $this->serviceUrl = $serviceUrl;
         $this->signatureKeyId = $signatureKeyId;
diff --git a/tests/unit/FormBuilderTest.php b/tests/unit/FormBuilderTest.php
@@ -41,19 +41,21 @@ public function PaymentParameters($method, $signatureKeyId, $signatureSecret, $a
                                       $showPaymentSelector
     )
     {
+        $referenceNumber = "1313";
+
         $formbuilder = new \Solinor\PaymentHighway\FormBuilder(
             $method, $signatureKeyId, $signatureSecret, $account,
             $merchant, $baseUrl, $successUrl, $failureUrl,
             $cancelUrl, $language
         );
 
         $form = $formbuilder->generatePaymentParameters($amount, $currency, $orderId, $description, null,
-            null, null, null, $showPaymentSelector);
+            null, null, null, $showPaymentSelector, $referenceNumber);
 
         $this->assertInstanceOf('\Solinor\PaymentHighway\Model\Form', $form);
         $this->assertEquals($baseUrl . '/form/view/pay_with_card', $form->getAction());
         $this->assertEquals($method, $form->getMethod());
-        $this->assertCount(14, $form->getParameters());
+        $this->assertCount(15, $form->getParameters());
     }
 
     /**
diff --git a/tests/unit/PaymentApiTest.php b/tests/unit/PaymentApiTest.php
@@ -45,6 +45,8 @@ class PaymentApiTest extends TestBase
     const InvalidPan = '415301399900024';
     const InvalidCvc = '022';
 
+    const TestReferenceNumber = "1313";
+
     protected static $orderId;
 
     /**
@@ -98,7 +100,7 @@ public function initHandlerSuccessfully( PaymentApi $api )
     public function debitTransactionSuccess(PaymentApi $api, $transactionId )
     {
 
-        $card = $this->getValidCardTransactionRequest();
+        $card = $this->getValidCardTransactionRequest(null, self::TestReferenceNumber);
 
         $response = $api->debitTransaction( $transactionId, $card)->body;
 
@@ -116,13 +118,8 @@ public function debitTransactionSuccess(PaymentApi $api, $transactionId )
      * @param string $transactionId
      * @return string transactionId
      */
-    public function transactionStatus(PaymentApi $api, $transactionId )
+    public function transactionResult(PaymentApi $api, $transactionId )
     {
-
-        $card = $this->getValidCardTransactionRequest();
-
-        $api->debitTransaction( $transactionId, $card)->body;
-
         $response = $api->transactionResult( $transactionId)->body;
 
         $this->assertEquals('100', $response->result->code);
@@ -162,6 +159,7 @@ public function transactionStatusAfterDebit(PaymentApi $api, $transactionId)
         $response = $api->statusTransaction($transactionId)->body;
 
         $this->assertEquals('4000', $response->transaction->status->code);
+        $this->assertEquals(self::TestReferenceNumber, $response->transaction->reference_number);
         $this->assertEquals('100', $response->result->code);
         $this->assertEquals('OK', $response->result->message);
     }
@@ -336,7 +334,7 @@ public function splittingDetailsAreReturnedInTransactionStatus(PaymentApi $api)
      * @param Splitting $splitting
      * @return Transaction
      */
-    private function getValidCardTransactionRequest($splitting = null)
+    private function getValidCardTransactionRequest($splitting = null, $referenceNumber = null)
     {
         return new Transaction(
             new Card(
@@ -349,7 +347,9 @@ private function getValidCardTransactionRequest($splitting = null)
             'EUR',
             true,
             self::$orderId,
-            $splitting
+            $splitting,
+            true,
+            $referenceNumber
         );
     }
 

Original file line number	Diff line number	Diff line change
`@@ -56,7 +56,7 @@ class PaymentApi`
`56`	`56`	`* @param string $merchant`
`57`	`57`	`* @param string $apiversion`
`58`	`58`	`*/`
`59`		`- public function __construct($serviceUrl, $signatureKeyId, $signatureSecret, $account, $merchant, $apiversion = "20180725")`
	`59`	`+ public function __construct($serviceUrl, $signatureKeyId, $signatureSecret, $account, $merchant, $apiversion = "20191204")`
`60`	`60`	`{`
`61`	`61`	`$this->serviceUrl = $serviceUrl;`
`62`	`62`	`$this->signatureKeyId = $signatureKeyId;`