add credential on file support

craigpaul · Aug 23, 2019 · 4e09982 · 4e09982
1 parent 5b4ce61
commit 4e09982
Show file tree

Hide file tree

Showing 7 changed files with 164 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -34,6 +34,7 @@ $params = [
   'environment' => Moneris::ENV_TESTING, // default: Moneris::ENV_LIVE
   'avs' => true, // default: false
   'cvd' => true, // default: false
+  'cof' => true, // default: false
 ];
 
 $gateway = (new Moneris($id, $token, $params))->connect();
@@ -52,6 +53,7 @@ $params = [
   'environment' => Moneris::ENV_TESTING, // default: Moneris::ENV_LIVE
   'avs' => true, // default: false
   'cvd' => true, // default: false
+  'cof' => true, // default: false
 ];
 
 $gateway = Moneris::create($id, $token, $params);
@@ -222,6 +224,23 @@ if ($response->successful && ($response->failedAvs || $response->failedCvd)) {
 }
 ```
 
+### Credential On File
+
+The credential on file is part of the new Visa requirements to pass the CVD/CVV2 data for transactions. 
+
+```php
+$params = [
+    'order_id' => uniqid('1234-56789', true),
+    'amount' => '1.00',
+    'data_key' => $key,
+    'payment_indicator' => 'U',
+    'payment_information' => '2',
+    'issuer_id' => $issuer_id // this is optional
+];
+
+$response = $vault->purchase($params); // could be purchase, preauth, etc.
+```
+
 ## Vault
 
 The Moneris Vault allows you create and maintain credit card profiles on the Moneris servers instead of your own. To access the Vault, you will need to have your instantiated Gateway ([see above](#instantiation)).

diff --git a/src/Gateway.php b/src/Gateway.php
@@ -15,6 +15,7 @@
  * @property-read string $id
  * @property-read string $token
  * @property \CraigPaul\Moneris\Transaction $transaction
+ * @property bool $cof
  */
 class Gateway
 {
@@ -72,6 +73,13 @@ class Gateway
      */
     protected $transaction;
 
+    /**
+     * Determine if we will use Credential On File.
+     *
+     * @var bool
+     */
+    protected $cof = false;
+
     /**
      * Create a new Moneris instance.
      *
@@ -135,6 +143,10 @@ public function cards()
             $vault->cvd = boolval($this->cvd);
         }
 
+        if (isset($this->cof)) {
+            $vault->cof = boolval($this->cof);
+        }
+
         return $vault;
     }
 

diff --git a/src/Moneris.php b/src/Moneris.php
@@ -96,6 +96,10 @@ public function connect()
             $gateway->cvd = boolval($this->params['cvd']);
         }
 
+        if (isset($this->params['cof'])) {
+            $gateway->cof = boolval($this->params['cof']);
+        }
+
         return $gateway;
     }
 }
diff --git a/src/Receipt.php b/src/Receipt.php
@@ -36,6 +36,7 @@ public function __construct($data)
             ['property' => 'time', 'key' => 'TransTime', 'cast' => 'string'],
             ['property' => 'transaction', 'key' => 'TransID', 'cast' => 'string'],
             ['property' => 'type', 'key' => 'TransType', 'cast' => 'string'],
+            ['property' => 'issuer_id', 'key' => 'IssuerId', 'cast' => 'string'],
         ]);
     }
 

diff --git a/src/Transaction.php b/src/Transaction.php
@@ -207,6 +207,14 @@ public function toXml()
                 'res_preauth_cc'
             ]
         );
+
+        $cc_action = in_array(
+            $params['type'],
+            [
+                'res_add_cc',
+                'res_update_cc'
+            ]
+        );
         unset($params['type']);
 
         if ($gateway->cvd && $efraud) {
@@ -229,6 +237,23 @@ public function toXml()
             }
         }
 
+        if ($gateway->cof && ($efraud || $cc_action)) {
+            $cofInfo = $type->addChild('cof_info');
+            if (!empty($params['payment_indicator'])) {
+                $cofInfo->addChild('payment_indicator', $params['payment_indicator']);
+            }
+
+            if (!empty($params['payment_information'])) {
+                $cofInfo->addChild('payment_information', $params['payment_information']);
+            }
+
+            if (!empty($params['issuer_id'])) {
+                $cofInfo->addChild('issuer_id', $params['issuer_id']);
+            }
+
+            unset($params['payment_indicator'], $params['payment_information'], $params['issuer_id']);
+        }
+
         $this->append($params, $type);
 
         return $xml->asXML();
@@ -297,6 +322,20 @@ public function valid()
                         ];
                     }
 
+                    if ($this->gateway->cof) {
+                        $errors[] = isset($params['payment_indicator']) ? null : [
+                            'field' => 'payment_indicator',
+                            'code' => self::PARAMETER_NOT_SET,
+                            'title' => 'not_set'
+                        ];
+
+                        $errors[] = isset($params['payment_information']) ? null : [
+                            'field' => 'payment_information',
+                            'code' => self::PARAMETER_NOT_SET,
+                            'title' => 'not_set'
+                        ];
+                    }
+
                     break;
                 case 'preauth':
                 case 'purchase':
@@ -352,6 +391,20 @@ public function valid()
                         ];
                     }
 
+                    if ($this->gateway->cof) {
+                        $errors[] = isset($params['payment_indicator']) ? null : [
+                            'field' => 'payment_indicator',
+                            'code' => self::PARAMETER_NOT_SET,
+                            'title' => 'not_set'
+                        ];
+
+                        $errors[] = isset($params['payment_information']) ? null : [
+                            'field' => 'payment_information',
+                            'code' => self::PARAMETER_NOT_SET,
+                            'title' => 'not_set'
+                        ];
+                    }
+
                     break;
                 case 'res_tokenize_cc':
                 case 'purchasecorrection':
@@ -421,6 +474,14 @@ public function valid()
                         'title' => 'not_set'
                     ];
 
+                    if ($this->gateway->cof) {
+                        $errors[] = isset($params['issuer_id']) ? null : [
+                            'field' => 'issuer_id',
+                            'code' => self::PARAMETER_NOT_SET,
+                            'title' => 'not_set'
+                        ];
+                    }
+
                     break;
                 case 'res_update_cc':
                     $errors[] = isset($params['data_key']) ? null : [
@@ -441,6 +502,14 @@ public function valid()
                         'title' => 'not_set'
                     ];
 
+                    if ($this->gateway->cof) {
+                        $errors[] = isset($params['issuer_id']) ? null : [
+                            'field' => 'issuer_id',
+                            'code' => self::PARAMETER_NOT_SET,
+                            'title' => 'not_set'
+                        ];
+                    }
+
                     break;
                 case 'res_delete':
                 case 'res_lookup_full':
@@ -500,6 +569,20 @@ public function valid()
                         ];
                     }
 
+                    if ($this->gateway->cof) {
+                        $errors[] = isset($params['payment_indicator']) ? null : [
+                            'field' => 'payment_indicator',
+                            'code' => self::PARAMETER_NOT_SET,
+                            'title' => 'not_set'
+                        ];
+
+                        $errors[] = isset($params['payment_information']) ? null : [
+                            'field' => 'payment_information',
+                            'code' => self::PARAMETER_NOT_SET,
+                            'title' => 'not_set'
+                        ];
+                    }
+
                     break;
                 default:
                     $errors[] = [

diff --git a/src/Vault.php b/src/Vault.php
@@ -31,17 +31,18 @@ public function __construct($id = '', $token = '', $environment = '')
      * Add a credit card to the Vault.
      *
      * @param \CraigPaul\Moneris\CreditCard $card
+     * @param array $extra_params
      *
      * @return \CraigPaul\Moneris\Response
      */
-    public function add(CreditCard $card)
+    public function add(CreditCard $card, $extra_params = [])
     {
-        $params = [
+        $params = array_merge($extra_params, [
             'type' => 'res_add_cc',
             'crypt_type' => $card->crypt,
             'pan' => $card->number,
             'expdate' => $card->expiry,
-        ];
+        ]);
 
         if (!is_null($card->customer)) {
             $params = array_merge($params, [
@@ -194,18 +195,19 @@ public function tokenize($transaction, $order = null)
      *
      * @param string $key
      * @param \CraigPaul\Moneris\CreditCard $card
+     * @param array $extra_params
      *
      * @return \CraigPaul\Moneris\Response
      */
-    public function update($key = '', CreditCard $card)
+    public function update($key = '', CreditCard $card, $extra_params = [])
     {
-        $params = [
+        $params = array_merge($extra_params, [
             'type' => 'res_update_cc',
             'data_key' => $key,
             'crypt_type' => $card->crypt,
             'pan' => $card->number,
             'expdate' => $card->expiry,
-        ];
+        ]);
 
         if (!is_null($card->customer)) {
             $params = array_merge($params, [

diff --git a/tests/VaultTest.php b/tests/VaultTest.php
@@ -472,4 +472,41 @@ public function it_can_capture_a_pre_authorized_credit_card_stored_in_the_moneri
         $this->assertTrue($response->successful);
         $this->assertEquals(true, $receipt->read('complete'));
     }
+
+    /** @test */
+    public function it_can_make_a_purchase_for_a_credit_card_stored_in_the_moneris_vault_using_credential_on_file()
+    {
+        $params = ['environment' => Moneris::ENV_TESTING, 'cof' => true];
+        $gateway = Moneris::create($this->id, $this->token, $params);
+        $vault = $gateway->cards();
+
+        $preauth_params = [
+            'order_id' => uniqid('1234-56789', true),
+            'amount' => '1.00',
+            'credit_card' => $this->visa,
+            'expdate' => '2012',
+            'payment_indicator' => 'C',
+            'payment_information' => '0'
+        ];
+
+        $response = $gateway->preauth($preauth_params);
+        $issuer_id = $response->receipt()->read('issuer_id');
+        $response = $vault->add($this->card, ['issuer_id' => $issuer_id]);
+        $key = $response->receipt()->read('key');
+
+        $params = array_merge($this->params, [
+            'data_key' => $key,
+            'payment_indicator' => 'U',
+            'payment_information' => '2',
+            'issuer_id' => $issuer_id
+        ]);
+
+        $response = $vault->purchase($params);
+        $receipt = $response->receipt();
+
+        $this->assertTrue($response->successful);
+        $this->assertEquals($key, $receipt->read('key'));
+        $this->assertEquals(true, $receipt->read('complete'));
+        $this->assertNotEmpty($receipt->read('issuer_id'));
+    }
 }