vantiv 0.3.0 → 1.0.0

data/.ruby-version

@@ -1 +1 @@
-2.2.3
+2.3.1

data/CHANGELOG.md

@@ -1,4 +1,14 @@
 Vantiv Ruby Changes
+1.0.0
+-----------
+- Breaking changes: replace deprecated DevHub API with XML API
+  - rename `Vantiv.acceptor_id` to `Vantiv.merchant_id`
+  - require `Vantiv.user` and `Vantiv.password` to be set
+  - remove `Vantiv.licence_id` (was DevHub specific)
+- Implement Apple Pay
+- Implement Security Code (CVV) mismatch filtering
+
+
 0.3.0
 -----------
 - Bug/fix: adds expiry arguments to the relevant methods when running the fixture generator

data/README.md

@@ -23,10 +23,12 @@ The gem needs the following configuration to be set on app initialization. It is
 
 ```ruby
 Vantiv.configure do |config|
-  config.license_id = ENV["VANTIV_LICENSE_ID"]
-  config.acceptor_id = ENV["VANTIV_ACCEPTOR_ID"]
-  config.order_source = "desired-order-source"
+  config.merchant_id = ENV["VANTIV_MERCHANT_ID"]
+  config.default_order_source = "desired-order-source"
   config.paypage_id = ENV["VANTIV_PAYPAGE_ID"]
+  
+  config.user = ENV["VANTIV_USER"]
+  config.password = ENV["VANTIV_PASSWORD"]
 
   config.default_report_group = 'default-report-group'
 end
@@ -34,35 +36,34 @@ end
 
 ## Certification
 
-Vantiv's DevHub requires merchants to certify their applications for usage with their API. To make this integration process easy, the gem provides a script to run through these tests.
+Vantiv requires merchants to certify their applications for usage with their API. To make this integration process easy, the gem provides a script to run through these tests.
 
 To certify your application, run the following script:
 
 ```
-$ bundle exec vantiv-certify-app -l sub-your-license-id-in-here -a sub-your-acceptor-id-in-here -p your-paypage-id 
+$ bundle exec vantiv-certify-app -a sub-your-merchant-id-in-here -p your-paypage-id -u your-user -w your-password
 ```
 
-A certs.txt file will be generated in the directory that the script is run, and then opened. It contains a list of DevHub Certification Test IDs and associated Request IDs, like follows:
+A certs.txt file will be generated in the directory that the script is run, and then opened. It contains a list of XML Certification Order IDs and associated Transaction IDs, like follows:
 
 ```
-L_AC_1, request-id-for-L_AC_1-here
-L_AC_2, request-id-for-L_AC_2-here
+AUTH_CAPTURE_1, transaction-id-for-AUTH_CAPTURE_1-here
+AUTH_CAPTURE_2, transaction-id-for-AUTH_CAPTURE_2-here
 ```
 
-Navigate to your application's page in DevHub's developer portal (apideveloper.vantiv.com). Paste the contents of this file into the validation form input field, and then click "Validate".
 
 ### Running a subset of the certifications
 
-If you want to just run a subset of the certifications you can pass in the Test ID that you want to which match against using the `--filter_by` option. For example, if you only want to run the Account Updater certification, which have Test IDs that are prefixed with `L_AU`, you would filter by `AU` like follows:
+If you want to just run a subset of the certifications you can pass in the Test ID that you want to which match against using the `--filter_by` option. For example, if you only want to run the Account Updater certification, which have Test IDs that are prefixed with `ACCOUNT_UPDATER`, you would filter by `ACCOUNT_UPDATER` like follows:
 
 ```
-$ bundle exec vantiv-certify-app -l foo -a bar -p bla --filter_by=AU
+$ bundle exec vantiv-certify-app -a bar -p bla -u uzr -w pwd --filter_by=ACCOUNT_UPDATER
 ```
 
 
 ## Usage
 
-The vantiv gem provides a simple ruby client for interacting with Vantiv's DevHub API. This API wraps their Litle/XML API and provides an API that uses json. This gem provides a way for a merchant to:
+The vantiv gem provides a simple ruby client for interacting with Vantiv's XML API. This API wraps their Litle/XML API and provides an API that uses json. This gem provides a way for a merchant to:
 
 1. Use Vantiv's eProtect feature to tokenize sensitive card information directly to Vantiv's servers.
 2. Run the following transactions on customers' accounts:
@@ -178,8 +179,6 @@ window.onFormSubmit = function(){
 
 The above example shows the basic mechanics of rendering and interacting with the payframe.
 
-TODO: add more infor on payframe error codes here
-
 Once the temporary token has been retrieved, it should be posted to the merchant server, where the gem can be used to retrieved the permanent token (PaymentAccountID).
 
 #### Retrieving a Payment Account ID
@@ -232,12 +231,25 @@ To place an authorization on a client's card, simply do:
 Vantiv.auth(
   payment_account_id: '12345', # retrieved earlier
   amount: 10000, # amount in cents, as an integer
-  customer_id: '123',
-  external_id: 'order123'
+  customer_id: '123', # unique id for the customer
+  order_id: 'order123', # unique id for the order
+  expiry_month: '11', # expiration month for payment account id
+  expiry_year: '2016', # expiration year for payment account id
+  order_source: 'applepay', # optional order source, defaults to Vantiv.default_order_source,
+  online_payment_cryptogram: 'online-payment-cryptogram', # optional, defaults to nil; used for Apple Pay
+  use_temporarily_stored_security_code: true # optional, defaults to false; used for security code matching
 )
-
 ```
 
+#### Security Code (CVV) Matching
+Security Code Matching is a feature from Vantiv that allows you to have transactions fail or "filtered" out when there is a Security Code (CVV) mismatch.
+
+To use this feature you must first certify for it with Vantiv. Once the feature has been turned on, you can use it by setting  `use_temporarily_stored_security_code` to `true` in auth or auth_capture requests that happen immediately after tokenization.
+
+When `use_temporarily_stored_security_code` is set to `true`, `000` will be sent as the security code (CVV) in the request to Vantiv. This will tell Vantiv to look up the security code (CVV) for the payment account id that you passed it.
+
+For PCI Compliance reasons, Vantiv is only able to temporarily store the security code (CVV) for up to ~24 hours after the card was tokenized. This means that this feature should be used immediately following the tokenziation of the card.
+
 Notes:
 
 1. See Tokenizing via eProtect for notes on how to retrieve a payment account id.
@@ -271,7 +283,7 @@ It is possible for a merchant to capture an amount differing from the amount pla
 ```ruby
 Vantiv.capture(
   transaction_id: 'transaction-id-from-auth',
-  amount: 10000 #amount in cents
+  amount: 10000 # amount in cents
 )
 ```
 
@@ -279,7 +291,18 @@ It is possible to capture an amount exceeding the amount authorized, there are s
 
 ### Auth capture (sales)
 
-TODO: Add usage info
+Authorizes and Captures a 
+```ruby
+Vantiv.auth_capture(
+  payment_account_id: 'payment-account-id-to-capture-from',
+  amount: 10000, # amount in cents,
+  customer_id: '123', # unique id for the customer
+  expiry_month: '11', # expiration month for payment account id
+  expiry_year: '2016', # expiration year for payment account id
+  order_source: 'applepay', # optional order source, defaults to Vantiv.default_order_source,
+  online_payment_cryptogram: 'online-payment-cryptogram' # optional online payment cryptogram; used for Apple Pay
+)
+```
 
 ### Credits
 
@@ -299,16 +322,6 @@ Vantiv.credit(
 
 NOTE: Vantiv does NOT provide any transaction checking when a request is received to credit a customer. This includes even not checking that the prior transaction _even exists_. See 'Tied Transaction Error Handling' for more info.
 
-### Voids
-
-> The Void transaction enables you to cancel any settlement transaction as long as the transaction has not yet settled and the original transaction occurred within the system.
-> Do not use Void transactions to void an Authorization. To remove an Authorization use an Authorization reversal transaction.
-
-TODO: Add usage info
-
-### Refunds
-
-TODO: Add usage info
 
 ## Usage in non-production environments
 

data/bin/console

@@ -7,11 +7,13 @@ require "dotenv"
 Dotenv.load
 Vantiv.configure do |config|
   config.environment = Vantiv::Environment::CERTIFICATION
-  config.license_id = ENV["LICENSE_ID"]
-  config.acceptor_id = ENV["ACCEPTOR_ID"]
-  config.order_source = "ecommerce"
+  config.merchant_id = ENV["MERCHANT_ID"]
+  config.default_order_source = "ecommerce"
   config.paypage_id = ENV["PAYPAGE_ID"]
 
+  config.user = ENV["VANTIV_USER"]
+  config.password = ENV["VANTIV_PASSWORD"]
+
   config.default_report_group = '1'
 end
 

data/bin/generate_sandbox_fixtures

@@ -7,11 +7,13 @@ require "dotenv"
 Dotenv.load
 Vantiv.configure do |config|
   config.environment = Vantiv::Environment::CERTIFICATION
-  config.license_id = ENV["LICENSE_ID"]
-  config.acceptor_id = ENV["ACCEPTOR_ID"]
-  config.order_source = "ecommerce"
+  config.merchant_id = ENV["MERCHANT_ID"]
+  config.default_order_source = "ecommerce"
   config.paypage_id = ENV["PAYPAGE_ID"]
 
+  config.user = ENV["VANTIV_USER"]
+  config.password = ENV["VANTIV_PASSWORD"]
+
   config.default_report_group = '1'
 end
 

data/bin/paypage_server

@@ -8,11 +8,13 @@ require "vantiv/certification/paypage_server"
 
 Vantiv.configure do |config|
   config.environment = Vantiv::Environment::CERTIFICATION
-  config.license_id = ENV["LICENSE_ID"]
-  config.acceptor_id = ENV["ACCEPTOR_ID"]
-  config.order_source = "ecommerce"
+  config.merchant_id = ENV["MERCHANT_ID"]
+  config.default_order_source = "ecommerce"
   config.paypage_id = ENV["PAYPAGE_ID"]
 
+  config.user = ENV["VANTIV_USER"]
+  config.password = ENV["VANTIV_PASSWORD"]
+
   config.default_report_group = '1'
 end
 

data/cert_fixtures/{L_AU_7.json → ACCOUNT_UPDATER_100B.json}

@@ -9,7 +9,7 @@
       "PartialApprovedFlag": "false"
     },
     "PaymentAccount": {
-      "PaymentAccountID": "#{L_AU_3.litleOnlineResponse.saleResponse.tokenResponse.PaymentAccountID}"
+      "PaymentAccountID": "#{ACCOUNT_UPDATER_100A.body.sale_response.token_response.payment_account_id}"
     },
     "Card": {
       "ExpirationMonth": "01",

data/cert_fixtures/AUTH_CAPTURE_1A.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CAPTURE",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{AUTH_CAPTURE_1.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/AUTH_CAPTURE_2A.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CAPTURE",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{AUTH_CAPTURE_2.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/AUTH_CAPTURE_3A.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CAPTURE",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{AUTH_CAPTURE_3.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/AUTH_CAPTURE_4A.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CAPTURE",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{AUTH_CAPTURE_4.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/AUTH_CAPTURE_5A.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CAPTURE",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{AUTH_CAPTURE_5.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/{L_AR_1A.json → AUTH_REVERSAL_32A.json}

@@ -2,7 +2,7 @@
   "endpoint": "CAPTURE",
   "body": {
     "Transaction": {
-      "TransactionID": "#{L_AR_1.litleOnlineResponse.authorizationResponse.TransactionID}",
+      "TransactionID": "#{AUTH_REVERSAL_32.body.authorization_response.transaction_id}",
       "TransactionAmount": "50.50"
     }
   }

data/cert_fixtures/AUTH_REVERSAL_32B.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "AUTH_REVERSAL",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{AUTH_REVERSAL_32.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/AUTH_REVERSAL_33A.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "AUTH_REVERSAL",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{AUTH_REVERSAL_33.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/AUTH_REVERSAL_34A.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "AUTH_REVERSAL",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{AUTH_REVERSAL_34.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/{L_AR_4A.json → AUTH_REVERSAL_35A.json}

@@ -2,7 +2,7 @@
   "endpoint": "CAPTURE",
   "body": {
     "Transaction": {
-      "TransactionID": "#{L_AR_4.litleOnlineResponse.authorizationResponse.TransactionID}",
+      "TransactionID": "#{AUTH_REVERSAL_35.body.authorization_response.transaction_id}",
       "TransactionAmount": "50.50"
     }
   }

data/cert_fixtures/{L_AR_4B.json → AUTH_REVERSAL_35B.json}

@@ -2,7 +2,7 @@
   "endpoint": "AUTH_REVERSAL",
   "body": {
     "Transaction": {
-      "TransactionID": "#{L_AR_4.litleOnlineResponse.authorizationResponse.TransactionID}",
+      "TransactionID": "#{AUTH_REVERSAL_35.body.authorization_response.transaction_id}",
       "TransactionAmount": "50.50"
     }
   }

data/cert_fixtures/{L_AR_5A.json → AUTH_REVERSAL_36A.json}

@@ -2,7 +2,7 @@
   "endpoint": "AUTH_REVERSAL",
   "body": {
     "Transaction": {
-      "TransactionID": "#{L_AR_5.litleOnlineResponse.authorizationResponse.TransactionID}",
+      "TransactionID": "#{AUTH_REVERSAL_36.body.authorization_response.transaction_id}",
       "TransactionAmount": "100.00"
     }
   }

data/cert_fixtures/CREDIT_1A.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CAPTURE",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{CREDIT_1.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/CREDIT_1B.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CREDIT",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{CREDIT_1A.body.capture_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/CREDIT_2A.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CAPTURE",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{CREDIT_2.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/CREDIT_2B.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CREDIT",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{CREDIT_2A.body.capture_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/CREDIT_3A.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CAPTURE",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{CREDIT_3.body.authorization_response.transaction_id}"
+    }
+  }
+}

data/cert_fixtures/CREDIT_3B.json

@@ -0,0 +1,8 @@
+{
+  "endpoint": "CREDIT",
+  "body": {
+    "Transaction": {
+      "TransactionID": "#{CREDIT_3A.body.capture_response.transaction_id}"
+    }
+  }
+}