activemerchant 1.130.0 → 1.137.0

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

@@ -43,12 +43,7 @@ module ActiveMerchant #:nodoc:
           xml.ssl_transaction_type  self.actions[:purchase]
           xml.ssl_amount            amount(money)
 
-          if payment_method.is_a?(String)
-            add_token(xml, payment_method)
-          else
-            add_creditcard(xml, payment_method)
-          end
-
+          add_payment(xml, payment_method, options)
           add_invoice(xml, options)
           add_salestax(xml, options)
           add_currency(xml, money, options)
@@ -56,27 +51,26 @@ module ActiveMerchant #:nodoc:
           add_customer_email(xml, options)
           add_test_mode(xml, options)
           add_ip(xml, options)
-          add_auth_purchase_params(xml, options)
+          add_auth_purchase_params(xml, payment_method, options)
           add_level_3_fields(xml, options) if options[:level_3_data]
         end
         commit(request)
       end
 
-      def authorize(money, creditcard, options = {})
+      def authorize(money, payment_method, options = {})
         request = build_xml_request do |xml|
           xml.ssl_vendor_id         @options[:ssl_vendor_id] || options[:ssl_vendor_id]
           xml.ssl_transaction_type  self.actions[:authorize]
           xml.ssl_amount            amount(money)
-
           add_salestax(xml, options)
           add_invoice(xml, options)
-          add_creditcard(xml, creditcard)
+          add_payment(xml, payment_method, options)
           add_currency(xml, money, options)
           add_address(xml, options)
           add_customer_email(xml, options)
           add_test_mode(xml, options)
           add_ip(xml, options)
-          add_auth_purchase_params(xml, options)
+          add_auth_purchase_params(xml, payment_method, options)
           add_level_3_fields(xml, options) if options[:level_3_data]
         end
         commit(request)
@@ -92,7 +86,7 @@ module ActiveMerchant #:nodoc:
             add_salestax(xml, options)
             add_approval_code(xml, authorization)
             add_invoice(xml, options)
-            add_creditcard(xml, options[:credit_card])
+            add_creditcard(xml, options[:credit_card], options)
             add_currency(xml, money, options)
             add_address(xml, options)
             add_customer_email(xml, options)
@@ -139,7 +133,7 @@ module ActiveMerchant #:nodoc:
           xml.ssl_transaction_type  self.actions[:credit]
           xml.ssl_amount            amount(money)
           add_invoice(xml, options)
-          add_creditcard(xml, creditcard)
+          add_creditcard(xml, creditcard, options)
           add_currency(xml, money, options)
           add_address(xml, options)
           add_customer_email(xml, options)
@@ -152,7 +146,7 @@ module ActiveMerchant #:nodoc:
         request = build_xml_request do |xml|
           xml.ssl_vendor_id         @options[:ssl_vendor_id] || options[:ssl_vendor_id]
           xml.ssl_transaction_type  self.actions[:verify]
-          add_creditcard(xml, credit_card)
+          add_creditcard(xml, credit_card, options)
           add_address(xml, options)
           add_test_mode(xml, options)
           add_ip(xml, options)
@@ -165,7 +159,7 @@ module ActiveMerchant #:nodoc:
           xml.ssl_vendor_id         @options[:ssl_vendor_id] || options[:ssl_vendor_id]
           xml.ssl_transaction_type  self.actions[:store]
           xml.ssl_add_token 'Y'
-          add_creditcard(xml, creditcard)
+          add_creditcard(xml, creditcard, options)
           add_address(xml, options)
           add_customer_email(xml, options)
           add_test_mode(xml, options)
@@ -178,8 +172,8 @@ module ActiveMerchant #:nodoc:
         request = build_xml_request do |xml|
           xml.ssl_vendor_id         @options[:ssl_vendor_id] || options[:ssl_vendor_id]
           xml.ssl_transaction_type  self.actions[:update]
-          add_token(xml, token)
-          add_creditcard(xml, creditcard)
+          xml.ssl_token token
+          add_creditcard(xml, creditcard, options)
           add_address(xml, options)
           add_customer_email(xml, options)
           add_test_mode(xml, options)
@@ -200,6 +194,16 @@ module ActiveMerchant #:nodoc:
 
       private
 
+      def add_payment(xml, payment, options)
+        if payment.is_a?(String) || options[:ssl_token]
+          xml.ssl_token options[:ssl_token] || payment
+        elsif payment.is_a?(NetworkTokenizationCreditCard)
+          add_network_token(xml, payment)
+        else
+          add_creditcard(xml, payment, options)
+        end
+      end
+
       def add_invoice(xml, options)
         xml.ssl_invoice_number    url_encode_truncate((options[:order_id] || options[:invoice]), 25)
         xml.ssl_description       url_encode_truncate(options[:description], 255)
@@ -213,11 +217,21 @@ module ActiveMerchant #:nodoc:
         xml.ssl_txn_id authorization.split(';').last
       end
 
-      def add_creditcard(xml, creditcard)
+      def add_network_token(xml, payment_method)
+        payment = payment_method.payment_data&.gsub('=>', ':')
+        case payment_method.source
+        when :apple_pay
+          xml.ssl_applepay_web url_encode(payment)
+        when :google_pay
+          xml.ssl_google_pay url_encode(payment)
+        end
+      end
+
+      def add_creditcard(xml, creditcard, options)
         xml.ssl_card_number   creditcard.number
         xml.ssl_exp_date      expdate(creditcard)
 
-        add_verification_value(xml, creditcard) if creditcard.verification_value?
+        add_verification_value(xml, creditcard, options)
 
         xml.ssl_first_name    url_encode_truncate(creditcard.first_name, 20)
         xml.ssl_last_name     url_encode_truncate(creditcard.last_name, 30)
@@ -230,12 +244,12 @@ module ActiveMerchant #:nodoc:
         xml.ssl_transaction_currency currency
       end
 
-      def add_token(xml, token)
-        xml.ssl_token token
-      end
+      def add_verification_value(xml, credit_card, options)
+        return unless credit_card.verification_value?
+        # Don't add cvv if this is a non-initial stored credential transaction
+        return if options[:stored_credential] && !options.dig(:stored_credential, :initial_transaction) && options[:stored_cred_v2]
 
-      def add_verification_value(xml, creditcard)
-        xml.ssl_cvv2cvc2            creditcard.verification_value
+        xml.ssl_cvv2cvc2            credit_card.verification_value
         xml.ssl_cvv2cvc2_indicator  1
       end
 
@@ -294,16 +308,20 @@ module ActiveMerchant #:nodoc:
       end
 
       # add_recurring_token is a field that can be sent in to obtain a token from Elavon for use with their tokenization program
-      def add_auth_purchase_params(xml, options)
+      def add_auth_purchase_params(xml, payment_method, options)
         xml.ssl_dynamic_dba                     options[:dba] if options.has_key?(:dba)
         xml.ssl_merchant_initiated_unscheduled  merchant_initiated_unscheduled(options) if merchant_initiated_unscheduled(options)
         xml.ssl_add_token                       options[:add_recurring_token] if options.has_key?(:add_recurring_token)
-        xml.ssl_token                           options[:ssl_token] if options[:ssl_token]
         xml.ssl_customer_code                   options[:customer] if options.has_key?(:customer)
         xml.ssl_customer_number                 options[:customer_number] if options.has_key?(:customer_number)
-        xml.ssl_entry_mode                      entry_mode(options) if entry_mode(options)
+        xml.ssl_entry_mode                      entry_mode(payment_method, options) if entry_mode(payment_method, options)
         add_custom_fields(xml, options) if options[:custom_fields]
-        add_stored_credential(xml, options) if options[:stored_credential]
+        if options[:stored_cred_v2]
+          add_stored_credential_v2(xml, payment_method, options)
+          add_installment_fields(xml, options)
+        else
+          add_stored_credential(xml, options)
+        end
       end
 
       def add_custom_fields(xml, options)
@@ -353,6 +371,8 @@ module ActiveMerchant #:nodoc:
       end
 
       def add_stored_credential(xml, options)
+        return unless options[:stored_credential]
+
         network_transaction_id = options.dig(:stored_credential, :network_transaction_id)
         case
         when network_transaction_id.nil?
@@ -368,14 +388,60 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def add_stored_credential_v2(xml, payment_method, options)
+        return unless options[:stored_credential]
+
+        network_transaction_id = options.dig(:stored_credential, :network_transaction_id)
+        xml.ssl_recurring_flag recurring_flag(options) if recurring_flag(options)
+        xml.ssl_par_value options[:par_value] if options[:par_value]
+        xml.ssl_association_token_data options[:association_token_data] if options[:association_token_data]
+
+        unless payment_method.is_a?(String) || options[:ssl_token].present?
+          xml.ssl_approval_code options[:approval_code] if options[:approval_code]
+          if network_transaction_id.to_s.include?('|')
+            oar_data, ps2000_data = network_transaction_id.split('|')
+            xml.ssl_oar_data oar_data unless oar_data.blank?
+            xml.ssl_ps2000_data ps2000_data unless ps2000_data.blank?
+          elsif network_transaction_id.to_s.length > 22
+            xml.ssl_oar_data network_transaction_id
+          elsif network_transaction_id.present?
+            xml.ssl_ps2000_data network_transaction_id
+          end
+        end
+      end
+
+      def recurring_flag(options)
+        return unless reason = options.dig(:stored_credential, :reason_type)
+        return 1 if reason == 'recurring'
+        return 2 if reason == 'installment'
+      end
+
       def merchant_initiated_unscheduled(options)
         return options[:merchant_initiated_unscheduled] if options[:merchant_initiated_unscheduled]
-        return 'Y' if options.dig(:stored_credential, :initiator) == 'merchant' && options.dig(:stored_credential, :reason_type) == 'unscheduled' || options.dig(:stored_credential, :reason_type) == 'recurring'
+        return 'Y' if options.dig(:stored_credential, :initiator) == 'merchant' && merchant_reason_type(options)
+      end
+
+      def merchant_reason_type(options)
+        if options[:stored_cred_v2]
+          options.dig(:stored_credential, :reason_type) == 'unscheduled'
+        else
+          options.dig(:stored_credential, :reason_type) == 'unscheduled' || options.dig(:stored_credential, :reason_type) == 'recurring'
+        end
+      end
+
+      def add_installment_fields(xml, options)
+        return unless options.dig(:stored_credential, :reason_type) == 'installment'
+
+        xml.ssl_payment_number options[:payment_number]
+        xml.ssl_payment_count options[:installments]
       end
 
-      def entry_mode(options)
+      def entry_mode(payment_method, options)
         return options[:entry_mode] if options[:entry_mode]
-        return 12 if options[:stored_credential]
+        return 12 if options[:stored_credential] && options[:stored_cred_v2] != true
+
+        return if payment_method.is_a?(String) || options[:ssl_token]
+        return 12 if options.dig(:stored_credential, :reason_type) == 'unscheduled'
       end
 
       def build_xml_request
@@ -451,8 +517,8 @@ module ActiveMerchant #:nodoc:
         if value.is_a?(String)
           encoded = CGI.escape(value)
           encoded = encoded.tr('+', ' ') # don't encode spaces
-          encoded = encoded.gsub('%26', '%26amp;') # account for Elavon's weird '&' handling
-          encoded
+          encoded.gsub('%26', '%26amp;') # account for Elavon's weird '&' handling
+
         else
           value.to_s
         end

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

@@ -37,6 +37,7 @@ module ActiveMerchant #:nodoc:
             add_transaction(xml, money, options)
             add_terminal(xml, options)
             add_address(xml, options)
+            add_lodging(xml, options)
           end
         end
 
@@ -51,6 +52,7 @@ module ActiveMerchant #:nodoc:
             add_transaction(xml, money, options)
             add_terminal(xml, options)
             add_address(xml, options)
+            add_lodging(xml, options)
           end
         end
 
@@ -222,16 +224,44 @@ module ActiveMerchant #:nodoc:
         options[:market_code] || 'Default'
       end
 
+      def add_lodging(xml, options)
+        if lodging = options[:lodging]
+          xml.extendedParameters do
+            xml.ExtendedParameters do
+              xml.Key 'Lodging'
+              xml.Value('xsi:type' => 'Lodging') do
+                xml.LodgingAgreementNumber lodging[:agreement_number] if lodging[:agreement_number]
+                xml.LodgingCheckInDate lodging[:check_in_date] if lodging[:check_in_date]
+                xml.LodgingCheckOutDate lodging[:check_out_date] if lodging[:check_out_date]
+                xml.LodgingRoomAmount lodging[:room_amount] if lodging[:room_amount]
+                xml.LodgingRoomTax lodging[:room_tax] if lodging[:room_tax]
+                xml.LodgingNoShowIndicator lodging[:no_show_indicator] if lodging[:no_show_indicator]
+                xml.LodgingDuration lodging[:duration] if lodging[:duration]
+                xml.LodgingCustomerName lodging[:customer_name] if lodging[:customer_name]
+                xml.LodgingClientCode lodging[:client_code] if lodging[:client_code]
+                xml.LodgingExtraChargesDetail lodging[:extra_charges_detail] if lodging[:extra_charges_detail]
+                xml.LodgingExtraChargesAmounts lodging[:extra_charges_amounts] if lodging[:extra_charges_amounts]
+                xml.LodgingPrestigiousPropertyCode lodging[:prestigious_property_code] if lodging[:prestigious_property_code]
+                xml.LodgingSpecialProgramCode lodging[:special_program_code] if lodging[:special_program_code]
+                xml.LodgingChargeType lodging[:charge_type] if lodging[:charge_type]
+              end
+            end
+          end
+        end
+      end
+
       def add_terminal(xml, options)
         xml.terminal do
           xml.TerminalID options[:terminal_id] || '01'
+          xml.TerminalType options[:terminal_type] if options[:terminal_type]
           xml.CardPresentCode options[:card_present_code] || 'UseDefault'
-          xml.CardholderPresentCode 'UseDefault'
-          xml.CardInputCode 'UseDefault'
-          xml.CVVPresenceCode 'UseDefault'
-          xml.TerminalCapabilityCode 'UseDefault'
-          xml.TerminalEnvironmentCode 'UseDefault'
+          xml.CardholderPresentCode options[:card_holder_present_code] || 'UseDefault'
+          xml.CardInputCode options[:card_input_code] || 'UseDefault'
+          xml.CVVPresenceCode options[:cvv_presence_code] || 'UseDefault'
+          xml.TerminalCapabilityCode options[:terminal_capability_code] || 'UseDefault'
+          xml.TerminalEnvironmentCode options[:terminal_environment_code] || 'UseDefault'
           xml.MotoECICode 'NonAuthenticatedSecureECommerceTransaction'
+          xml.PartialApprovedFlag options[:partial_approved_flag] if options[:partial_approved_flag]
         end
       end
 
@@ -240,7 +270,7 @@ module ActiveMerchant #:nodoc:
           xml.CardNumber payment.number
           xml.ExpirationMonth format(payment.month, :two_digits)
           xml.ExpirationYear format(payment.year, :two_digits)
-          xml.CardholderName payment.first_name + ' ' + payment.last_name
+          xml.CardholderName "#{payment.first_name} #{payment.last_name}"
           xml.CVV payment.verification_value
         end
       end
@@ -363,7 +393,6 @@ module ActiveMerchant #:nodoc:
           xml['soap'].Envelope('xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
                                'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
                                'xmlns:soap' => 'http://schemas.xmlsoap.org/soap/envelope/') do
-
             xml['soap'].Body do
               yield(xml)
             end

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

@@ -174,17 +174,21 @@ module ActiveMerchant #:nodoc:
         response = send("do_#{action}", params)
 
         if action == :authorize
-          Response.new response['accept'].to_i == 1,
+          Response.new(
+            response['accept'].to_i == 1,
             response['errortext'],
             response,
             test: test?,
             authorization: response['tid']
+          )
         else
-          Response.new response['result'] == 'true',
+          Response.new(
+            response['result'] == 'true',
             messages(response['epay'], response['pbs']),
             response,
             test: test?,
             authorization: params[:transaction]
+          )
         end
       end
 

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

@@ -279,11 +279,15 @@ module ActiveMerchant #:nodoc:
         response = parse(data)
         message = message_from(response)
 
-        Response.new(success?(response), message, response,
+        Response.new(
+          success?(response),
+          message,
+          response,
           test: test?,
           authorization: response['transactionid'],
           avs_result: { code: response['avsresponse'] },
-          cvv_result: response['cvvresponse'])
+          cvv_result: response['cvvresponse']
+        )
       end
 
       def message_from(response)

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

@@ -111,11 +111,13 @@ module ActiveMerchant #:nodoc:
         raw_response = ssl_post(url, post_data(parameters))
         response = parse(raw_response)
 
-        Response.new(success?(response),
+        Response.new(
+          success?(response),
           message_from(response[:ewaytrxnerror]),
           response,
           authorization: response[:ewaytrxnnumber],
-          test: test?)
+          test: test?
+        )
       end
 
       def success?(response)

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

@@ -222,9 +222,13 @@ module ActiveMerchant #:nodoc:
           end
         response = parse(raw)
 
-        EwayResponse.new(response[:success], response[:message], response,
+        EwayResponse.new(
+          response[:success],
+          response[:message],
+          response,
           test: test?,
-          authorization: response[:auth_code])
+          authorization: response[:auth_code]
+        )
       end
 
       # Where we build the full SOAP 1.2 request using builder

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

@@ -158,11 +158,15 @@ module ActiveMerchant #:nodoc:
       def commit(action, request)
         response = parse(ssl_post(self.live_url, build_request(action, request), POST_HEADERS))
 
-        Response.new(successful?(response), message_from(response), response,
+        Response.new(
+          successful?(response),
+          message_from(response),
+          response,
           test: test?,
           authorization: authorization_from(response),
           avs_result: { code: response[:avs] },
-          cvv_result: response[:cvv2])
+          cvv_result: response[:cvv2]
+        )
       rescue ResponseError => e
         case e.response.code
         when '401'

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

@@ -28,6 +28,7 @@ module ActiveMerchant #:nodoc:
         add_order_id(post, options)
         add_ip(post, options)
         add_metadata(post, options)
+        add_three_ds(post, options)
 
         commit(:post, 'purchases', post)
       end
@@ -41,6 +42,7 @@ module ActiveMerchant #:nodoc:
         add_order_id(post, options)
         add_ip(post, options)
         add_metadata(post, options)
+        add_three_ds(post, options)
 
         post[:capture] = false
 
@@ -125,16 +127,42 @@ module ActiveMerchant #:nodoc:
       def add_extra_options(post, options)
         extra = {}
         extra[:ecm] = '32' if options[:recurring]
-        extra[:cavv] = options[:cavv] || options.dig(:three_d_secure, :cavv) if options[:cavv] || options.dig(:three_d_secure, :cavv)
-        extra[:xid] = options[:xid] || options.dig(:three_d_secure, :xid) if options[:xid] || options.dig(:three_d_secure, :xid)
-        extra[:sli] = options[:sli] || options.dig(:three_d_secure, :eci) if options[:sli] || options.dig(:three_d_secure, :eci)
         extra[:name] = options[:merchant] if options[:merchant]
         extra[:location] = options[:merchant_location] if options[:merchant_location]
         extra[:card_on_file] = options.dig(:extra, :card_on_file) if options.dig(:extra, :card_on_file)
         extra[:auth_reason]  = options.dig(:extra, :auth_reason) if options.dig(:extra, :auth_reason)
+
+        unless options[:three_d_secure].present?
+          extra[:sli] = options[:sli] if options[:sli]
+          extra[:xid] = options[:xid] if options[:xid]
+          extra[:cavv] = options[:cavv] if options[:cavv]
+        end
+
         post[:extra] = extra if extra.any?
       end
 
+      def add_three_ds(post, options)
+        return unless three_d_secure = options[:three_d_secure]
+
+        post[:extra] = {
+          sli: three_d_secure[:eci],
+          xid: three_d_secure[:xid],
+          cavv: three_d_secure[:cavv],
+          par: three_d_secure[:authentication_response_status],
+          ver: formatted_enrollment(three_d_secure[:enrolled]),
+          threeds_version: three_d_secure[:version],
+          directory_server_txn_id: three_d_secure[:ds_transaction_id]
+        }.compact
+      end
+
+      def formatted_enrollment(val)
+        case val
+        when 'Y', 'N', 'U' then val
+        when true, 'true' then 'Y'
+        when false, 'false' then 'N'
+        end
+      end
+
       def add_order_id(post, options)
         post[:reference] = options[:order_id] || SecureRandom.hex(15)
       end

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

@@ -121,11 +121,15 @@ module ActiveMerchant #:nodoc:
         response = parse(data)
         message = message_from(response)
 
-        Response.new(success?(response), message, response,
+        Response.new(
+          success?(response),
+          message,
+          response,
           test: test?,
           authorization: response['transactionid'],
           avs_result: { code: response['avsresponse'] },
-          cvv_result: response['cvvresponse'])
+          cvv_result: response['cvvresponse']
+        )
       end
 
       def success?(response)

data/lib/active_merchant/billing/gateways/first_pay/first_pay_common.rb

@@ -0,0 +1,15 @@
+module FirstPayCommon
+  def self.included(base)
+    base.supported_countries = ['US']
+    base.default_currency = 'USD'
+    base.money_format = :dollars
+    base.supported_cardtypes = %i[visa master american_express discover]
+
+    base.homepage_url = 'http://1stpaygateway.net/'
+    base.display_name = '1stPayGateway.Net'
+  end
+
+  def supports_scrubbing?
+    true
+  end
+end