Merge pull request #36 from sudiptpa/fix/adding-emv-3dsc

Added EMV 3DSC

Author: sudiptpa

README.md

@@ -105,6 +105,7 @@ The following gateways are provided by this package:
     } else {
         echo sprintf('Transaction %s failed: %s', $response->getTransactionReference(), $response->getMessage());
     }
+```
 
 ### NAB Transact DirectPost v2
 
@@ -113,8 +114,8 @@ The following gateways are provided by this package:
 
     $gateway->setMerchantId('XYZ0010');
     $gateway->setTransactionPassword('abcd1234');
-
     $gateway->setTestMode(true);
+    $gateway->setHasEMV3DSEnabled(true);
 
     $card = new CreditCard(array(
         'firstName' => 'Sujip',
@@ -128,8 +129,10 @@ The following gateways are provided by this package:
     $response = $gateway->purchase(array(
         'amount' => '12.00',
         'transactionId' => 'ORDER-ZYX8',
+        'transactionReference' => '11fc42b0-bb7a-41a4-8b3c-096b3fd4d402'
         'currency' => 'AUD',
         'card' => $card,
+        'clientIp' => '192.168.1.1'
     ))
         ->send();
 
@@ -185,6 +188,7 @@ The following gateways are provided by this package:
     $response = $gateway->completePurchase(array(
         'amount' => '12.00',
         'transactionId' => '1234566789205067',
+        'transactionReference' => '11fc42b0-bb7a-41a4-8b3c-096b3fd4d402'
         'currency' => 'AUD',
         'returnUrl' => 'http://example.com/payment/response',
     ))

src/DirectPostGateway.php

@@ -11,11 +11,6 @@
  */
 class DirectPostGateway extends AbstractGateway
 {
-    /**
-     * @var bool
-     */
-    public $transparentRedirect = true;
-
     public function getName()
     {
         return 'NABTransact Direct Post';
@@ -62,6 +57,19 @@ public function setTransactionPassword($value)
         return $this->setParameter('transactionPassword', $value);
     }
 
+    public function getHasEMV3DSEnabled()
+    {
+        return $this->getParameter('hasEMV3DSEnabled');
+    }
+
+    /**
+     * @param $value
+     */
+    public function setHasEMV3DSEnabled($value)
+    {
+        return $this->setParameter('hasEMV3DSEnabled', $value);
+    }
+
     /**
      * @param array $parameters
      *

src/Enums/TransactionType.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace Omnipay\NABTransact\Enums;
+
+class TransactionType
+{
+    const NORMAL_PAYMENT = 0;
+    const NORMAL_PREAUTH = 1;
+
+    const PAYMENT_RISK_MANAGEMENT = 2;
+    const PREAUTH_RISK_MANAGEMENT = 3;
+
+    const PAYMENT_3DS_EMV3DS = 4;
+    const PREAUTH_3DS_EMV3DS = 5;
+
+    const PAYMENT_RISK_MANAGEMENT_3DS_EMV3DS = 6;
+    const PREAUTH_RISK_MANAGEMENT_3DS_EMV3DS = 7;
+
+    const STORE_ONLY = 8;
+}

src/Message/AbstractRequest.php

@@ -49,6 +49,19 @@ public function setTransactionPassword($value)
         return $this->setParameter('transactionPassword', $value);
     }
 
+    public function getHasEMV3DSEnabled()
+    {
+        return $this->getParameter('hasEMV3DSEnabled');
+    }
+
+    /**
+     * @param $value
+     */
+    public function setHasEMV3DSEnabled($value)
+    {
+        return $this->setParameter('hasEMV3DSEnabled', $value);
+    }
+
     /**
      * @return string
      */

src/Message/DirectPostAbstractRequest.php

@@ -2,6 +2,8 @@
 
 namespace Omnipay\NABTransact\Message;
 
+use Omnipay\NABTransact\Enums\TransactionType;
+
 /**
  * NABTransact Direct Post Abstract Request.
  */
@@ -22,14 +24,23 @@ abstract class DirectPostAbstractRequest extends AbstractRequest
      */
     public function generateFingerprint(array $data)
     {
-        $hash = implode('|', [
+        $hashable = [
             $data['EPS_MERCHANT'],
             $this->getTransactionPassword(),
             $data['EPS_TXNTYPE'],
             $data['EPS_REFERENCEID'],
             $data['EPS_AMOUNT'],
             $data['EPS_TIMESTAMP'],
-        ]);
+        ];
+
+        if ($this->getHasEMV3DSEnabled()) {
+            $hashable = array_merge(
+                $hashable,
+                [$data['EPS_ORDERID']]
+            );
+        }
+
+        $hash = implode('|', $hashable);
 
         return hash_hmac('sha256', $hash, $this->getTransactionPassword());
     }
@@ -43,15 +54,50 @@ public function getBaseData()
 
         $data['EPS_MERCHANT'] = $this->getMerchantId();
         $data['EPS_TXNTYPE'] = $this->txnType;
-        $data['EPS_IP'] = $this->getClientIp();
-        $data['EPS_AMOUNT'] = $this->getAmount();
         $data['EPS_REFERENCEID'] = $this->getTransactionId();
+        $data['EPS_AMOUNT'] = $this->getAmount();
         $data['EPS_TIMESTAMP'] = gmdate('YmdHis');
-        $data['EPS_FINGERPRINT'] = $this->generateFingerprint($data);
         $data['EPS_RESULTURL'] = $this->getReturnUrl();
-        $data['EPS_CALLBACKURL'] = $this->getNotifyUrl() ?: $this->getReturnUrl();
+        $data['EPS_IP'] = $this->getClientIp();
         $data['EPS_REDIRECT'] = 'TRUE';
-        $data['EPS_CURRENCY'] = $this->getCurrency();
+
+        if ($this->getNotifyUrl()) {
+            $data['EPS_CALLBACKURL'] = $this->getNotifyUrl();
+        }
+
+        if ($currency = $this->getCurrency()) {
+            $data['EPS_CURRENCY'] = $currency;
+        }
+
+        $card = $this->getCard();
+
+        if ($billingPostcode = $card->getBillingPostcode()) {
+            $data['EPS_ZIPCODE'] = $billingPostcode;
+        }
+
+        if ($billingCity = $card->getBillingCity()) {
+            $data['EPS_TOWN'] = $billingCity;
+        }
+
+        if ($billingCountry = $card->getBillingCountry()) {
+            $data['EPS_BILLINGCOUNTRY'] = $billingCountry;
+        }
+
+        if ($shippingCountry = $card->getShippingCountry()) {
+            $data['EPS_DELIVERYCOUNTRY'] = $shippingCountry;
+        }
+
+        if ($emailAddress = $card->getEmail()) {
+            $data['EPS_EMAILADDRESS'] = $emailAddress;
+        }
+
+        if ($this->getHasEMV3DSEnabled()) {
+            $data['EPS_ORDERID'] = $this->getTransactionReference();
+
+            $data['EPS_TXNTYPE'] = TransactionType::PAYMENT_3DS_EMV3DS;
+        }
+
+        $data['EPS_FINGERPRINT'] = $this->generateFingerprint($data);
 
         return $data;
     }

src/Message/DirectPostCompletePurchaseRequest.php

@@ -28,14 +28,16 @@ public function getData()
      */
     public function generateResponseFingerprint($data)
     {
-        $hash = implode('|', [
+        $hashable = [
             $data['merchant'],
             $this->getTransactionPassword(),
             $data['refid'],
             $this->getAmount(),
             $data['timestamp'],
             $data['summarycode'],
-        ]);
+        ];
+
+        $hash = implode('|', $hashable);
 
         return hash_hmac('sha256', $hash, $this->getTransactionPassword());
     }

src/Message/DirectPostWebhookRequest.php

@@ -0,0 +1,50 @@
+<?php
+
+namespace Omnipay\NABTransact\Message;
+
+class DirectPostWebhookRequest extends DirectPostAbstractRequest
+{
+    private $data = [];
+
+    public function __construct($data = [])
+    {
+        $this->data = $data;
+    }
+
+    public function generateResponseFingerprint($data)
+    {
+        $hashable = [
+            $data['merchant'],
+            $data['txn_password'],
+            $data['refid'],
+            $data['amount'],
+            $data['timestamp'],
+            $data['summarycode'],
+        ];
+
+        $hash = implode('|', $hashable);
+
+        return hash_hmac('sha256', $hash, $data['txn_password']);
+    }
+
+    public function vefiyFingerPrint($fingerprint)
+    {
+        $data = $this->data;
+
+        if ($fingerprint !== $this->generateResponseFingerprint($data)) {
+            $data['restext'] = $data['restext'].', Invalid fingerprint.';
+            $data['summarycode'] = 3;
+        }
+
+        return new DirectPostCompletePurchaseResponse($this, $data);
+    }
+
+    public function getData()
+    {
+        return $this->data;
+    }
+
+    public function sendData($data)
+    {
+    }
+}

src/Message/SecureXMLRiskPurchaseRequest.php

@@ -45,8 +45,11 @@ public function getData()
         $xml = $this->getBasePaymentXMLWithCard();
 
         $buyer = $xml->addChild('BuyerInfo');
+
         $buyer->addChild('ip', $this->getIp('ip'));
+
         $card = $this->getCard();
+
         if ($firstName = $card->getFirstName()) {
             $buyer->addChild('firstName', $firstName);
         }