activemerchant 1.116.0 → 1.121.0

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

@@ -6,7 +6,7 @@ module ActiveMerchant #:nodoc:
 
       self.supported_countries = %w[AR BR CL CO MX PE UY TR]
       self.default_currency = 'USD'
-      self.supported_cardtypes = %i[visa master american_express discover jcb diners_club maestro naranja cabal]
+      self.supported_cardtypes = %i[visa master american_express discover jcb diners_club maestro naranja cabal elo alia carnet]
 
       self.homepage_url = 'https://dlocal.com/'
       self.display_name = 'dLocal'

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

@@ -170,6 +170,12 @@ module ActiveMerchant #:nodoc:
         card_data[:security_code] = credit_card.verification_value if credit_card.verification_value?
         card_data[:card_holder_name] = credit_card.name if credit_card.name
 
+        # the device_unique_id has to be sent in via the card data (as device_unique_identifier) no other fraud detection fields require this
+        if options[:fraud_detection].present?
+          card_data[:fraud_detection] = {} if (options[:fraud_detection][:device_unique_id]).present?
+          card_data[:fraud_detection][:device_unique_identifier] = (options[:fraud_detection][:device_unique_id]) if (options[:fraud_detection][:device_unique_id]).present?
+        end
+
         # additional data used for Visa transactions
         card_data[:card_holder_door_number] = options[:card_holder_door_number].to_i if options[:card_holder_door_number]
         card_data[:card_holder_birthday] = options[:card_holder_birthday] if options[:card_holder_birthday]
@@ -210,6 +216,14 @@ module ActiveMerchant #:nodoc:
           hsh[:channel] = options[:channel] if valid_fraud_detection_option?(options[:channel])
           hsh[:dispatch_method] = options[:dispatch_method] if valid_fraud_detection_option?(options[:dispatch_method])
           hsh[:csmdds] = options[:csmdds] if valid_fraud_detection_option?(options[:csmdds])
+          hsh[:device_unique_id] = options[:device_unique_id] if valid_fraud_detection_option?(options[:device_unique_id])
+          hsh[:bill_to] = options[:bill_to] if valid_fraud_detection_option?(options[:bill_to])
+          hsh[:purchase_totals] = options[:purchase_totals] if valid_fraud_detection_option?(options[:purchase_totals])
+          hsh[:customer_in_site] = options[:customer_in_site] if valid_fraud_detection_option?(options[:customer_in_site])
+          hsh[:retail_transaction_data] = options[:retail_transaction_data] if valid_fraud_detection_option?(options[:retail_transaction_data])
+          hsh[:ship_to] = options[:ship_to] if valid_fraud_detection_option?(options[:ship_to])
+          hsh[:tax_voucher_required] = options[:tax_voucher_required] if valid_fraud_detection_option?(options[:tax_voucher_required])
+          hsh[:copy_paste_card_data] = options[:copy_paste_card_data] if valid_fraud_detection_option?(options[:copy_paste_card_data])
         end
       end
 
@@ -287,15 +301,21 @@ module ActiveMerchant #:nodoc:
         error_code = nil
         if error = response.dig('status_details', 'error')
           code = error.dig('reason', 'id')
-          error_code = STANDARD_ERROR_CODE_MAPPING[code]
+          standard_error_code = STANDARD_ERROR_CODE_MAPPING[code]
+          error_code = "#{code}, #{standard_error_code}"
           error_code ||= error['type']
         elsif response['error_type']
           error_code = response['error_type'] if response['validation_errors']
-        elsif error = response.dig('error')
+        elsif response.dig('error', 'validation_errors')
+          error = response.dig('error')
           validation_errors = error.dig('validation_errors', 0)
           code = validation_errors['code'] if validation_errors && validation_errors['code']
           param = validation_errors['param'] if validation_errors && validation_errors['param']
           error_code = "#{error['error_type']} | #{code} | #{param}" if error['error_type']
+        elsif error = response.dig('error')
+          code = error.dig('reason', 'id')
+          standard_error_code = STANDARD_ERROR_CODE_MAPPING[code]
+          error_code = "#{code}, #{standard_error_code}"
         end
 
         error_code || STANDARD_ERROR_CODE[:processing_error]

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

@@ -39,6 +39,7 @@ module ActiveMerchant #:nodoc:
 
       def purchase(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[:purchase]
           xml.ssl_amount            amount(money)
 
@@ -63,6 +64,7 @@ module ActiveMerchant #:nodoc:
 
       def authorize(money, creditcard, 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)
 
@@ -82,6 +84,8 @@ module ActiveMerchant #:nodoc:
 
       def capture(money, authorization, options = {})
         request = build_xml_request do |xml|
+          xml.ssl_vendor_id         @options[:ssl_vendor_id] || options[:ssl_vendor_id]
+
           if options[:credit_card]
             xml.ssl_transaction_type self.actions[:capture]
             xml.ssl_amount amount(money)
@@ -107,6 +111,7 @@ module ActiveMerchant #:nodoc:
 
       def refund(money, identification, 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[:refund]
           xml.ssl_amount            amount(money)
           add_txn_id(xml, identification)
@@ -117,6 +122,7 @@ module ActiveMerchant #:nodoc:
 
       def void(identification, 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[:void]
 
           add_txn_id(xml, identification)
@@ -129,6 +135,7 @@ module ActiveMerchant #:nodoc:
         raise ArgumentError, 'Reference credits are not supported. Please supply the original credit card or use the #refund method.' if creditcard.is_a?(String)
 
         request = build_xml_request do |xml|
+          xml.ssl_vendor_id         @options[:ssl_vendor_id] || options[:ssl_vendor_id]
           xml.ssl_transaction_type  self.actions[:credit]
           xml.ssl_amount            amount(money)
           add_invoice(xml, options)
@@ -143,6 +150,7 @@ module ActiveMerchant #:nodoc:
 
       def verify(credit_card, 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[:verify]
           add_creditcard(xml, credit_card)
           add_address(xml, options)
@@ -154,6 +162,7 @@ module ActiveMerchant #:nodoc:
 
       def store(creditcard, 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[:store]
           xml.ssl_add_token 'Y'
           add_creditcard(xml, creditcard)
@@ -167,6 +176,7 @@ module ActiveMerchant #:nodoc:
 
       def update(token, creditcard, 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[:update]
           add_token(xml, token)
           add_creditcard(xml, creditcard)
@@ -285,10 +295,12 @@ module ActiveMerchant #:nodoc:
 
       def add_auth_purchase_params(xml, options)
         xml.ssl_dynamic_dba                     options[:dba] if options.has_key?(:dba)
-        xml.ssl_merchant_initiated_unscheduled  options[:merchant_initiated_unscheduled] if options.has_key?(:merchant_initiated_unscheduled)
+        xml.ssl_merchant_initiated_unscheduled  merchant_initiated_unscheduled(options) if merchant_initiated_unscheduled(options)
         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)
         add_custom_fields(xml, options) if options[:custom_fields]
+        add_stored_credential(xml, options) if options[:stored_credential]
       end
 
       def add_custom_fields(xml, options)
@@ -337,6 +349,32 @@ module ActiveMerchant #:nodoc:
         }
       end
 
+      def add_stored_credential(xml, options)
+        network_transaction_id = options.dig(:stored_credential, :network_transaction_id)
+        case
+        when network_transaction_id.nil?
+          return
+        when network_transaction_id.to_s.include?('|')
+          oar_data, ps2000_data = options[:stored_credential][:network_transaction_id].split('|')
+          xml.ssl_oar_data oar_data unless oar_data.nil? || oar_data.empty?
+          xml.ssl_ps2000_data ps2000_data unless ps2000_data.nil? || ps2000_data.empty?
+        when network_transaction_id.to_s.length > 22
+          xml.ssl_oar_data options.dig(:stored_credential, :network_transaction_id)
+        else
+          xml.ssl_ps2000_data options.dig(:stored_credential, :network_transaction_id)
+        end
+      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'
+      end
+
+      def entry_mode(options)
+        return options[:entry_mode] if options[:entry_mode]
+        return 12 if options[:stored_credential]
+      end
+
       def build_xml_request
         builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
           xml.txn do
@@ -352,6 +390,7 @@ module ActiveMerchant #:nodoc:
 
       def commit(request)
         request = "xmldata=#{request}".delete('&')
+
         response = parse(ssl_post(test? ? self.test_url : self.live_url, request, headers))
 
         Response.new(
@@ -362,10 +401,15 @@ module ActiveMerchant #:nodoc:
           authorization: authorization_from(response),
           error_code: response[:errorCode],
           avs_result: { code: response[:avs_response] },
-          cvv_result: response[:cvv2_response]
+          cvv_result: response[:cvv2_response],
+          network_transaction_id: build_network_transaction_id(response)
         )
       end
 
+      def build_network_transaction_id(response)
+        "#{response[:oar_data]}|#{response[:ps2000_data]}"
+      end
+
       def headers
         {
           'Accept' => 'application/xml',
@@ -383,6 +427,14 @@ module ActiveMerchant #:nodoc:
       def authorization_from(response)
         [response[:approval_code], response[:txn_id]].join(';')
       end
+
+      def truncate(value, size)
+        return nil unless value
+
+        difference = value.force_encoding('iso-8859-1').length - value.length
+
+        return value.delete('&"<>').to_s[0, (size - difference)]
+      end
     end
   end
 end

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

@@ -53,6 +53,7 @@ module ActiveMerchant #:nodoc:
         add_invoice(params, amount, options)
         add_customer_data(params, options, payment_method)
         add_credit_card(params, payment_method, options)
+        add_3ds_authenticated_data(params, options) if options[:three_d_secure]
         params['Method'] = payment_method.respond_to?(:number) ? 'ProcessPayment' : 'TokenPayment'
         commit(url_for('Transaction'), params)
       end
@@ -197,6 +198,18 @@ module ActiveMerchant #:nodoc:
         params
       end
 
+      def add_3ds_authenticated_data(params, options)
+        three_d_secure_options = options[:three_d_secure]
+        params['PaymentInstrument'] ||= {} if params['PaymentInstrument'].nil?
+        threed_secure_auth = params['PaymentInstrument']['ThreeDSecureAuth'] = {}
+        threed_secure_auth['Cryptogram'] = three_d_secure_options[:cavv]
+        threed_secure_auth['ECI'] = three_d_secure_options[:eci]
+        threed_secure_auth['XID'] = three_d_secure_options[:xid]
+        threed_secure_auth['AuthStatus'] = three_d_secure_options[:authentication_response_status]
+        threed_secure_auth['dsTransactionId'] = three_d_secure_options[:ds_transaction_id]
+        threed_secure_auth['Version'] = three_d_secure_options[:version]
+      end
+
       def add_invoice(params, money, options, key = 'Payment')
         currency_code = options[:currency] || currency(money)
         params[key] = {

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

@@ -212,8 +212,8 @@ module ActiveMerchant #:nodoc:
           xml.tag! 'Expiry_Date', expdate(credit_card)
           xml.tag! 'CardHoldersName', credit_card.name
           xml.tag! 'CardType', card_type(credit_card.brand)
-          xml.tag! 'WalletProviderID', options[:wallet_provider_id] if options[:wallet_provider_id]
 
+          add_wallet_provider_id(xml, credit_card, options)
           add_credit_card_eci(xml, credit_card, options)
           add_credit_card_verification_strings(xml, credit_card, options)
         end
@@ -221,10 +221,9 @@ module ActiveMerchant #:nodoc:
 
       def add_credit_card_eci(xml, credit_card, options)
         eci = if credit_card.is_a?(NetworkTokenizationCreditCard) && credit_card.source == :apple_pay && card_brand(credit_card) == 'discover'
-                # Discover requires any Apple Pay transaction, regardless of in-app
-                # or web, and regardless of the ECI contained in the PKPaymentToken,
-                # to have an ECI value explicitly of 04.
-                '04'
+                # Payeezy requires an ECI of 5 for apple pay transactions
+                # See: https://support.payeezy.com/hc/en-us/articles/203730589-Ecommerce-Flag-Values
+                '05'
               else
                 (credit_card.respond_to?(:eci) ? credit_card.eci : nil) || options[:eci] || DEFAULT_ECI
               end
@@ -276,10 +275,22 @@ module ActiveMerchant #:nodoc:
         xml.tag! 'Expiry_Date', expdate(credit_card)
         xml.tag! 'CardHoldersName', credit_card.name
         xml.tag! 'CardType', card_type(credit_card.brand)
-        xml.tag! 'WalletProviderID', options[:wallet_provider_id] if options[:wallet_provider_id]
+
+        add_wallet_provider_id(xml, credit_card, options)
         add_card_authentication_data(xml, options)
       end
 
+      def add_wallet_provider_id(xml, credit_card, options)
+        provider_id = if options[:wallet_provider_id]
+                        options[:wallet_provider_id]
+                      elsif credit_card.is_a?(NetworkTokenizationCreditCard) && credit_card.source == :apple_pay
+                        # See: https://support.payeezy.com/hc/en-us/articles/206601408-First-Data-Payeezy-Gateway-Web-Service-API-Reference-Guide#3.9
+                        4
+                      end
+
+        xml.tag! 'WalletProviderID', provider_id if provider_id
+      end
+
       def add_customer_data(xml, options)
         xml.tag! 'Customer_Ref', options[:customer] if options[:customer]
         xml.tag! 'Client_IP', options[:ip] if options[:ip]

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

@@ -28,6 +28,7 @@ module ActiveMerchant #:nodoc:
         add_payment_method(post, payment_method, options)
         add_billing_address(post, payment_method, options)
         add_shipping_address(post, options)
+        add_xdata(post, options)
         post[:action] = 'sale'
 
         commit(:post, post)
@@ -41,6 +42,7 @@ module ActiveMerchant #:nodoc:
         add_payment_method(post, payment_method, options)
         add_billing_address(post, payment_method, options)
         add_shipping_address(post, options)
+        add_xdata(post, options)
         post[:action] = 'authorize'
 
         commit(:post, post)
@@ -122,6 +124,16 @@ module ActiveMerchant #:nodoc:
         post[:service_fee_amount] = options[:service_fee_amount] if options[:service_fee_amount]
       end
 
+      def add_xdata(post, options)
+        post[:xdata] = {}
+        if xdata = options[:xdata]
+          (1..9).each do |n|
+            field = "xdata_#{n}".to_sym
+            post[:xdata][field] = xdata[field] if xdata[field]
+          end
+        end
+      end
+
       def add_billing_address(post, payment, options)
         post[:billing_address] = {}
         if address = options[:billing_address] || options[:address]

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

@@ -32,6 +32,7 @@ module ActiveMerchant #:nodoc:
         add_address(post, payment, options)
         add_creator_info(post, options)
         add_fraud_fields(post, options)
+        add_external_cardholder_authentication_data(post, options)
         commit(:authorize, post)
       end
 
@@ -200,21 +201,21 @@ module ActiveMerchant #:nodoc:
         shipping_address = options[:shipping_address]
         if billing_address = options[:billing_address] || options[:address]
           post['order']['customer']['billingAddress'] = {
-            'street' => billing_address[:address1],
-            'additionalInfo' => billing_address[:address2],
+            'street' => truncate(billing_address[:address1], 50),
+            'additionalInfo' => truncate(billing_address[:address2], 50),
             'zip' => billing_address[:zip],
             'city' => billing_address[:city],
-            'state' => billing_address[:state],
+            'state' => truncate(billing_address[:state], 35),
             'countryCode' => billing_address[:country]
           }
         end
         if shipping_address
           post['order']['customer']['shippingAddress'] = {
-            'street' => shipping_address[:address1],
-            'additionalInfo' => shipping_address[:address2],
+            'street' => truncate(shipping_address[:address1], 50),
+            'additionalInfo' => truncate(shipping_address[:address2], 50),
             'zip' => shipping_address[:zip],
             'city' => shipping_address[:city],
-            'state' => shipping_address[:state],
+            'state' => truncate(shipping_address[:state], 35),
             'countryCode' => shipping_address[:country]
           }
           post['order']['customer']['shippingAddress']['name'] = {
@@ -232,6 +233,24 @@ module ActiveMerchant #:nodoc:
         post['fraudFields'] = fraud_fields unless fraud_fields.empty?
       end
 
+      def add_external_cardholder_authentication_data(post, options)
+        return unless threeds_2_options = options[:three_d_secure]
+
+        authentication_data = {}
+        authentication_data[:acsTransactionId] = threeds_2_options[:acs_transaction_id] if threeds_2_options[:acs_transaction_id]
+        authentication_data[:cavv] = threeds_2_options[:cavv] if threeds_2_options[:cavv]
+        authentication_data[:cavvAlgorithm] = threeds_2_options[:cavv_algorithm] if threeds_2_options[:cavv_algorithm]
+        authentication_data[:directoryServerTransactionId] = threeds_2_options[:ds_transaction_id] if threeds_2_options[:ds_transaction_id]
+        authentication_data[:eci] = threeds_2_options[:eci] if threeds_2_options[:eci]
+        authentication_data[:threeDSecureVersion] = threeds_2_options[:version] if threeds_2_options[:version]
+        authentication_data[:validationResult] = threeds_2_options[:authentication_response_status] if threeds_2_options[:authentication_response_status]
+        authentication_data[:xid] = threeds_2_options[:xid] if threeds_2_options[:xid]
+
+        post['cardPaymentMethodSpecificInput'] ||= {}
+        post['cardPaymentMethodSpecificInput']['threeDSecure'] ||= {}
+        post['cardPaymentMethodSpecificInput']['threeDSecure']['externalCardholderAuthenticationData'] = authentication_data unless authentication_data.empty?
+      end
+
       def add_number_of_installments(post, options)
         post['order']['additionalInput']['numberOfInstallments'] = options[:number_of_installments] if options[:number_of_installments]
       end

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

@@ -39,6 +39,7 @@ module ActiveMerchant #:nodoc:
           add_descriptor_name(xml, options)
           add_card_or_token_payment(xml, card_or_token, options)
           add_three_d_secure(xml, card_or_token, options)
+          add_stored_credentials(xml, options)
         end
       end
 
@@ -52,6 +53,8 @@ module ActiveMerchant #:nodoc:
       def purchase(money, payment_method, options = {})
         if payment_method.is_a?(Check)
           commit_check_sale(money, payment_method, options)
+        elsif options.dig(:stored_credential, :reason_type) == 'recurring'
+          commit_recurring_billing_sale(money, payment_method, options)
         else
           commit_credit_sale(money, payment_method, options)
         end
@@ -67,6 +70,15 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def credit(money, payment_method, options = {})
+        commit('CreditReturn') do |xml|
+          add_amount(xml, money)
+          add_allow_dup(xml)
+          add_card_or_token_payment(xml, payment_method, options)
+          add_details(xml, options)
+        end
+      end
+
       def verify(card_or_token, options = {})
         commit('CreditAccountVerify') do |xml|
           add_card_or_token_customer_data(xml, card_or_token, options)
@@ -122,6 +134,21 @@ module ActiveMerchant #:nodoc:
           add_descriptor_name(xml, options)
           add_card_or_token_payment(xml, card_or_token, options)
           add_three_d_secure(xml, card_or_token, options)
+          add_stored_credentials(xml, options)
+        end
+      end
+
+      def commit_recurring_billing_sale(money, card_or_token, options)
+        commit('RecurringBilling') do |xml|
+          add_amount(xml, money)
+          add_allow_dup(xml)
+          add_card_or_token_customer_data(xml, card_or_token, options)
+          add_details(xml, options)
+          add_descriptor_name(xml, options)
+          add_card_or_token_payment(xml, card_or_token, options)
+          add_three_d_secure(xml, card_or_token, options)
+          add_stored_credentials(xml, options)
+          add_stored_credentials_for_recurring_billing(xml, options)
         end
       end
 
@@ -148,7 +175,7 @@ module ActiveMerchant #:nodoc:
             xml.hps :CardHolderAddr, billing_address[:address1] if billing_address[:address1]
             xml.hps :CardHolderCity, billing_address[:city] if billing_address[:city]
             xml.hps :CardHolderState, billing_address[:state] if billing_address[:state]
-            xml.hps :CardHolderZip, billing_address[:zip] if billing_address[:zip]
+            xml.hps :CardHolderZip, alphanumeric_zip(billing_address[:zip]) if billing_address[:zip]
           end
         end
       end
@@ -210,7 +237,7 @@ module ActiveMerchant #:nodoc:
       def add_details(xml, options)
         xml.hps :AdditionalTxnFields do
           xml.hps :Description, options[:description] if options[:description]
-          xml.hps :InvoiceNbr, options[:order_id] if options[:order_id]
+          xml.hps :InvoiceNbr, options[:order_id][0..59] if options[:order_id]
           xml.hps :CustomerID, options[:customer_id] if options[:customer_id]
         end
       end
@@ -256,6 +283,38 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      # We do not currently support installments on this gateway.
+      # The HPS gateway treats recurring transactions as a seperate transaction type
+      def add_stored_credentials(xml, options)
+        return unless options[:stored_credential]
+
+        xml.hps :CardOnFileData do
+          if options[:stored_credential][:initiator] == 'customer'
+            xml.hps :CardOnFile, 'C'
+          elsif options[:stored_credential][:initiator] == 'merchant'
+            xml.hps :CardOnFile, 'M'
+          else
+            return
+          end
+
+          if options[:stored_credential][:network_transaction_id]
+            xml.hps :CardBrandTxnId, options[:stored_credential][:network_transaction_id]
+          else
+            return
+          end
+        end
+      end
+
+      def add_stored_credentials_for_recurring_billing(xml, options)
+        xml.hps :RecurringData do
+          if options[:stored_credential][:reason_type] = 'recurring'
+            xml.hps :OneTime, 'N'
+          else
+            xml.hps :OneTime, 'Y'
+          end
+        end
+      end
+
       def strip_leading_zero(value)
         return value unless value[0] == '0'
 
@@ -380,6 +439,10 @@ module ActiveMerchant #:nodoc:
         @options[:secret_api_key]&.include?('_cert_')
       end
 
+      def alphanumeric_zip(zip)
+        zip.gsub(/[^0-9a-z]/i, '')
+      end
+
       ISSUER_MESSAGES = {
         '13' => 'Must be greater than or equal 0.',
         '14' => 'The card number is incorrect.',