activemerchant 1.47.0 → 1.48.0

data/lib/active_merchant/billing/gateways/firstdata_e4.rb

@@ -40,6 +40,27 @@ module ActiveMerchant #:nodoc:
       self.homepage_url = "http://www.firstdata.com"
       self.display_name = "FirstData Global Gateway e4"
 
+      STANDARD_ERROR_CODE_MAPPING = {
+      # Bank error codes: https://firstdata.zendesk.com/entries/471297-First-Data-Global-Gateway-e4-Bank-Response-Codes
+        '201' => STANDARD_ERROR_CODE[:incorrect_number],
+        '531' => STANDARD_ERROR_CODE[:invalid_cvc],
+        '503' => STANDARD_ERROR_CODE[:invalid_cvc],
+        '811' => STANDARD_ERROR_CODE[:invalid_cvc],
+        '605' => STANDARD_ERROR_CODE[:invalid_expiry_date],
+        '522' => STANDARD_ERROR_CODE[:expired_card],
+        '303' => STANDARD_ERROR_CODE[:card_declined],
+        '530' => STANDARD_ERROR_CODE[:card_declined],
+        '401' => STANDARD_ERROR_CODE[:call_issuer],
+        '402' => STANDARD_ERROR_CODE[:call_issuer],
+        '501' => STANDARD_ERROR_CODE[:pickup_card],
+      # Ecommerce error codes -- https://firstdata.zendesk.com/entries/451980-ecommerce-response-codes-etg-codes
+        '22' => STANDARD_ERROR_CODE[:invalid_number],
+        '25' => STANDARD_ERROR_CODE[:invalid_expiry_date],
+        '31' => STANDARD_ERROR_CODE[:incorrect_cvc],
+        '44' => STANDARD_ERROR_CODE[:incorrect_zip],
+        '42' => STANDARD_ERROR_CODE[:processing_error]
+      }
+
       # Create a new FirstdataE4Gateway
       #
       # The gateway requires that a valid login and password be passed
@@ -213,12 +234,31 @@ module ActiveMerchant #:nodoc:
           xml.tag! "VerificationStr1", address_values.join("|")
         end
 
-        if credit_card.verification_value?
+        if credit_card.is_a?(NetworkTokenizationCreditCard)
+          add_network_tokenization_credit_card(xml, credit_card)
+        elsif credit_card.verification_value?
           xml.tag! "CVD_Presence_Ind", "1"
           xml.tag! "VerificationStr2", credit_card.verification_value
         end
       end
 
+      def add_network_tokenization_credit_card(xml, credit_card)
+        xml.tag!("Ecommerce_Flag", credit_card.eci)
+
+        case card_brand(credit_card).to_sym
+        when :visa
+          xml.tag!("XID", credit_card.transaction_id) if credit_card.transaction_id
+          xml.tag!("CAVV", credit_card.payment_cryptogram)
+        when :mastercard
+          xml.tag!("XID", credit_card.transaction_id) if credit_card.transaction_id
+          xml.tag!("CAVV", credit_card.payment_cryptogram)
+        when :american_express
+          cryptogram = Base64.decode64(credit_card.payment_cryptogram)
+          xml.tag!("XID", Base64.encode64(cryptogram[20...40]))
+          xml.tag!("CAVV", Base64.encode64(cryptogram[0...20]))
+        end
+      end
+
       def add_card_authentication_data(xml, options)
         xml.tag! "CAVV", options[:cavv]
         xml.tag! "XID", options[:xid]
@@ -277,7 +317,8 @@ module ActiveMerchant #:nodoc:
           :test => test?,
           :authorization => successful?(response) ? response_authorization(action, response, credit_card) : '',
           :avs_result => {:code => response[:avs]},
-          :cvv_result => response[:cvv2]
+          :cvv_result => response[:cvv2],
+          :error_code => standard_error_code(response)
         )
       end
 
@@ -341,10 +382,15 @@ module ActiveMerchant #:nodoc:
         {
           :transaction_approved => "false",
           :error_number => error.code,
-          :error_description => error.body
+          :error_description => error.body,
+          :ecommerce_error_code => error.body.gsub(/[^\d]/, '')
         }
       end
 
+      def standard_error_code(response)
+        STANDARD_ERROR_CODE_MAPPING[response[:bank_resp_code] || response[:ecommerce_error_code]]
+      end
+
       def parse(xml)
         response = {}
         xml = REXML::Document.new(xml)

data/lib/active_merchant/billing/gateways/inspire.rb

@@ -62,6 +62,12 @@ module ActiveMerchant #:nodoc:
         commit('void', nil, post)
       end
 
+      def refund(money, authorization, options = {})
+        post = {}
+        post[:transactionid] = authorization
+        commit('refund', money, post)
+      end
+
       # Update the values (such as CC expiration) stored at
       # InspireGateway.  The CC number must be supplied in the
       # CreditCard object.
@@ -157,7 +163,7 @@ module ActiveMerchant #:nodoc:
       def parse(body)
         results = {}
         body.split(/&/).each do |pair|
-          key,val = pair.split(/=/)
+          key,val = pair.split(%r{=})
           results[key] = val
         end
 

data/lib/active_merchant/billing/gateways/iridium.rb

@@ -366,7 +366,7 @@ module ActiveMerchant #:nodoc:
       def commit(request, options)
         requires!(options, :action)
         response = parse(ssl_post(test? ? self.test_url : self.live_url, request,
-                              {"SOAPAction" => "https://www.thepaymentgateway.net/#{options[:action]}",
+                              {"SOAPAction" => "https://www.thepaymentgateway.net/" + options[:action],
                                "Content-Type" => "text/xml; charset=utf-8" }))
 
         success = response[:transaction_result][:status_code] == "0"

data/lib/active_merchant/billing/gateways/merchant_warrior.rb

@@ -42,7 +42,7 @@ module ActiveMerchant #:nodoc:
         commit('processCard', post)
       end
 
-      def capture(money, identification)
+      def capture(money, identification, options = {})
         post = {}
         add_amount(post, money, options)
         add_transaction(post, identification)
@@ -50,7 +50,7 @@ module ActiveMerchant #:nodoc:
         commit('processCapture', post)
       end
 
-      def refund(money, identification)
+      def refund(money, identification, options = {})
         post = {}
         add_amount(post, money, options)
         add_transaction(post, identification)

data/lib/active_merchant/billing/gateways/monei.rb

@@ -0,0 +1,307 @@
+require 'nokogiri'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    #
+    # == Monei gateway
+    # This class implements Monei gateway for Active Merchant. For more information about Monei
+    # gateway please go to http://www.monei.net
+    #
+    # === Setup
+    # In order to set-up the gateway you need four paramaters: sender_id, channel_id, login and pwd.
+    # Request that data to Monei.
+    class MoneiGateway < Gateway
+      self.test_url = 'https://test.monei-api.net/payment/ctpe'
+      self.live_url = 'https://monei-api.net/payment/ctpe'
+
+      self.supported_countries = ['ES']
+      self.default_currency = 'EUR'
+      self.supported_cardtypes = [:visa, :master, :maestro, :jcb, :american_express]
+
+      self.homepage_url = 'http://www.monei.net/'
+      self.display_name = 'Monei'
+
+      # Constructor
+      #
+      # options - Hash containing the gateway credentials, ALL MANDATORY
+      #           :sender_id  Sender ID
+      #           :channel_id Channel ID
+      #           :login      User login
+      #           :pwd        User password
+      #
+      def initialize(options={})
+        requires!(options, :sender_id, :channel_id, :login, :pwd)
+        super
+      end
+
+      # Public: Performs purchase operation
+      #
+      # money       - Amount of purchase
+      # credit_card - Credit card
+      # options     - Hash containing purchase options
+      #               :order_id         Merchant created id for the purchase
+      #               :billing_address  Hash with billing address information
+      #               :description      Merchant created purchase description (optional)
+      #               :currency         Sale currency to override money object or default (optional)
+      #
+      # Returns Active Merchant response object
+      def purchase(money, credit_card, options)
+        execute_new_order(:purchase, money, credit_card, options)
+      end
+
+      # Public: Performs authorization operation
+      #
+      # money       - Amount to authorize
+      # credit_card - Credit card
+      # options     - Hash containing authorization options
+      #               :order_id         Merchant created id for the authorization
+      #               :billing_address  Hash with billing address information
+      #               :description      Merchant created authorization description (optional)
+      #               :currency         Sale currency to override money object or default (optional)
+      #
+      # Returns Active Merchant response object
+      def authorize(money, credit_card, options={})
+        execute_new_order(:authorize, money, credit_card, options)
+      end
+
+      # Public: Performs capture operation on previous authorization
+      #
+      # money         - Amount to capture
+      # authorization - Reference to previous authorization, obtained from response object returned by authorize
+      # options       - Hash containing capture options
+      #                 :order_id         Merchant created id for the authorization (optional)
+      #                 :description      Merchant created authorization description (optional)
+      #                 :currency         Sale currency to override money object or default (optional)
+      #
+      # Note: you should pass either order_id or description
+      #
+      # Returns Active Merchant response object
+      def capture(money, authorization, options={})
+        execute_dependant(:capture, money, authorization, options)
+      end
+
+      # Public: Refunds from previous purchase
+      #
+      # money         - Amount to refund
+      # authorization - Reference to previous purchase, obtained from response object returned by purchase
+      # options       - Hash containing refund options
+      #                 :order_id         Merchant created id for the authorization (optional)
+      #                 :description      Merchant created authorization description (optional)
+      #                 :currency         Sale currency to override money object or default (optional)
+      #
+      # Note: you should pass either order_id or description
+      #
+      # Returns Active Merchant response object
+      def refund(money, authorization, options={})
+        execute_dependant(:refund, money, authorization, options)
+      end
+
+      # Public: Voids previous authorization
+      #
+      # authorization - Reference to previous authorization, obtained from response object returned by authorize
+      # options       - Hash containing capture options
+      #                 :order_id         Merchant created id for the authorization (optional)
+      #
+      # Returns Active Merchant response object
+      def void(authorization, options={})
+        execute_dependant(:void, nil, authorization, options)
+      end
+
+      # Public: Verifies credit card. Does this by doing a authorization of 1.00 Euro and then voiding it.
+      #
+      # credit_card - Credit card
+      # options     - Hash containing authorization options
+      #               :order_id         Merchant created id for the authorization
+      #               :billing_address  Hash with billing address information
+      #               :description      Merchant created authorization description (optional)
+      #               :currency         Sale currency to override money object or default (optional)
+      #
+      # Returns Active Merchant response object of Authorization operation
+      def verify(credit_card, options={})
+        MultiResponse.run(:use_first_response) do |r|
+          r.process { authorize(100, credit_card, options) }
+          r.process(:ignore_result) { void(r.authorization, options) }
+        end
+      end
+
+      private
+
+      # Private: Execute purchase or authorize operation
+      def execute_new_order(action, money, credit_card, options)
+        request = build_request do |xml|
+          add_identification_new_order(xml, options)
+          add_payment(xml, action, money, options)
+          add_account(xml, credit_card)
+          add_customer(xml, credit_card, options)
+        end
+
+        commit(request)
+      end
+
+      # Private: Execute operation that depends on athorization code from previous purchase or authorize operation
+      def execute_dependant(action, money, authorization, options)
+        request = build_request do |xml|
+          add_identification_authorization(xml, authorization, options)
+          add_payment(xml, action, money, options)
+        end
+
+        commit(request)
+      end
+
+      # Private: Build XML wrapping code yielding to code to fill the transaction information
+      def build_request
+        builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+          xml.Request(:version => "1.0") do
+            xml.Header { xml.Security(:sender => @options[:sender_id]) }
+            xml.Transaction(:mode => test? ? 'CONNECTOR_TEST' : 'LIVE', :response => 'SYNC', :channel => @options[:channel_id]) do
+              xml.User(:login => @options[:login], :pwd => @options[:pwd])
+              yield xml
+            end
+          end
+        end
+        builder.to_xml
+      end
+
+      # Private: Add identification part to XML for new orders
+      def add_identification_new_order(xml, options)
+        requires!(options, :order_id)
+        xml.Identification do
+          xml.TransactionID options[:order_id]
+        end
+      end
+
+      # Private: Add identification part to XML for orders that depend on authorization from previous operation
+      def add_identification_authorization(xml, authorization, options)
+        xml.Identification do
+          xml.ReferenceID authorization
+          xml.TransactionID options[:order_id]
+        end
+      end
+
+      # Private: Add payment part to XML
+      def add_payment(xml, action, money, options)
+        code = tanslate_payment_code(action)
+
+        xml.Payment(:code => code) do
+          xml.Presentation do
+            xml.Amount amount(money)
+            xml.Currency options[:currency] || currency(money)
+            xml.Usage options[:description] || options[:order_id]
+          end unless money.nil?
+        end
+      end
+
+      # Private: Add account part to XML
+      def add_account(xml, credit_card)
+        xml.Account do
+          xml.Holder credit_card.name
+          xml.Number credit_card.number
+          xml.Brand credit_card.brand.upcase
+          xml.Expiry(:month => credit_card.month, :year => credit_card.year)
+          xml.Verification credit_card.verification_value
+        end
+      end
+
+      # Private: Add customer part to XML
+      def add_customer(xml, credit_card, options)
+        requires!(options, :billing_address)
+        address = options[:billing_address]
+        xml.Customer do
+          xml.Name do
+            xml.Given credit_card.first_name
+            xml.Family credit_card.last_name
+          end
+          xml.Address do
+            xml.Street address[:address1].to_s
+            xml.Zip address[:zip].to_s
+            xml.City address[:city].to_s
+            xml.State address[:state].to_s if address.has_key? :state
+            xml.Country address[:country].to_s
+          end
+          xml.Contact do
+            xml.Email options[:email] || 'noemail@monei.net'
+            xml.Ip options[:ip] || '0.0.0.0'
+          end
+        end
+      end
+
+      # Private: Parse XML response from Monei servers
+      def parse(body)
+        xml = Nokogiri::XML(body)
+        {
+            :unique_id => xml.xpath("//Response/Transaction/Identification/UniqueID").text,
+            :status => translate_status_code(xml.xpath("//Response/Transaction/Processing/Status/@code").text),
+            :reason => translate_status_code(xml.xpath("//Response/Transaction/Processing/Reason/@code").text),
+            :message => xml.xpath("//Response/Transaction/Processing/Return").text
+        }
+      end
+
+      # Private: Send XML transaction to Monei servers and create AM response
+      def commit(xml)
+        url = (test? ? test_url : live_url)
+
+        response = parse(ssl_post(url, post_data(xml), 'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8'))
+
+        Response.new(
+          success_from(response),
+          message_from(response),
+          response,
+          authorization: authorization_from(response),
+          test: test?,
+          error_code: error_code_from(response)
+        )
+      end
+
+      # Private: Decide success from servers response
+      def success_from(response)
+        response[:status] == :success || response[:status] == :new
+      end
+
+      # Private: Get message from servers response
+      def message_from(response)
+        response[:message]
+      end
+
+      # Private: Get error code from servers response
+      def error_code_from(response)
+        success_from(response) ? nil : STANDARD_ERROR_CODE[:card_declined]
+      end
+
+      # Private: Get authorization code from servers response
+      def authorization_from(response)
+        response[:unique_id]
+      end
+
+      # Private: Encode POST parameters
+      def post_data(xml)
+        "load=#{CGI.escape(xml)}"
+      end
+
+      # Private: Translate Monei status code to native ruby symbols
+      def translate_status_code(code)
+        {
+            '00' => :success,
+            '40' => :neutral,
+            '59' => :waiting_bank,
+            '60' => :rejected_bank,
+            '64' => :waiting_risk,
+            '65' => :rejected_risk,
+            '70' => :rejected_validation,
+            '80' => :waiting,
+            '90' => :new
+        }[code]
+      end
+
+      # Private: Translate AM operations to Monei operations codes
+      def tanslate_payment_code(action)
+        {
+            :purchase => 'CC.DB',
+            :authorize => 'CC.PA',
+            :capture => 'CC.CP',
+            :refund => 'CC.RF',
+            :void => 'CC.RV'
+        }[action]
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/gateways/nab_transact.rb

@@ -35,7 +35,6 @@ module ActiveMerchant #:nodoc:
 
       PERIODIC_TYPES = {
         :addcrn    => 5,
-        :editcrn   => 5,
         :deletecrn => 5,
         :trigger   => 8
       }
@@ -50,12 +49,9 @@ module ActiveMerchant #:nodoc:
 
       def purchase(money, credit_card_or_stored_id, options = {})
         if credit_card_or_stored_id.respond_to?(:number)
-          #Credit card for instant payment
           commit :purchase, build_purchase_request(money, credit_card_or_stored_id, options)
         else
-          #Triggered payment for an existing stored credit card
-          options[:billing_id] = credit_card_or_stored_id.to_s
-          commit_periodic build_periodic_item(:trigger, money, nil, options)
+          commit_periodic(:trigger, build_purchase_using_stored_card_request(money, credit_card_or_stored_id, options))
         end
       end
 
@@ -75,14 +71,12 @@ module ActiveMerchant #:nodoc:
         commit :capture, build_reference_request(money, authorization, options)
       end
 
-      def store(creditcard, options = {})
-        requires!(options, :billing_id, :amount)
-        commit_periodic(build_periodic_item(:addcrn, options[:amount], creditcard, options))
+      def store(credit_card, options = {})
+        commit_periodic(:addcrn, build_store_request(credit_card, options))
       end
 
       def unstore(identification, options = {})
-        options[:billing_id] = identification
-        commit_periodic(build_periodic_item(:deletecrn, options[:amount], nil, options))
+        commit_periodic(:deletecrn, build_unstore_request(identification, options))
       end
 
       private
@@ -163,27 +157,7 @@ module ActiveMerchant #:nodoc:
         xml.target!
       end
 
-      def build_periodic_item(action, money, credit_card, options)
-        xml = Builder::XmlMarkup.new
-
-        xml.tag! 'actionType', action.to_s
-        xml.tag! 'periodicType', PERIODIC_TYPES[action] if PERIODIC_TYPES[action]
-        xml.tag! 'currency', options[:currency] || currency(money)
-        xml.tag! 'crn', options[:billing_id]
-
-        if credit_card
-          xml.tag! 'CreditCardInfo' do
-            xml.tag! 'cardNumber', credit_card.number
-            xml.tag! 'expiryDate', expdate(credit_card)
-            xml.tag! 'cvv', credit_card.verification_value if credit_card.verification_value?
-          end
-        end
-        xml.tag! 'amount', amount(money)
-
-        xml.target!
-      end
-
-      def build_periodic_request(body)
+      def build_periodic_request(action, body)
         xml = Builder::XmlMarkup.new
         xml.instruct!
         xml.tag! 'NABTransactMessage' do
@@ -203,6 +177,8 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'Periodic' do
             xml.tag! 'PeriodicList', "count" => 1 do
               xml.tag! 'PeriodicItem', "ID" => 1 do
+                xml.tag! 'actionType', action.to_s
+                xml.tag! 'periodicType', PERIODIC_TYPES[action] if PERIODIC_TYPES[action]
                 xml << body
               end
             end
@@ -212,20 +188,50 @@ module ActiveMerchant #:nodoc:
         xml.target!
       end
 
+      def build_purchase_using_stored_card_request(money, identification, options)
+        xml = Builder::XmlMarkup.new
+
+        xml.tag! 'crn', identification
+        xml.tag! 'currency', options[:currency] || currency(money)
+        xml.tag! 'amount', amount(money)
+
+        xml.target!
+      end
+
+      def build_store_request(credit_card, options)
+        xml = Builder::XmlMarkup.new
+
+        xml.tag! 'crn', options[:billing_id] || SecureRandom.hex(10)
+        xml.tag! 'CreditCardInfo' do
+          xml.tag! 'cardNumber', credit_card.number
+          xml.tag! 'expiryDate', expdate(credit_card)
+          xml.tag! 'cvv', credit_card.verification_value if credit_card.verification_value?
+        end
+
+        xml.target!
+      end
+
+      def build_unstore_request(identification, options)
+        xml = Builder::XmlMarkup.new
+
+        xml.tag! 'crn', identification
+        xml.target!
+      end
+
       def commit(action, request)
         response = parse(ssl_post(test? ? self.test_url : self.live_url, build_request(action, request)))
 
         Response.new(success?(response), message_from(response), response,
           :test => test?,
-          :authorization => authorization_from(response)
+          :authorization => authorization_from(action, response)
         )
       end
 
-      def commit_periodic(request)
-        response = parse(ssl_post(test? ? self.test_periodic_url : self.live_periodic_url, build_periodic_request(request)))
+      def commit_periodic(action, request)
+        response = parse(ssl_post(test? ? self.test_periodic_url : self.live_periodic_url, build_periodic_request(action, request)))
         Response.new(success?(response), message_from(response), response,
           :test => test?,
-          :authorization => authorization_from(response)
+          :authorization => authorization_from(action, response)
         )
       end
 
@@ -233,8 +239,12 @@ module ActiveMerchant #:nodoc:
         SUCCESS_CODES.include?(response[:response_code])
       end
 
-      def authorization_from(response)
-        [response[:txn_id], response[:purchase_order_no], response[:preauth_id], response[:amount]].join('*')
+      def authorization_from(action, response)
+        if action == :addcrn
+          response[:crn]
+        else
+          [response[:txn_id], response[:purchase_order_no], response[:preauth_id], response[:amount]].join('*')
+        end
       end
 
       def message_from(response)