activemerchant 1.119.0 → 1.124.0

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

@@ -71,7 +71,7 @@ module ActiveMerchant #:nodoc:
       def capture(money, authorization, options = {})
         authorization = order_id_from_authorization(authorization.to_s)
         MultiResponse.run do |r|
-          r.process { inquire_request(authorization, options, 'AUTHORISED') } unless options[:authorization_validated]
+          r.process { inquire_request(authorization, options, 'AUTHORISED', 'CAPTURED') } unless options[:authorization_validated]
           if r.params
             authorization_currency = r.params['amount_currency_code']
             options = options.merge(currency: authorization_currency) if authorization_currency.present?
@@ -90,8 +90,10 @@ module ActiveMerchant #:nodoc:
 
       def refund(money, authorization, options = {})
         authorization = order_id_from_authorization(authorization.to_s)
+        success_criteria = %w(CAPTURED SETTLED SETTLED_BY_MERCHANT SENT_FOR_REFUND)
+        success_criteria.push('AUTHORIZED') if options[:cancel_or_refund]
         response = MultiResponse.run do |r|
-          r.process { inquire_request(authorization, options, 'CAPTURED', 'SETTLED', 'SETTLED_BY_MERCHANT') } unless options[:authorization_validated]
+          r.process { inquire_request(authorization, options, *success_criteria) } unless options[:authorization_validated]
           r.process { refund_request(money, authorization, options) }
         end
 
@@ -113,8 +115,9 @@ module ActiveMerchant #:nodoc:
       end
 
       def verify(payment_method, options = {})
+        amount = (eligible_for_0_auth?(payment_method, options) ? 0 : 100)
         MultiResponse.run(:use_first_response) do |r|
-          r.process { authorize(100, payment_method, options) }
+          r.process { authorize(amount, payment_method, options) }
           r.process(:ignore_result) { void(r.authorization, options.merge(authorization_validated: true)) }
         end
       end
@@ -128,6 +131,10 @@ module ActiveMerchant #:nodoc:
         true
       end
 
+      def supports_network_tokenization?
+        true
+      end
+
       def scrub(transcript)
         transcript.
           gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
@@ -138,11 +145,11 @@ module ActiveMerchant #:nodoc:
       private
 
       def authorize_request(money, payment_method, options)
-        commit('authorize', build_authorization_request(money, payment_method, options), 'AUTHORISED', options)
+        commit('authorize', build_authorization_request(money, payment_method, options), 'AUTHORISED', 'CAPTURED', options)
       end
 
       def capture_request(money, authorization, options)
-        commit('capture', build_capture_request(money, authorization, options), :ok, options)
+        commit('capture', build_capture_request(money, authorization, options), 'CAPTURED', :ok, options)
       end
 
       def cancel_request(authorization, options)
@@ -154,7 +161,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def refund_request(money, authorization, options)
-        commit('refund', build_refund_request(money, authorization, options), :ok, options)
+        commit('refund', build_refund_request(money, authorization, options), :ok, 'SENT_FOR_REFUND', options)
       end
 
       def credit_request(money, payment_method, options)
@@ -206,7 +213,9 @@ module ActiveMerchant #:nodoc:
               end
               add_payment_method(xml, money, payment_method, options)
               add_shopper(xml, options)
+              add_statement_narrative(xml, options)
               add_risk_data(xml, options[:risk_data]) if options[:risk_data]
+              add_sub_merchant_data(xml, options[:sub_merchant_data]) if options[:sub_merchant_data]
               add_hcg_additional_data(xml, options) if options[:hcg_additional_data]
               add_instalments_data(xml, options) if options[:instalments]
               add_moto_flag(xml, options) if options.dig(:metadata, :manual_entry)
@@ -232,13 +241,22 @@ module ActiveMerchant #:nodoc:
       end
 
       def build_void_request(authorization, options)
-        build_order_modify_request(authorization, &:cancel)
+        if options[:cancel_or_refund]
+          build_order_modify_request(authorization, &:cancelOrRefund)
+        else
+          build_order_modify_request(authorization, &:cancel)
+        end
       end
 
       def build_refund_request(money, authorization, options)
         build_order_modify_request(authorization) do |xml|
-          xml.refund do
-            add_amount(xml, money, options.merge(debit_credit_indicator: 'credit'))
+          if options[:cancel_or_refund]
+            # Worldpay docs claim amount must be passed. This causes an error.
+            xml.cancelOrRefund # { add_amount(xml, money, options.merge(debit_credit_indicator: 'credit')) }
+          else
+            xml.refund do
+              add_amount(xml, money, options.merge(debit_credit_indicator: 'credit'))
+            end
           end
         end
       end
@@ -297,6 +315,20 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def add_sub_merchant_data(xml, options)
+        xml.subMerchantData do
+          xml.pfId options[:pf_id] if options[:pf_id]
+          xml.subName options[:sub_name] if options[:sub_name]
+          xml.subId options[:sub_id] if options[:sub_id]
+          xml.subStreet options[:sub_street] if options[:sub_street]
+          xml.subCity options[:sub_city] if options[:sub_city]
+          xml.subState options[:sub_state] if options[:sub_state]
+          xml.subCountryCode options[:sub_country_code] if options[:sub_country_code]
+          xml.subPostalCode options[:sub_postal_code] if options[:sub_postal_code]
+          xml.subTaxId options[:sub_tax_id] if options[:sub_tax_id]
+        end
+      end
+
       def add_shopper_account_risk_data(xml, shopper_account_risk_data)
         return unless shopper_account_risk_data
 
@@ -381,6 +413,8 @@ module ActiveMerchant #:nodoc:
               add_amount(xml, amount, options)
             end
           end
+        elsif options[:payment_type] == :network_token
+          add_network_tokenization_card(xml, payment_method)
         else
           xml.paymentDetails credit_fund_transfer_attribute(options) do
             if options[:payment_type] == :token
@@ -399,7 +433,6 @@ module ActiveMerchant #:nodoc:
               xml.session 'shopperIPAddress' => options[:ip] if options[:ip]
               xml.session 'id' => options[:session_id] if options[:session_id]
             end
-
             if three_d_secure = options[:three_d_secure]
               add_three_d_secure(three_d_secure, xml)
             end
@@ -407,10 +440,26 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def add_network_tokenization_card(xml, payment_method)
+        xml.paymentDetails do
+          xml.tag! 'EMVCO_TOKEN-SSL', 'type' => 'NETWORKTOKEN' do
+            xml.tokenNumber payment_method.number
+            xml.expiryDate do
+              xml.date(
+                'month' => format(payment_method.month, :two_digits),
+                'year' => format(payment_method.year, :four_digits_year)
+              )
+            end
+            xml.cryptogram payment_method.payment_cryptogram
+            xml.eciIndicator format(payment_method.eci, :two_digits)
+          end
+        end
+      end
+
       def add_three_d_secure(three_d_secure, xml)
         xml.info3DSecure do
           xml.threeDSVersion three_d_secure[:version]
-          if /^2/.match?(three_d_secure[:version])
+          if three_d_secure[:version] && three_d_secure[:ds_transaction_id]
             xml.dsTransactionId three_d_secure[:ds_transaction_id]
           else
             xml.xid three_d_secure[:xid]
@@ -425,11 +474,11 @@ module ActiveMerchant #:nodoc:
         xml.expiryDate do
           xml.date(
             'month' => format(payment_method.month, :two_digits),
-            'year' => format(payment_method.year, :four_digits)
+            'year' => format(payment_method.year, :four_digits_year)
           )
         end
 
-        card_holder_name = options[:execute_threed] && !options[:three_ds_version]&.start_with?('2') ? '3D' : payment_method.name
+        card_holder_name = test? && options[:execute_threed] && !options[:three_ds_version]&.start_with?('2') ? '3D' : payment_method.name
         xml.cardHolderName card_holder_name
         xml.cvc payment_method.verification_value
 
@@ -485,6 +534,10 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def add_statement_narrative(xml, options)
+        xml.statementNarrative truncate(options[:statement_narrative], 50) if options[:statement_narrative]
+      end
+
       def add_authenticated_shopper_id(xml, options)
         xml.authenticatedShopperID options[:customer] if options[:customer]
       end
@@ -538,11 +591,10 @@ module ActiveMerchant #:nodoc:
 
       def default_address
         {
-          address1: 'N/A',
           zip: '0000',
+          country: 'US',
           city: 'N/A',
-          state: 'N/A',
-          country: 'US'
+          address1: 'N/A'
         }
       end
 
@@ -654,7 +706,9 @@ module ActiveMerchant #:nodoc:
       #   - An array of strings if one of many responses could be considered a
       #     success.
       def success_criteria_success?(raw, success_criteria)
-        success_criteria.include?(raw[:last_event]) || raw[:ok].present?
+        return if raw[:error]
+
+        raw[:ok].present? || (success_criteria.include?(raw[:last_event]) if raw[:last_event])
       end
 
       def action_success?(action, raw)
@@ -717,7 +771,9 @@ module ActiveMerchant #:nodoc:
 
       def payment_details_from(payment_method)
         payment_details = {}
-        if payment_method.respond_to?(:number)
+        if payment_method.is_a?(NetworkTokenizationCreditCard) && payment_method.source == :network_token
+          payment_details[:payment_type] = :network_token
+        elsif payment_method.respond_to?(:number)
           payment_details[:payment_type] = :credit
         else
           token_details = token_details_from_authorization(payment_method)
@@ -753,6 +809,10 @@ module ActiveMerchant #:nodoc:
       def card_code_for(payment_method)
         CARD_CODES[card_brand(payment_method)] || CARD_CODES['unknown']
       end
+
+      def eligible_for_0_auth?(payment_method, options = {})
+        payment_method.is_a?(CreditCard) && %w(visa master).include?(payment_method.brand) && options[:zero_dollar_auth]
+      end
     end
   end
 end

data/lib/active_merchant/billing/response.rb

@@ -10,6 +10,10 @@ module ActiveMerchant #:nodoc:
         @success
       end
 
+      def failure?
+        !success?
+      end
+
       def test?
         @test
       end

data/lib/active_merchant/billing/three_d_secure_eci_mapper.rb

@@ -0,0 +1,27 @@
+module ActiveMerchant
+  module Billing
+    module ThreeDSecureEciMapper
+      NON_THREE_D_SECURE_TRANSACTION = :non_three_d_secure_transaction
+      ATTEMPTED_AUTHENTICATION_TRANSACTION = :attempted_authentication_transaction
+      FULLY_AUTHENTICATED_TRANSACTION = :fully_authenticated_transaction
+
+      ECI_00_01_02_MAP = { '00' => NON_THREE_D_SECURE_TRANSACTION, '01' => ATTEMPTED_AUTHENTICATION_TRANSACTION, '02' => FULLY_AUTHENTICATED_TRANSACTION }.freeze
+      ECI_05_06_07_MAP = { '05' => FULLY_AUTHENTICATED_TRANSACTION, '06' => ATTEMPTED_AUTHENTICATION_TRANSACTION, '07' => NON_THREE_D_SECURE_TRANSACTION }.freeze
+      BRAND_TO_ECI_MAP = {
+        american_express: ECI_05_06_07_MAP,
+        dankort: ECI_05_06_07_MAP,
+        diners_club: ECI_05_06_07_MAP,
+        discover: ECI_05_06_07_MAP,
+        elo: ECI_05_06_07_MAP,
+        jcb: ECI_05_06_07_MAP,
+        maestro: ECI_00_01_02_MAP,
+        master: ECI_00_01_02_MAP,
+        visa: ECI_05_06_07_MAP
+      }.freeze
+
+      def self.map(brand, eci)
+        BRAND_TO_ECI_MAP.dig(brand, eci)
+      end
+    end
+  end
+end

data/lib/active_merchant/billing.rb

@@ -13,3 +13,4 @@ require 'active_merchant/billing/apple_pay_payment_token'
 require 'active_merchant/billing/response'
 require 'active_merchant/billing/gateways'
 require 'active_merchant/billing/gateway'
+require 'active_merchant/billing/three_d_secure_eci_mapper'

data/lib/active_merchant/version.rb

@@ -1,3 +1,3 @@
 module ActiveMerchant
-  VERSION = '1.119.0'
+  VERSION = '1.124.0'
 end