activemerchant 1.133.0 → 1.137.0

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

@@ -182,14 +182,16 @@ module ActiveMerchant #:nodoc:
           response = json_error(raw_response)
         end
 
-        Response.new(success,
+        Response.new(
+          success,
           response_message(response),
           response,
           test: test?,
           avs_result: { code: response['AVS_RESULT_CODE'] },
           cvv_result: response['VERIFICATION_RESULT_CODE'],
           error_code: (success ? nil : STANDARD_ERROR_CODE_MAPPING[response['RESPONSE_CODE']]),
-          authorization: response['TRANSACTION_ID'])
+          authorization: response['TRANSACTION_ID']
+        )
       end
 
       def response_error(raw_response)

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

@@ -337,9 +337,13 @@ module ActiveMerchant #:nodoc:
 
         response = parse(ssl_post(url, post_data(action, parameters)))
 
-        Response.new(successful?(response), message_from(response), response,
+        Response.new(
+          successful?(response),
+          message_from(response),
+          response,
           test: test?,
-          authorization: response[:transaction_id] || parameters[:transaction_id])
+          authorization: response[:transaction_id] || parameters[:transaction_id]
+        )
       end
 
       def successful?(response)

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

@@ -68,9 +68,13 @@ module ActiveMerchant #:nodoc:
       def commit(action, money, parameters)
         response = parse(ssl_post(self.live_url, post_data(action, parameters)))
 
-        Response.new(successful?(response), message_from(response), response,
+        Response.new(
+          successful?(response),
+          message_from(response),
+          response,
           test: test_response?(response),
-          authorization: authorization_from(response))
+          authorization: authorization_from(response)
+        )
       end
 
       def successful?(response)

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

@@ -1,7 +1,7 @@
 module ActiveMerchant #:nodoc:
   module Billing #:nodoc:
     class PayTraceGateway < Gateway
-      self.test_url = 'https://api.paytrace.com'
+      self.test_url = 'https://api.sandbox.paytrace.com'
       self.live_url = 'https://api.paytrace.com'
 
       self.supported_countries = ['US']
@@ -46,7 +46,7 @@ module ActiveMerchant #:nodoc:
       def initialize(options = {})
         requires!(options, :username, :password, :integrator_id)
         super
-        acquire_access_token
+        acquire_access_token unless options[:access_token]
       end
 
       def purchase(money, payment_or_customer_id, options = {})
@@ -169,28 +169,35 @@ module ActiveMerchant #:nodoc:
         transcript.
           gsub(%r((Authorization: Bearer )[a-zA-Z0-9:_]+), '\1[FILTERED]').
           gsub(%r(("credit_card\\?":{\\?"number\\?":\\?")\d+), '\1[FILTERED]').
-          gsub(%r(("cvv\\?":\\?")\d+), '\1[FILTERED]').
+          gsub(%r(("csc\\?":\\?")\d+), '\1[FILTERED]').
           gsub(%r(("username\\?":\\?")\w+@+\w+.+\w+), '\1[FILTERED]').
+          gsub(%r(("username\\?":\\?")\w+), '\1[FILTERED]').
           gsub(%r(("password\\?":\\?")\w+), '\1[FILTERED]').
           gsub(%r(("integrator_id\\?":\\?")\w+), '\1[FILTERED]')
       end
 
       def acquire_access_token
         post = {}
+        base_url = (test? ? test_url : live_url)
         post[:grant_type] = 'password'
         post[:username] = @options[:username]
         post[:password] = @options[:password]
         data = post.collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join('&')
-        url = live_url + '/oauth/token'
+        url = base_url + '/oauth/token'
         oauth_headers = {
           'Accept'            => '*/*',
           'Content-Type'      => 'application/x-www-form-urlencoded'
         }
         response = ssl_post(url, data, oauth_headers)
-        json_response = JSON.parse(response)
+        json_response = parse(response)
 
-        @options[:access_token] = json_response['access_token'] if json_response['access_token']
-        response
+        if json_response.include?('error')
+          oauth_response = Response.new(false, json_response['error_description'])
+          raise OAuthResponseError.new(oauth_response)
+        else
+          @options[:access_token] = json_response['access_token'] if json_response['access_token']
+          response
+        end
       end
 
       private
@@ -237,11 +244,11 @@ module ActiveMerchant #:nodoc:
       end
 
       def customer_id?(payment_or_customer_id)
-        payment_or_customer_id.class == String
+        payment_or_customer_id.instance_of?(String)
       end
 
       def string_literal_to_boolean(value)
-        return value unless value.class == String
+        return value unless value.instance_of?(String)
 
         if value.casecmp('true').zero?
           true
@@ -258,15 +265,16 @@ module ActiveMerchant #:nodoc:
       end
 
       def add_address(post, creditcard, options)
-        return unless options[:billing_address] || options[:address]
-
-        address = options[:billing_address] || options[:address]
         post[:billing_address] = {}
+
+        if (address = options[:billing_address] || options[:address])
+          post[:billing_address][:street_address] = address[:address1]
+          post[:billing_address][:city] = address[:city]
+          post[:billing_address][:state] = address[:state]
+          post[:billing_address][:zip] = address[:zip]
+        end
+
         post[:billing_address][:name] = creditcard.name
-        post[:billing_address][:street_address] = address[:address1]
-        post[:billing_address][:city] = address[:city]
-        post[:billing_address][:state] = address[:state]
-        post[:billing_address][:zip] = address[:zip]
       end
 
       def add_amount(post, money, options)
@@ -283,6 +291,7 @@ module ActiveMerchant #:nodoc:
           post[:credit_card][:number] = payment.number
           post[:credit_card][:expiration_month] = payment.month
           post[:credit_card][:expiration_year] = payment.year
+          post[:csc] = payment.verification_value
         end
       end
 
@@ -373,6 +382,12 @@ module ActiveMerchant #:nodoc:
         url = base_url + '/v1/' + action
         raw_response = ssl_post(url, post_data(parameters), headers)
         response = parse(raw_response)
+        handle_final_response(action, response)
+      rescue JSON::ParserError
+        unparsable_response(raw_response)
+      end
+
+      def handle_final_response(action, response)
         success = success_from(response)
 
         Response.new(
@@ -385,8 +400,6 @@ module ActiveMerchant #:nodoc:
           test: test?,
           error_code: success ? nil : error_code_from(response)
         )
-      rescue JSON::ParserError
-        unparsable_response(raw_response)
       end
 
       def unparsable_response(raw_response)

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

@@ -35,6 +35,8 @@ module ActiveMerchant
 
         add_invoice(params, options)
         add_reversal_id(params, options)
+        add_customer_ref(params, options)
+        add_reference_3(params, options)
         add_payment_method(params, payment_method, options)
         add_address(params, options)
         add_amount(params, amount, options)
@@ -51,6 +53,8 @@ module ActiveMerchant
 
         add_invoice(params, options)
         add_reversal_id(params, options)
+        add_customer_ref(params, options)
+        add_reference_3(params, options)
         add_payment_method(params, payment_method, options)
         add_address(params, options)
         add_amount(params, amount, options)
@@ -170,6 +174,14 @@ module ActiveMerchant
         params[:reversal_id] = options[:reversal_id] if options[:reversal_id]
       end
 
+      def add_customer_ref(params, options)
+        params[:customer_ref] = options[:customer_ref] if options[:customer_ref]
+      end
+
+      def add_reference_3(params, options)
+        params[:reference_3] = options[:reference_3] if options[:reference_3]
+      end
+
       def amount_from_authorization(authorization)
         authorization.split('|').last.to_i
       end
@@ -192,7 +204,7 @@ module ActiveMerchant
         params[:apikey] = @options[:apikey]
         params[:ta_token] = options[:ta_token]
         params[:type] = 'FDToken'
-        params[:credit_card] = add_card_data(payment_method)
+        params[:credit_card] = add_card_data(payment_method, options)
         params[:auth] = 'false'
       end
 
@@ -208,7 +220,7 @@ module ActiveMerchant
         elsif payment_method.is_a? NetworkTokenizationCreditCard
           add_network_tokenization(params, payment_method, options)
         else
-          add_creditcard(params, payment_method)
+          add_creditcard(params, payment_method, options)
         end
       end
 
@@ -245,17 +257,17 @@ module ActiveMerchant
         params[:token] = token
       end
 
-      def add_creditcard(params, creditcard)
-        credit_card = add_card_data(creditcard)
+      def add_creditcard(params, creditcard, options)
+        credit_card = add_card_data(creditcard, options)
 
         params[:method] = 'credit_card'
         params[:credit_card] = credit_card
       end
 
-      def add_card_data(payment_method)
+      def add_card_data(payment_method, options = {})
         card = {}
         card[:type] = CREDIT_CARD_BRAND[payment_method.brand]
-        card[:cardholder_name] = payment_method.name
+        card[:cardholder_name] = name_from_payment_method(payment_method) || name_from_address(options)
         card[:card_number] = payment_method.number
         card[:exp_date] = format_exp_date(payment_method.month, payment_method.year)
         card[:cvv] = payment_method.verification_value if payment_method.verification_value?
@@ -412,8 +424,7 @@ module ActiveMerchant
           @options[:token],
           payload
         ].join('')
-        hash = Base64.strict_encode64(OpenSSL::HMAC.hexdigest('sha256', @options[:apisecret], message))
-        hash
+        Base64.strict_encode64(OpenSSL::HMAC.hexdigest('sha256', @options[:apisecret], message))
       end
 
       def headers(payload)

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

@@ -385,11 +385,13 @@ module ActiveMerchant #:nodoc:
           'Content-Length' => request.size.to_s
         }
         response = parse(ssl_post(url, request, headers))
-        Response.new(success?(response),
+        Response.new(
+          success?(response),
           message_from(response),
           response,
           test: test?,
-          authorization: build_authorization(response))
+          authorization: build_authorization(response)
+        )
       end
 
       def build_authorization(response)

data/lib/active_merchant/billing/gateways/payflow/payflow_common_api.rb

@@ -99,7 +99,7 @@ module ActiveMerchant #:nodoc:
           end
           xml.tag! 'RequestAuth' do
             xml.tag! 'UserPass' do
-              xml.tag! 'User', !@options[:user].blank? ? @options[:user] : @options[:login]
+              xml.tag! 'User', @options[:user].blank? ? @options[:login] : @options[:user]
               xml.tag! 'Password', @options[:password]
             end
           end

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

@@ -192,9 +192,7 @@ module ActiveMerchant #:nodoc:
               xml.tag! 'TotalAmt', amount(money), 'Currency' => options[:currency] || currency(money)
             end
 
-            if %i(authorization purchase).include? action
-              add_mpi_3ds(xml, options[:three_d_secure]) if options[:three_d_secure]
-            end
+            add_mpi_3ds(xml, options[:three_d_secure]) if %i(authorization purchase).include?(action) && (options[:three_d_secure])
 
             xml.tag! 'Tender' do
               add_credit_card(xml, credit_card, options)

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

@@ -20,8 +20,8 @@ module ActiveMerchant #:nodoc:
       self.homepage_url = 'https://www.windcave.com/'
       self.display_name = 'Windcave (formerly PaymentExpress)'
 
-      self.live_url = 'https://sec.paymentexpress.com/pxpost.aspx'
-      self.test_url = 'https://uat.paymentexpress.com/pxpost.aspx'
+      self.live_url = 'https://sec.windcave.com/pxpost.aspx'
+      self.test_url = 'https://uat.windcave.com/pxpost.aspx'
 
       APPROVED = '1'
 
@@ -306,9 +306,13 @@ module ActiveMerchant #:nodoc:
         response = parse(ssl_post(url, request.to_s))
 
         # Return a response
-        PaymentExpressResponse.new(response[:success] == APPROVED, message_from(response), response,
+        PaymentExpressResponse.new(
+          response[:success] == APPROVED,
+          message_from(response),
+          response,
           test: response[:test_mode] == '1',
-          authorization: authorization_from(action, response))
+          authorization: authorization_from(action, response)
+        )
       end
 
       # Response XML documentation: http://www.paymentexpress.com/technical_resources/ecommerce_nonhosted/pxpost.html#XMLTxnOutput

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

@@ -34,7 +34,7 @@ module ActiveMerchant #:nodoc:
         28 => :card_declined
       }.freeze
 
-      SUCCESS_STATUS = ['success', 'pending', 1, 0]
+      SUCCESS_STATUS = ['APPROVED', 'PENDING', 'pending', 'success', 1, 0]
 
       CARD_MAPPING = {
         'visa' => 'vi',
@@ -218,7 +218,7 @@ module ActiveMerchant #:nodoc:
           xid: three_d_secure_options[:xid],
           eci: three_d_secure_options[:eci],
           version: three_d_secure_options[:version],
-          reference_id: three_d_secure_options[:three_ds_server_trans_id],
+          reference_id: three_d_secure_options[:ds_transaction_id],
           status: three_d_secure_options[:authentication_response_status] || three_d_secure_options[:directory_response_status]
         }.compact
 
@@ -237,14 +237,14 @@ module ActiveMerchant #:nodoc:
 
       def commit_raw(object, action, parameters)
         if action == 'inquire'
-          url = "#{(test? ? test_url : live_url)}#{object}/#{parameters}"
+          url = "#{test? ? test_url : live_url}#{object}/#{parameters}"
           begin
             raw_response = ssl_get(url, headers)
           rescue ResponseError => e
             raw_response = e.response.body
           end
         else
-          url = "#{(test? ? test_url : live_url)}#{object}/#{action}"
+          url = "#{test? ? test_url : live_url}#{object}/#{action}"
           begin
             raw_response = ssl_post(url, post_data(parameters), headers)
           rescue ResponseError => e
@@ -262,7 +262,7 @@ module ActiveMerchant #:nodoc:
       def commit_transaction(action, parameters)
         response = commit_raw('transaction', action, parameters)
         Response.new(
-          success_from(response),
+          success_from(response, action),
           message_from(response),
           response,
           authorization: authorization_from(response),
@@ -290,10 +290,22 @@ module ActiveMerchant #:nodoc:
         }
       end
 
-      def success_from(response)
-        return false if response.include?('error')
+      def success_from(response, action = nil)
+        transaction_current_status = response.dig('transaction', 'current_status')
+        request_status = response['status']
+        transaction_status = response.dig('transaction', 'status')
+        default_response = SUCCESS_STATUS.include?(transaction_current_status || request_status || transaction_status)
 
-        SUCCESS_STATUS.include?(response['status'] || response['transaction']['status'])
+        case action
+        when 'refund'
+          if transaction_current_status && request_status
+            transaction_current_status&.upcase == 'CANCELLED' && request_status&.downcase == 'success'
+          else
+            default_response
+          end
+        else
+          default_response
+        end
       end
 
       def card_success_from(response)
@@ -314,10 +326,10 @@ module ActiveMerchant #:nodoc:
       end
 
       def card_message_from(response)
-        if !response.include?('error')
-          response['message'] || response['card']['message']
-        else
+        if response.include?('error')
           response['error']['type']
+        else
+          response['message'] || response['card']['message']
         end
       end
 

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

@@ -124,12 +124,13 @@ module ActiveMerchant #:nodoc:
         return unless address = options[:billing_address] || options[:address]
 
         post[:billingDetails] = {}
-        post[:billingDetails][:street] = address[:address1]
-        post[:billingDetails][:city] = address[:city]
-        post[:billingDetails][:state] = address[:state]
+        post[:billingDetails][:street] = truncate(address[:address1], 50)
+        post[:billingDetails][:street2] = truncate(address[:address2], 50)
+        post[:billingDetails][:city] = truncate(address[:city], 40)
+        post[:billingDetails][:state] = truncate(address[:state], 40)
         post[:billingDetails][:country] = address[:country]
-        post[:billingDetails][:zip] = address[:zip]
-        post[:billingDetails][:phone] = address[:phone]
+        post[:billingDetails][:zip] = truncate(address[:zip], 10)
+        post[:billingDetails][:phone] = truncate(address[:phone], 40)
       end
 
       # The add_address_for_vaulting method is applicable to the store method, as the APIs address
@@ -138,12 +139,12 @@ module ActiveMerchant #:nodoc:
         return unless address = options[:billing_address] || options[:address]
 
         post[:card][:billingAddress] = {}
-        post[:card][:billingAddress][:street] = address[:address1]
-        post[:card][:billingAddress][:street2] = address[:address2]
-        post[:card][:billingAddress][:city] = address[:city]
-        post[:card][:billingAddress][:zip] = address[:zip]
+        post[:card][:billingAddress][:street] = truncate(address[:address1], 50)
+        post[:card][:billingAddress][:street2] = truncate(address[:address2], 50)
+        post[:card][:billingAddress][:city] = truncate(address[:city], 40)
+        post[:card][:billingAddress][:zip] = truncate(address[:zip], 10)
         post[:card][:billingAddress][:country] = address[:country]
-        post[:card][:billingAddress][:state] = address[:state] if address[:state]
+        post[:card][:billingAddress][:state] = truncate(address[:state], 40) if address[:state]
       end
 
       # This data is specific to creating a profile at the gateway's vault level
@@ -401,7 +402,7 @@ module ActiveMerchant #:nodoc:
       def post_data(parameters = {}, options = {})
         return unless parameters.present?
 
-        parameters[:merchantRefNum] = options[:merchant_ref_num] || SecureRandom.hex(16).to_s
+        parameters[:merchantRefNum] = options[:merchant_ref_num] || options[:order_id] || SecureRandom.hex(16).to_s
 
         parameters.to_json
       end

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

@@ -115,12 +115,16 @@ module ActiveMerchant #:nodoc:
 
         message = message_from(response)
         test_mode = (test? || message =~ /TESTMODE/)
-        Response.new(success?(response), message, response,
+        Response.new(
+          success?(response),
+          message,
+          response,
           test: test_mode,
           authorization: response['transactionid'],
           fraud_review: fraud_review?(response),
           avs_result: { code: response['avsresponse'] },
-          cvv_result: response['cvvresponse'])
+          cvv_result: response['cvvresponse']
+        )
       end
 
       def message_from(response)
@@ -151,8 +155,7 @@ module ActiveMerchant #:nodoc:
         post[:password]       = @options[:password]
         post[:type]           = action
 
-        request = post.merge(parameters).collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join('&')
-        request
+        post.merge(parameters).collect { |key, value| "#{key}=#{CGI.escape(value.to_s)}" }.join('&')
       end
     end
   end

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

@@ -177,9 +177,13 @@ module ActiveMerchant #:nodoc:
         response = parse(data)
         message  = message_from(response)
 
-        PaystationResponse.new(success?(response), message, response,
-          test: (response[:tm]&.casecmp('t')&.zero?),
-          authorization: response[:paystation_transaction_id])
+        PaystationResponse.new(
+          success?(response),
+          message,
+          response,
+          test: response[:tm]&.casecmp('t')&.zero?,
+          authorization: response[:paystation_transaction_id]
+        )
       end
 
       def success?(response)

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

@@ -192,9 +192,13 @@ module ActiveMerchant
 
         success = (params[:summary_code] ? (params[:summary_code] == '0') : (params[:response_code] == '00'))
 
-        Response.new(success, message, params,
+        Response.new(
+          success,
+          message,
+          params,
           test: (@options[:merchant].to_s == 'TEST'),
-          authorization: post[:order_number])
+          authorization: post[:order_number]
+        )
       rescue ActiveMerchant::ResponseError => e
         raise unless e.response.code == '403'
 

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

@@ -48,7 +48,7 @@ module ActiveMerchant #:nodoc:
         'I5'  => 'M', #  +4 and Address Match
         'I6'  => 'W', #  +4 Match
         'I7'  => 'A', #  Address Match
-        'I8'  => 'C', #  No Match
+        'I8'  => 'C' #  No Match
       }
 
       PAYWAY_WS_SUCCESS = '5000'
@@ -224,7 +224,7 @@ module ActiveMerchant #:nodoc:
       def error_code_from(response)
         return '' if success_from(response)
 
-        error = !STANDARD_ERROR_CODE_MAPPING[response['paywayCode']].nil? ? STANDARD_ERROR_CODE_MAPPING[response['paywayCode']] : STANDARD_ERROR_CODE[:processing_error]
+        error = STANDARD_ERROR_CODE_MAPPING[response['paywayCode']].nil? ? STANDARD_ERROR_CODE[:processing_error] : STANDARD_ERROR_CODE_MAPPING[response['paywayCode']]
         return error
       end
 

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

@@ -31,6 +31,7 @@ module ActiveMerchant #:nodoc:
         add_capture(post, options)
         add_metadata(post, options)
         add_3ds(post, options)
+        add_platform_adjustment(post, options)
 
         commit(:post, 'charges', post, options)
       end
@@ -81,6 +82,11 @@ module ActiveMerchant #:nodoc:
         commit(:put, "charges/#{CGI.escape(token)}/void", {}, options)
       end
 
+      # Verify a previously authorized charge.
+      def verify_3ds(session_token, options = {})
+        commit(:get, "/charges/verify?session_token=#{session_token}", nil, options)
+      end
+
       # Updates the credit card for the customer.
       def update(token, creditcard, options = {})
         post = {}
@@ -175,13 +181,23 @@ module ActiveMerchant #:nodoc:
         post[:metadata] = options[:metadata] if options[:metadata]
       end
 
+      def add_platform_adjustment(post, options)
+        post[:platform_adjustment] = options[:platform_adjustment] if options[:platform_adjustment]
+      end
+
       def add_3ds(post, options)
         if options[:three_d_secure]
           post[:three_d_secure] = {}
-          post[:three_d_secure][:version] = options[:three_d_secure][:version] if options[:three_d_secure][:version]
-          post[:three_d_secure][:eci] = options[:three_d_secure][:eci] if options[:three_d_secure][:eci]
-          post[:three_d_secure][:cavv] = options[:three_d_secure][:cavv] if options[:three_d_secure][:cavv]
-          post[:three_d_secure][:transaction_id] = options[:three_d_secure][:ds_transaction_id] || options[:three_d_secure][:xid]
+          if options[:three_d_secure][:enabled]
+            post[:three_d_secure][:enabled] = true
+            post[:three_d_secure][:fallback_ok] = options[:three_d_secure][:fallback_ok] unless options[:three_d_secure][:fallback_ok].nil?
+            post[:three_d_secure][:callback_url] = options[:three_d_secure][:callback_url] if options[:three_d_secure][:callback_url]
+          else
+            post[:three_d_secure][:version] = options[:three_d_secure][:version] if options[:three_d_secure][:version]
+            post[:three_d_secure][:eci] = options[:three_d_secure][:eci] if options[:three_d_secure][:eci]
+            post[:three_d_secure][:cavv] = options[:three_d_secure][:cavv] if options[:three_d_secure][:cavv]
+            post[:three_d_secure][:transaction_id] = options[:three_d_secure][:ds_transaction_id] || options[:three_d_secure][:xid]
+          end
         end
       end
 
@@ -266,6 +282,8 @@ module ActiveMerchant #:nodoc:
       end
 
       def post_data(parameters = {})
+        return nil unless parameters
+
         parameters.to_json
       end
     end