activemerchant 1.119.0 → 1.124.0

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

@@ -20,16 +20,20 @@ module ActiveMerchant #:nodoc:
         add_capture_method(post, options)
         add_confirmation_method(post, options)
         add_customer(post, options)
-        payment_method = add_payment_method_token(post, payment_method, options)
-        return payment_method if payment_method.is_a?(ActiveMerchant::Billing::Response)
+        result = add_payment_method_token(post, payment_method, options)
+        return result if result.is_a?(ActiveMerchant::Billing::Response)
 
         add_external_three_d_secure_auth_data(post, options)
         add_metadata(post, options)
         add_return_url(post, options)
         add_connected_account(post, options)
+        add_radar_data(post, options)
         add_shipping_address(post, options)
         setup_future_usage(post, options)
         add_exemption(post, options)
+        add_stored_credentials(post, options)
+        add_ntid(post, options)
+        add_claim_without_transaction_id(post, options)
         add_error_on_requires_action(post, options)
         request_three_d_secure(post, options)
 
@@ -46,8 +50,8 @@ module ActiveMerchant #:nodoc:
 
       def confirm_intent(intent_id, payment_method, options = {})
         post = {}
-        payment_method = add_payment_method_token(post, payment_method, options)
-        return payment_method if payment_method.is_a?(ActiveMerchant::Billing::Response)
+        result = add_payment_method_token(post, payment_method, options)
+        return result if result.is_a?(ActiveMerchant::Billing::Response)
 
         CONFIRM_INTENT_ATTRIBUTES.each do |attribute|
           add_whitelisted_attribute(post, options, attribute)
@@ -56,24 +60,31 @@ module ActiveMerchant #:nodoc:
       end
 
       def create_payment_method(payment_method, options = {})
-        post = {}
-        post[:type] = 'card'
-        post[:card] = {}
-        post[:card][:number] = payment_method.number
-        post[:card][:exp_month] = payment_method.month
-        post[:card][:exp_year] = payment_method.year
-        post[:card][:cvc] = payment_method.verification_value if payment_method.verification_value
-        add_billing_address(post, options)
+        post_data = add_payment_method_data(payment_method, options)
+
         options = format_idempotency_key(options, 'pm')
-        commit(:post, 'payment_methods', post, options)
+        commit(:post, 'payment_methods', post_data, options)
+      end
+
+      def add_payment_method_data(payment_method, options = {})
+        post_data = {}
+        post_data[:type] = 'card'
+        post_data[:card] = {}
+        post_data[:card][:number] = payment_method.number
+        post_data[:card][:exp_month] = payment_method.month
+        post_data[:card][:exp_year] = payment_method.year
+        post_data[:card][:cvc] = payment_method.verification_value if payment_method.verification_value
+        add_billing_address(post_data, options)
+        add_name_only(post_data, payment_method) if post_data[:billing_details].nil?
+        post_data
       end
 
       def update_intent(money, intent_id, payment_method, options = {})
         post = {}
         add_amount(post, money, options)
 
-        payment_method = add_payment_method_token(post, payment_method, options)
-        return payment_method if payment_method.is_a?(ActiveMerchant::Billing::Response)
+        result = add_payment_method_token(post, payment_method, options)
+        return result if result.is_a?(ActiveMerchant::Billing::Response)
 
         add_payment_method_types(post, options)
         add_customer(post, options)
@@ -90,8 +101,8 @@ module ActiveMerchant #:nodoc:
       def create_setup_intent(payment_method, options = {})
         post = {}
         add_customer(post, options)
-        payment_method = add_payment_method_token(post, payment_method, options)
-        return payment_method if payment_method.is_a?(ActiveMerchant::Billing::Response)
+        result = add_payment_method_token(post, payment_method, options)
+        return result if result.is_a?(ActiveMerchant::Billing::Response)
 
         add_metadata(post, options)
         add_return_url(post, options)
@@ -102,6 +113,17 @@ module ActiveMerchant #:nodoc:
         commit(:post, 'setup_intents', post, options)
       end
 
+      def retrieve_setup_intent(setup_intent_id)
+        # Retrieving a setup_intent passing 'expand[]=latest_attempt' allows the caller to
+        # check for a network_transaction_id and ds_transaction_id
+        # eg (latest_attempt -> payment_method_details -> card -> network_transaction_id)
+        #
+        # Being able to retrieve these fields enables payment flows that rely on MIT exemptions, e.g: off_session
+        commit(:post, "setup_intents/#{setup_intent_id}", {
+          'expand[]': 'latest_attempt'
+        }, {})
+      end
+
       def authorize(money, payment_method, options = {})
         create_intent(money, payment_method, options.merge!(confirm: true, capture_method: 'manual'))
       end
@@ -159,13 +181,12 @@ module ActiveMerchant #:nodoc:
         # If customer option is provided, create a payment method and attach to customer id
         # Otherwise, create a customer, then attach
         if payment_method.is_a?(StripePaymentToken) || payment_method.is_a?(ActiveMerchant::Billing::CreditCard)
-          payment_method = add_payment_method_token(params, payment_method, options)
-          return payment_method if payment_method.is_a?(ActiveMerchant::Billing::Response)
+          result = add_payment_method_token(params, payment_method, options)
+          return result if result.is_a?(ActiveMerchant::Billing::Response)
 
           if options[:customer]
             customer_id = options[:customer]
           else
-            post[:validate] = options[:validate] unless options[:validate].nil?
             post[:description] = options[:description] if options[:description]
             post[:email] = options[:email] if options[:email]
             options = format_idempotency_key(options, 'customer')
@@ -173,7 +194,9 @@ module ActiveMerchant #:nodoc:
             customer_id = customer.params['id']
           end
           options = format_idempotency_key(options, 'attach')
-          commit(:post, "payment_methods/#{params[:payment_method]}/attach", { customer: customer_id }, options)
+          attach_parameters = { customer: customer_id }
+          attach_parameters[:validate] = options[:validate] unless options[:validate].nil?
+          commit(:post, "payment_methods/#{params[:payment_method]}/attach", attach_parameters, options)
         else
           super(payment_method, options)
         end
@@ -194,6 +217,10 @@ module ActiveMerchant #:nodoc:
 
       private
 
+      def off_session_request?(options = {})
+        (options[:off_session] || options[:setup_future_usage]) && options[:confirm] == true
+      end
+
       def add_connected_account(post, options = {})
         super(post, options)
         post[:application_fee_amount] = options[:application_fee] if options[:application_fee]
@@ -201,25 +228,21 @@ module ActiveMerchant #:nodoc:
 
       def add_whitelisted_attribute(post, options, attribute)
         post[attribute] = options[attribute] if options[attribute]
-        post
       end
 
       def add_capture_method(post, options)
         capture_method = options[:capture_method].to_s
         post[:capture_method] = capture_method if ALLOWED_METHOD_STATES.include?(capture_method)
-        post
       end
 
       def add_confirmation_method(post, options)
         confirmation_method = options[:confirmation_method].to_s
         post[:confirmation_method] = confirmation_method if ALLOWED_METHOD_STATES.include?(confirmation_method)
-        post
       end
 
       def add_customer(post, options)
         customer = options[:customer].to_s
         post[:customer] = customer if customer.start_with?('cus_')
-        post
       end
 
       def add_return_url(post, options)
@@ -227,31 +250,39 @@ module ActiveMerchant #:nodoc:
 
         post[:confirm] = options[:confirm]
         post[:return_url] = options[:return_url] if options[:return_url]
-        post
       end
 
       def add_payment_method_token(post, payment_method, options)
-        return if payment_method.nil?
-
-        if payment_method.is_a?(ActiveMerchant::Billing::CreditCard)
-          p = create_payment_method(payment_method, options)
-          return p unless p.success?
-
-          payment_method = p.params['id']
+        case payment_method
+        when StripePaymentToken
+          post[:payment_method] = payment_method.payment_data['id']
+        when String
+          extract_token_from_string_and_maybe_add_customer_id(post, payment_method)
+        when ActiveMerchant::Billing::CreditCard
+          get_payment_method_data_from_card(post, payment_method, options)
         end
+      end
 
-        if payment_method.is_a?(StripePaymentToken)
-          post[:payment_method] = payment_method.payment_data['id']
-        elsif payment_method.is_a?(String)
-          if payment_method.include?('|')
-            customer_id, payment_method_id = payment_method.split('|')
-            token = payment_method_id
-            post[:customer] = customer_id
-          else
-            token = payment_method
-          end
-          post[:payment_method] = token
+      def extract_token_from_string_and_maybe_add_customer_id(post, payment_method)
+        if payment_method.include?('|')
+          customer_id, payment_method = payment_method.split('|')
+          post[:customer] = customer_id
         end
+
+        post[:payment_method] = payment_method
+      end
+
+      def get_payment_method_data_from_card(post, payment_method, options)
+        return create_payment_method_and_extract_token(post, payment_method, options) unless off_session_request?(options)
+
+        post[:payment_method_data] = add_payment_method_data(payment_method, options)
+      end
+
+      def create_payment_method_and_extract_token(post, payment_method, options)
+        payment_method_response = create_payment_method(payment_method, options)
+        return payment_method_response if payment_method_response.failure?
+
+        add_payment_method_token(post, payment_method_response.params['id'], options)
       end
 
       def add_payment_method_types(post, options)
@@ -259,7 +290,6 @@ module ActiveMerchant #:nodoc:
         return if payment_method_types.nil?
 
         post[:payment_method_types] = Array(payment_method_types)
-        post
       end
 
       def add_exemption(post, options = {})
@@ -270,6 +300,49 @@ module ActiveMerchant #:nodoc:
         post[:payment_method_options][:card][:moto] = true if options[:moto]
       end
 
+      # Stripe Payment Intents does not pass any parameters for cardholder/merchant initiated
+      # it also does not support installments for any country other than Mexico (reason for this is unknown)
+      # The only thing that Stripe PI requires for stored credentials to work currently is the network_transaction_id
+      # network_transaction_id is created when the card is authenticated using the field `setup_for_future_usage` with the value `off_session` see def setup_future_usage below
+
+      def add_stored_credentials(post, options = {})
+        return unless options[:stored_credential] && !options[:stored_credential].values.all?(&:nil?)
+
+        stored_credential = options[:stored_credential]
+        post[:payment_method_options] ||= {}
+        post[:payment_method_options][:card] ||= {}
+        post[:payment_method_options][:card][:mit_exemption] = {}
+
+        # Stripe PI accepts network_transaction_id and ds_transaction_id via mit field under card.
+        # The network_transaction_id can be sent in nested under stored credentials OR as its own field (add_ntid handles when it is sent in on its own)
+        # If it is sent is as its own field AND under stored credentials, the value sent under its own field is what will send.
+        post[:payment_method_options][:card][:mit_exemption][:ds_transaction_id] = stored_credential[:ds_transaction_id] if stored_credential[:ds_transaction_id]
+        post[:payment_method_options][:card][:mit_exemption][:network_transaction_id] = stored_credential[:network_transaction_id] if stored_credential[:network_transaction_id]
+      end
+
+      def add_ntid(post, options = {})
+        return unless options[:network_transaction_id]
+
+        post[:payment_method_options] ||= {}
+        post[:payment_method_options][:card] ||= {}
+        post[:payment_method_options][:card][:mit_exemption] = {}
+
+        post[:payment_method_options][:card][:mit_exemption][:network_transaction_id] = options[:network_transaction_id] if options[:network_transaction_id]
+      end
+
+      def add_claim_without_transaction_id(post, options = {})
+        return if options[:stored_credential] || options[:network_transaction_id] || options[:ds_transaction_id]
+        return unless options[:claim_without_transaction_id]
+
+        post[:payment_method_options] ||= {}
+        post[:payment_method_options][:card] ||= {}
+        post[:payment_method_options][:card][:mit_exemption] = {}
+
+        # Stripe PI accepts claim_without_transaction_id for transactions without transaction ids.
+        # Gateway validation for this field occurs through a different service, before the transaction request is sent to the gateway.
+        post[:payment_method_options][:card][:mit_exemption][:claim_without_transaction_id] = options[:claim_without_transaction_id]
+      end
+
       def add_error_on_requires_action(post, options = {})
         return unless options[:confirm]
 
@@ -299,7 +372,7 @@ module ActiveMerchant #:nodoc:
 
       def setup_future_usage(post, options = {})
         post[:setup_future_usage] = options[:setup_future_usage] if %w(on_session off_session).include?(options[:setup_future_usage])
-        post[:off_session] = options[:off_session] if options[:off_session] && options[:confirm] == true
+        post[:off_session] = options[:off_session] if off_session_request?(options)
         post
       end
 
@@ -317,7 +390,13 @@ module ActiveMerchant #:nodoc:
         post[:billing_details][:email] = billing[:email] if billing[:email]
         post[:billing_details][:name] = billing[:name] if billing[:name]
         post[:billing_details][:phone] = billing[:phone] if billing[:phone]
-        post
+      end
+
+      def add_name_only(post, payment_method)
+        post[:billing_details] = {} unless post[:billing_details]
+
+        name = [payment_method.first_name, payment_method.last_name].compact.join(' ')
+        post[:billing_details][:name] = name
       end
 
       def add_shipping_address(post, options = {})
@@ -336,7 +415,6 @@ module ActiveMerchant #:nodoc:
         post[:shipping][:carrier] = shipping[:carrier] if shipping[:carrier]
         post[:shipping][:phone] = shipping[:phone] if shipping[:phone]
         post[:shipping][:tracking_number] = shipping[:tracking_number] if shipping[:tracking_number]
-        post
       end
 
       def format_idempotency_key(options, suffix)

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

@@ -317,7 +317,8 @@ module ActiveMerchant #:nodoc:
           gsub(%r((<[^>]+pan>)[^<]+(<))i, '\1[FILTERED]\2').
           gsub(%r((<[^>]+sec>)[^<]+(<))i, '\1[FILTERED]\2').
           gsub(%r((<[^>]+id>)[^<]+(<))i, '\1[FILTERED]\2').
-          gsub(%r((<[^>]+regKey>)[^<]+(<))i, '\1[FILTERED]\2')
+          gsub(%r((<[^>]+regKey>)[^<]+(<))i, '\1[FILTERED]\2').
+          gsub(%r((<[^>]+acctNr>)[^<]+(<))i, '\1[FILTERED]\2')
       end
 
       private

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

@@ -331,7 +331,8 @@ module ActiveMerchant #:nodoc:
           gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]').
           gsub(%r((&?cc=)\d*(&?)), '\1[FILTERED]\2').
           gsub(%r((&?password=)[^&]+(&?)), '\1[FILTERED]\2').
-          gsub(%r((&?cvv=)\d*(&?)), '\1[FILTERED]\2')
+          gsub(%r((&?cvv=)\d*(&?)), '\1[FILTERED]\2').
+          gsub(%r((&?account=)\d*(&?)), '\1[FILTERED]\2')
       end
 
       private

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

@@ -343,7 +343,7 @@ module ActiveMerchant #:nodoc:
         parameters[:software] = 'Active Merchant'
         parameters[:testmode] = (@options[:test] ? 1 : 0) unless parameters.has_key?(:testmode)
         seed = SecureRandom.hex(32).upcase
-        hash = Digest::SHA1.hexdigest("#{parameters[:command]}:#{@options[:password]}:#{parameters[:amount]}:#{parameters[:invoice]}:#{seed}")
+        hash = Digest::SHA1.hexdigest("#{parameters[:command]}:#{@options[:pin] || @options[:password]}:#{parameters[:amount]}:#{parameters[:invoice]}:#{seed}")
         parameters[:hash] = "s/#{seed}/#{hash}/n"
 
         parameters.collect { |key, value| "UM#{key}=#{CGI.escape(value.to_s)}" }.join('&')

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

@@ -0,0 +1,220 @@
+require 'digest'
+require 'jwe'
+
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class VposGateway < Gateway
+      self.test_url = 'https://vpos.infonet.com.py:8888'
+      self.live_url = 'https://vpos.infonet.com.py'
+
+      self.supported_countries = ['PY']
+      self.default_currency = 'PYG'
+      self.supported_cardtypes = %i[visa master]
+
+      self.homepage_url = 'https://comercios.bancard.com.py'
+      self.display_name = 'vPOS'
+
+      self.money_format = :dollars
+
+      ENDPOINTS = {
+        pci_encryption_key: '/vpos/api/0.3/application/encryption-key',
+        pay_pci_buy_encrypted: '/vpos/api/0.3/pci/encrypted',
+        pci_buy_rollback: '/vpos/api/0.3/pci_buy/rollback',
+        refund: '/vpos/api/0.3/refunds'
+      }
+
+      def initialize(options = {})
+        requires!(options, :private_key, :public_key)
+        @private_key = options[:private_key]
+        @public_key = options[:public_key]
+        @shop_process_id = options[:shop_process_id] || SecureRandom.random_number(10**15)
+        super
+      end
+
+      def purchase(money, payment, options = {})
+        commerce = options[:commerce] || @options[:commerce]
+        commerce_branch = options[:commerce_branch] || @options[:commerce_branch]
+        shop_process_id = options[:shop_process_id] || @shop_process_id
+
+        token = generate_token(shop_process_id, 'pay_pci', commerce, commerce_branch, amount(money), currency(money))
+
+        post = {}
+        post[:token] = token
+        post[:commerce] = commerce.to_s
+        post[:commerce_branch] = commerce_branch.to_s
+        post[:shop_process_id] = shop_process_id
+        post[:number_of_payments] = options[:number_of_payments] || 1
+        post[:recursive] = options[:recursive] || false
+
+        add_invoice(post, money, options)
+        add_card_data(post, payment)
+        add_customer_data(post, options)
+
+        commit(:pay_pci_buy_encrypted, post)
+      end
+
+      def void(authorization, options = {})
+        _, shop_process_id = authorization.to_s.split('#')
+        token = generate_token(shop_process_id, 'rollback', '0.00')
+        post = {
+          token: token,
+          shop_process_id: shop_process_id
+        }
+        commit(:pci_buy_rollback, post)
+      end
+
+      def credit(money, payment, options = {})
+        # Not permitted for foreign cards.
+        commerce = options[:commerce] || @options[:commerce]
+        commerce_branch = options[:commerce_branch] || @options[:commerce_branch]
+
+        token = generate_token(@shop_process_id, 'refund', commerce, commerce_branch, amount(money), currency(money))
+        post = {}
+        post[:token] = token
+        post[:commerce] = commerce.to_i
+        post[:commerce_branch] = commerce_branch.to_i
+        post[:shop_process_id] = @shop_process_id
+        add_invoice(post, money, options)
+        add_card_data(post, payment)
+        add_customer_data(post, options)
+        post[:origin_shop_process_id] = options[:original_shop_process_id] if options[:original_shop_process_id]
+        commit(:refund, post)
+      end
+
+      def refund(money, authorization, options = {})
+        commerce = options[:commerce] || @options[:commerce]
+        commerce_branch = options[:commerce_branch] || @options[:commerce_branch]
+        shop_process_id = options[:shop_process_id] || @shop_process_id
+        _, original_shop_process_id = authorization.to_s.split('#')
+
+        token = generate_token(shop_process_id, 'refund', commerce, commerce_branch, amount(money), currency(money))
+        post = {}
+        post[:token] = token
+        post[:commerce] = commerce.to_i
+        post[:commerce_branch] = commerce_branch.to_i
+        post[:shop_process_id] = shop_process_id
+        add_invoice(post, money, options)
+        add_customer_data(post, options)
+        post[:origin_shop_process_id] = original_shop_process_id || options[:original_shop_process_id]
+        commit(:refund, post)
+      end
+
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        clean_transcript = remove_invalid_utf_8_byte_sequences(transcript)
+        clean_transcript.
+          gsub(/(token\\":\\")[.\-\w]+/, '\1[FILTERED]').
+          gsub(/(card_encrypted_data\\":\\")[.\-\w]+/, '\1[FILTERED]')
+      end
+
+      def remove_invalid_utf_8_byte_sequences(transcript)
+        transcript.encode('UTF-8', 'binary', undef: :replace, replace: '')
+      end
+
+      private
+
+      # Required to encrypt PAN data.
+      def one_time_public_key
+        token = generate_token('get_encription_public_key', @public_key)
+        response = commit(:pci_encryption_key, token: token)
+        OpenSSL::PKey::RSA.new(response.params['encryption_key'])
+      end
+
+      def generate_token(*elements)
+        Digest::MD5.hexdigest(@private_key + elements.join)
+      end
+
+      def add_invoice(post, money, options)
+        post[:amount] = amount(money)
+        post[:currency] = options[:currency] || currency(money)
+      end
+
+      def add_card_data(post, payment)
+        card_number = payment.number
+        cvv = payment.verification_value
+
+        payload = { card_number: card_number, 'cvv': cvv }.to_json
+
+        post[:card_encrypted_data] = JWE.encrypt(payload, one_time_public_key)
+        post[:card_month_expiration] = format(payment.month, :two_digits)
+        post[:card_year_expiration] = format(payment.year, :two_digits)
+      end
+
+      def add_customer_data(post, options)
+        post[:additional_data] = options[:additional_data] || '' # must be passed even if empty
+      end
+
+      def parse(body)
+        JSON.parse(body)
+      end
+
+      def commit(action, parameters)
+        url = build_request_url(action)
+        begin
+          response = parse(ssl_post(url, post_data(parameters)))
+        rescue ResponseError => response
+          # Errors are returned with helpful data,
+          # but get filtered out by `ssl_post` because of their HTTP status.
+          response = parse(response.response.body)
+        end
+
+        Response.new(
+          success_from(response),
+          message_from(response),
+          response,
+          authorization: authorization_from(response),
+          avs_result: nil,
+          cvv_result: nil,
+          test: test?,
+          error_code: error_code_from(response)
+        )
+      end
+
+      def success_from(response)
+        if code = response.dig('confirmation', 'response_code')
+          code == '00'
+        else
+          response['status'] == 'success'
+        end
+      end
+
+      def message_from(response)
+        %w(confirmation refund).each do |m|
+          message =
+            response.dig(m, 'extended_response_description') ||
+            response.dig(m, 'response_description') ||
+            response.dig(m, 'response_details')
+          return message if message
+        end
+        [response.dig('messages', 0, 'key'), response.dig('messages', 0, 'dsc')].join(':')
+      end
+
+      def authorization_from(response)
+        response_body = response.dig('confirmation') || response.dig('refund')
+        return unless response_body
+
+        authorization_number = response_body.dig('authorization_number') || response_body.dig('authorization_code')
+        shop_process_id = response_body.dig('shop_process_id')
+
+        "#{authorization_number}##{shop_process_id}"
+      end
+
+      def error_code_from(response)
+        response.dig('confirmation', 'response_code') unless success_from(response)
+      end
+
+      def build_request_url(action)
+        base_url = (test? ? test_url : live_url)
+        base_url + ENDPOINTS[action]
+      end
+
+      def post_data(data)
+        { public_key: @public_key,
+          operation: data }.compact.to_json
+      end
+    end
+  end
+end