activemerchant 1.133.0 → 1.138.0

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

@@ -0,0 +1,267 @@
+module ActiveMerchant
+  module Billing
+    class MultiPayGateway < Gateway
+      self.test_url = 'https://ic2.multipay.mx:38263'
+      self.live_url = 'https://ic2.multipay.mx:38263'
+
+      self.supported_countries = ['CL']
+      self.default_currency = 'CLP'
+      self.supported_cardtypes = %i[visa master american_express]
+
+      self.homepage_url = 'https://www.multipay.mx'
+      self.display_name = 'MultiPay'
+
+      CURRENCY_CODES = {
+        'CLP' => '152',
+        'USD' => '840'
+      }
+
+      self.money_format = :cents
+
+      ERROR_MAPPING = {
+        1 => 'Call Issuer',
+        2  => 'Call Ref.',
+        3  => 'Invalid business-03',
+        4  => 'Hold Card',
+        5  => 'Reject Card',
+        6  => 'Error-Call',
+        8  => 'Identify Client',
+        9  => 'Request in progress',
+        11  => 'VIP-11 approved ',
+        12  => 'Invalid transaction',
+        13  => 'Amount invalid',
+        14  => 'invalid card',
+        15  => 'No such issuer',
+        19  => 'Repeat transaction',
+        21  => 'No transactions-21',
+        25  => 'Invalid ID-25',
+        30  => 'Format Error',
+        31  => 'Invalid bench',
+        33  => 'Collect Expired Card',
+        34  => 'Collect Expired Card',
+        35  => 'Collect Card-35',
+        36  => 'Collect Card-36',
+        37  => 'Collect Card-37',
+        38  => 'Allowable PIN tries exceeded',
+        39  => 'No credit account',
+        41  => 'Lost Card-41',
+        43  => 'Stolen Card-43',
+        51  => 'Insufficient Funds',
+        52  => 'Without Check Account'
+      }
+
+      def initialize(options = {})
+        requires!(options, :company, :branch, :pos)
+        super
+
+        @company = options[:company]
+        @branch = options[:branch]
+        @pos = options[:pos]
+        @user = options[:user]
+        @password = options[:password]
+      end
+
+      def authorize(money, payment, options = {})
+        request_data = build_request_data(money, payment, options, 'AuthorizeSale')
+        commit('AuthorizeSale', { AuthorizeSale: request_data })
+      end
+
+      def capture(money, authorization, options = {})
+        post = {
+          Settlement: {
+            RequestType: 'Settlement',
+            SystemIdentification: '1.0.0',
+            CompanyIdentification: @company,
+            BranchIdentification: @branch,
+            POSIdentification: @pos,
+            UserID: options[:user_id],
+            Reference: options[:order_id],
+            Amount: money,
+            OrigReference: authorization
+          }.compact
+        }
+
+        commit('Settlement', post)
+      end
+
+      def purchase(money, payment, options = {})
+        request_data = build_request_data(money, payment, options, 'Sale')
+        commit('Sale', { Sale: request_data })
+      end
+
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(/(Authorization: (Bearer|Basic) )\S+/, '\1[FILTERED]').
+          gsub(/(\\?"CardNumber\\?":\\?")\d+/, '\1[FILTERED]').
+          gsub(/(\\?"SecurityCode\\?":\\?")\d+/, '\1[FILTERED]')
+      end
+
+      private
+
+      def build_request_data(money, payment, options, request_type)
+        {
+          RequestType: request_type,
+          SystemIdentification: '1.0.0', # optional
+          CompanyIdentification: @company,
+          BranchIdentification: @branch,
+          POSIdentification: @pos,
+          CardNumber: payment.number,
+          CardExp: expdate(payment),
+          SecurityCode: payment.verification_value,
+          Security: build_security_data(options),
+          Amount: money,
+          Reference: options[:order_id],
+          CurrencyCode: CURRENCY_CODES[options[:currency] || currency(money)],
+          CardReadMode: 'E',
+          FacilityPayments: options[:facility_payments] || 1,
+          ReadingDeviceType: 'Default',
+          MerchantNotifyURL: options[:notify_url],
+          UserID: options[:user_id]
+        }.compact
+      end
+
+      def build_required_information
+        [{ Name: 'Branch', Value: @branch }]
+      end
+
+      def build_security_data(options)
+        return unless options[:three_d_secure]
+
+        [{
+          Type: '3DSecure',
+          Values: [
+            {
+              Name: 'Method',
+              Value: options.dig(:three_d_secure, :method) || '3DS-SNAP'
+            },
+            {
+              Name: 'Data',
+              Value: {
+                AuthenticationECI: options.dig(:three_d_secure, :eci) || '07'
+              }.compact
+            }
+          ]
+        }]
+      end
+
+      def expdate(payment)
+        "#{format(payment.year, :two_digits)}#{format(payment.month, :two_digits)}"
+      end
+
+      def parse(body)
+        JSON.parse(body, symbolize_names: true)
+      rescue JSON::ParserError
+        {
+          success: false,
+          error: 'Invalid JSON response received from MultiPay'
+        }
+      end
+
+      def url(action)
+        "#{base_url}/token/Spreedly/Payments/Authorize/5.7.0/#{action}"
+      end
+
+      def access_token_valid?
+        @options[:access_token].present? && @options.fetch(:token_expires, 0).to_i > DateTime.now.strftime('%Q').to_i
+      end
+
+      def commit(action, parameters)
+        MultiResponse.run do |r|
+          r.process { fetch_access_token } unless access_token_valid?
+          r.process do
+            api_request(action, parameters).tap do |response|
+              response.params.merge!(@options.slice(:access_token, :token_expires)) if @options[:new_credentials]
+            end
+          end
+        end
+      end
+
+      def api_request(action, parameters)
+        response = parse(ssl_post(url(action), post_data(parameters), headers))
+        action_response = "#{action}Response".to_sym
+
+        Response.new(
+          success_from(response, action_response),
+          message_from(response, action_response),
+          response,
+          authorization: authorization_from(response, action_response),
+          avs_result: AVSResult.new(code: response[:avs_result_code]),
+          cvv_result: CVVResult.new(response[:cvv_result_code]),
+          test: test?,
+          error_code: error_code_from(response, action_response)
+        )
+      rescue StandardError => e
+        Response.new(false, "Error: #{e.message}", {}, test: test?)
+      end
+
+      def handle_response_error(error)
+        response = parse(error.response.body)
+        Response.new(
+          false,
+          response[:Message] || response[:ErrorDescription] || 'Unknown error',
+          response,
+          test: test?,
+          error_code: error_code_from(response)
+        )
+      end
+
+      def success_from(response, action)
+        %w[00].include?(response[action][:AuthResultCode])
+      end
+
+      def message_from(response, action)
+        response[action][:ResponseMessage] || 'Unknown error'
+      end
+
+      def authorization_from(response, action)
+        response[action][:Reference]
+      end
+
+      def error_code_from(response, action)
+        ERROR_MAPPING[response.dig(action, :AuthResultCode)]
+      end
+
+      def base_url
+        test? ? test_url : live_url
+      end
+
+      def fetch_access_token
+        url = "#{base_url}/token?grant_type=client_credentials"
+        response = parse(ssl_post(url, nil, auth_headers))
+
+        @options[:access_token] = response[:access_token]
+        @options[:token_expires] = DateTime.now.strftime('%Q').to_i + (response[:expires_in].to_i * 1000)
+        @options[:new_credentials] = true
+
+        success = response[:access_token].present?
+        Response.new(
+          success,
+          response[:token_type] || '',
+          response,
+          test: test?
+        )
+      rescue ResponseError => e
+        raise OAuthResponseError.new(e)
+      end
+
+      def headers
+        {
+          'Content-Type' => 'application/json',
+          'Authorization' => "Bearer #{@options[:access_token]}"
+        }
+      end
+
+      def auth_headers
+        { 'Authorization' => "Basic #{Base64.strict_encode64("#{@user}:#{@password}")}" }
+      end
+
+      def post_data(parameters)
+        parameters.to_json
+      end
+    end
+  end
+end

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

@@ -1,7 +1,9 @@
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     class MundipaggGateway < Gateway
-      self.live_url = 'https://api.mundipagg.com/core/v1'
+      version 'v1'
+
+      self.live_url = "https://api.mundipagg.com/core/#{fetch_version}"
 
       self.supported_countries = ['US']
       self.default_currency = 'USD'

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

@@ -1,12 +1,12 @@
 require 'rexml/document'
 
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     # The National Australia Bank provide a payment gateway that seems to
     # be a rebadged Securepay Australia service, though some differences exist.
     class NabTransactGateway < Gateway
-      API_VERSION = 'xml-4.2'
-      PERIODIC_API_VERSION = 'spxml-4.2'
+      version 'xml-4.2'
+      version 'spxml-4.2', :periodic_api
 
       class_attribute :test_periodic_url, :live_periodic_url
 
@@ -146,7 +146,7 @@ module ActiveMerchant #:nodoc:
             xml.tag! 'messageID', SecureRandom.hex(15)
             xml.tag! 'messageTimestamp', generate_timestamp
             xml.tag! 'timeoutValue', request_timeout
-            xml.tag! 'apiVersion', API_VERSION
+            xml.tag! 'apiVersion', fetch_version
           end
 
           xml.tag! 'MerchantInfo' do
@@ -177,7 +177,7 @@ module ActiveMerchant #:nodoc:
             xml.tag! 'messageID', SecureRandom.hex(15)
             xml.tag! 'messageTimestamp', generate_timestamp
             xml.tag! 'timeoutValue', request_timeout
-            xml.tag! 'apiVersion', PERIODIC_API_VERSION
+            xml.tag! 'apiVersion', fetch_version(:periodic_api)
           end
 
           xml.tag! 'MerchantInfo' do
@@ -233,16 +233,24 @@ module ActiveMerchant #:nodoc:
       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,
+        Response.new(
+          success?(response),
+          message_from(response),
+          response,
           test: test?,
-          authorization: authorization_from(action, response))
+          authorization: authorization_from(action, response)
+        )
       end
 
       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,
+        Response.new(
+          success?(response),
+          message_from(response),
+          response,
           test: test?,
-          authorization: authorization_from(action, response))
+          authorization: authorization_from(action, response)
+        )
       end
 
       def success?(response)

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

@@ -1,7 +1,7 @@
 require 'nokogiri'
 
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     class NcrSecurePayGateway < Gateway
       self.test_url = 'https://testbox.monetra.com:8665/'
       self.live_url = 'https://portal.ncrsecurepay.com:8444/'

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

@@ -144,8 +144,12 @@ module ActiveMerchant
         # get gateway response
         response = parse(ssl_post(self.live_url, post_data(action, params)))
 
-        Response.new(response['status'] == 'approved', message_from(response), response,
-          authorization: authorization_from(response, action))
+        Response.new(
+          response['status'] == 'approved',
+          message_from(response),
+          response,
+          authorization: authorization_from(response, action)
+        )
       end
 
       def post_data(action, params)

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

@@ -1,7 +1,7 @@
 require 'digest/md5'
 
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     class NetaxeptGateway < Gateway
       self.test_url = 'https://epayment-test.bbs.no/'
       self.live_url = 'https://epayment.bbs.no/'
@@ -137,7 +137,7 @@ module ActiveMerchant #:nodoc:
           message,
           raw,
           test: test?,
-          authorization: authorization
+          authorization:
         )
       end
 
@@ -146,7 +146,7 @@ module ActiveMerchant #:nodoc:
           doc = REXML::Document.new(result)
           extract_xml(doc.root).merge(container: doc.root.name)
         else
-          { result: result }
+          { result: }
         end
       end
 

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

@@ -1,5 +1,5 @@
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     class NetbanxGateway < Gateway
       # Netbanx is the new REST based API for Optimal Payments / Paysafe
       self.test_url = 'https://api.test.netbanx.com/'
@@ -210,7 +210,7 @@ module ActiveMerchant #:nodoc:
         month = format(credit_card.month, :two_digits)
 
         # returns a hash (necessary in the card JSON object)
-        { month: month, year: year }
+        { month:, year: }
       end
 
       def add_order_id(post, options)
@@ -233,7 +233,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def map_3ds(three_d_secure_options)
-        mapped = {
+        {
           eci: three_d_secure_options[:eci],
           cavv: three_d_secure_options[:cavv],
           xid: three_d_secure_options[:xid],
@@ -241,8 +241,6 @@ module ActiveMerchant #:nodoc:
           threeDSecureVersion: three_d_secure_options[:version],
           directoryServerTransactionId: three_d_secure_options[:ds_transaction_id]
         }
-
-        mapped
       end
 
       def parse(body)

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

@@ -1,5 +1,5 @@
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     # To perform PCI Compliant Repeat Billing
     #
     #   Ensure that PCI Compliant Repeat Billing is enabled on your merchant account:
@@ -193,11 +193,15 @@ module ActiveMerchant #:nodoc:
       def commit(action, parameters)
         response = parse(ssl_post(self.live_url, post_data(action, parameters)))
 
-        Response.new(success?(response), message_from(response), response,
+        Response.new(
+          success?(response),
+          message_from(response),
+          response,
           test: test_response?(response),
           authorization: response[:trans_id],
           avs_result: { code: response[:avs_code] },
-          cvv_result: response[:cvv2_code])
+          cvv_result: response[:cvv2_code]
+        )
       rescue ActiveMerchant::ResponseError => e
         raise unless e.response.code =~ /^[67]\d\d$/
 

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

@@ -1,5 +1,5 @@
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     #
     # NETPAY Gateway
     #

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

@@ -1,5 +1,5 @@
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     class NetworkMerchantsGateway < Gateway
       self.live_url = self.test_url = 'https://secure.networkmerchants.com/api/transact.php'
 
@@ -200,11 +200,15 @@ module ActiveMerchant #:nodoc:
 
         authorization = authorization_from(success, parameters, raw)
 
-        Response.new(success, raw['responsetext'], raw,
+        Response.new(
+          success,
+          raw['responsetext'],
+          raw,
           test: test?,
-          authorization: authorization,
+          authorization:,
           avs_result: { code: raw['avsresponse'] },
-          cvv_result: raw['cvvresponse'])
+          cvv_result: raw['cvvresponse']
+        )
       end
 
       def build_request(action, parameters)

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

@@ -1,5 +1,5 @@
-module ActiveMerchant #:nodoc:
-  module Billing #:nodoc:
+module ActiveMerchant # :nodoc:
+  module Billing # :nodoc:
     class NmiGateway < Gateway
       include Empty
 
@@ -8,7 +8,7 @@ module ActiveMerchant #:nodoc:
       self.test_url = self.live_url = 'https://secure.networkmerchants.com/api/transact.php'
       self.default_currency = 'USD'
       self.money_format = :dollars
-      self.supported_countries = ['US']
+      self.supported_countries = %w[US CA]
       self.supported_cardtypes = %i[visa master american_express discover]
       self.homepage_url = 'http://nmi.com/'
       self.display_name = 'NMI'
@@ -34,6 +34,7 @@ module ActiveMerchant #:nodoc:
       def purchase(amount, payment_method, options = {})
         post = {}
         add_invoice(post, amount, options)
+        add_customer_vault_data(post, options)
         add_payment_method(post, payment_method, options)
         add_stored_credential(post, options)
         add_customer_data(post, options)
@@ -48,6 +49,7 @@ module ActiveMerchant #:nodoc:
       def authorize(amount, payment_method, options = {})
         post = {}
         add_invoice(post, amount, options)
+        add_customer_vault_data(post, options)
         add_payment_method(post, payment_method, options)
         add_stored_credential(post, options)
         add_customer_data(post, options)
@@ -97,6 +99,7 @@ module ActiveMerchant #:nodoc:
 
       def verify(payment_method, options = {})
         post = {}
+        add_customer_vault_data(post, options)
         add_payment_method(post, payment_method, options)
         add_customer_data(post, options)
         add_vendor_data(post, options)
@@ -134,6 +137,7 @@ module ActiveMerchant #:nodoc:
           gsub(%r((cvv=)\d+), '\1[FILTERED]').
           gsub(%r((checkaba=)\d+), '\1[FILTERED]').
           gsub(%r((checkaccount=)\d+), '\1[FILTERED]').
+          gsub(%r((cavv=)[^&\n]*), '\1[FILTERED]').
           gsub(%r((cryptogram=)[^&]+(&?)), '\1[FILTERED]\2')
       end
 
@@ -154,6 +158,7 @@ module ActiveMerchant #:nodoc:
         post[:orderdescription] = options[:description]
         post[:currency] = options[:currency] || currency(money)
         post[:billing_method] = 'recurring' if options[:recurring]
+        post[:industry] = options[:industry_indicator] if options[:industry_indicator]
         if (dup_seconds = (options[:dup_seconds] || self.class.duplicate_window))
           post[:dup_seconds] = dup_seconds
         end
@@ -166,7 +171,7 @@ module ActiveMerchant #:nodoc:
         elsif payment_method.is_a?(NetworkTokenizationCreditCard)
           post[:ccnumber] = payment_method.number
           post[:ccexp] = exp_date(payment_method)
-          post[:token_cryptogram] = payment_method.payment_cryptogram
+          add_network_token_fields(post, payment_method)
         elsif card_brand(payment_method) == 'check'
           post[:payment] = 'check'
           post[:firstname] = payment_method.first_name
@@ -187,6 +192,17 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def add_network_token_fields(post, payment_method)
+        if payment_method.source == :apple_pay || payment_method.source == :google_pay
+          post[:cavv] = payment_method.payment_cryptogram
+          post[:eci] = payment_method.eci
+          post[:decrypted_applepay_data] = 1 if payment_method.source == :apple_pay
+          post[:decrypted_googlepay_data] = 1 if payment_method.source == :google_pay
+        else
+          post[:token_cryptogram] = payment_method.payment_cryptogram
+        end
+      end
+
       def add_stored_credential(post, options)
         return unless (stored_credential = options[:stored_credential])
 
@@ -212,7 +228,8 @@ module ActiveMerchant #:nodoc:
         else
           post[:stored_credential_indicator] = 'used'
           # should only send :initial_transaction_id if it is a MIT
-          post[:initial_transaction_id] = stored_credential[:network_transaction_id] if post[:initiated_by] == 'merchant'
+          ntid = options[:network_transaction_id] || stored_credential[:network_transaction_id]
+          post[:initial_transaction_id] = ntid if post[:initiated_by] == 'merchant'
         end
       end
 
@@ -266,6 +283,11 @@ module ActiveMerchant #:nodoc:
         post[:processor_id] = options[:processor_id] if options[:processor_id]
       end
 
+      def add_customer_vault_data(post, options)
+        post[:customer_vault] = options[:customer_vault] if options[:customer_vault]
+        post[:customer_vault_id] = options[:customer_vault_id] if options[:customer_vault_id]
+      end
+
       def add_merchant_defined_fields(post, options)
         (1..20).each do |each|
           key = "merchant_defined_field_#{each}".to_sym
@@ -334,8 +356,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def headers
-        headers = { 'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8' }
-        headers
+        { 'Content-Type' => 'application/x-www-form-urlencoded;charset=UTF-8' }
       end
 
       def post_data(action, params)
@@ -347,7 +368,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def parse(body)
-        Hash[CGI::parse(body).map { |k, v| [k.intern, v.first] }]
+        CGI::parse(body).map { |k, v| [k.intern, v.first] }.to_h
       end
 
       def success_from(response)