swiss-activemerchant 1.0.1

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

@@ -0,0 +1,587 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class CheckoutV2Gateway < Gateway
+      self.display_name = 'Checkout.com Unified Payments'
+      self.homepage_url = 'https://www.checkout.com/'
+      self.live_url = 'https://api.checkout.com'
+      self.test_url = 'https://api.sandbox.checkout.com'
+
+      self.supported_countries = %w[AD AE AR AT AU BE BG BH BR CH CL CN CO CY CZ DE DK EE EG ES FI FR GB GR HK HR HU IE IS IT JO JP KW LI LT LU LV MC MT MX MY NL NO NZ OM PE PL PT QA RO SA SE SG SI SK SM TR US]
+      self.default_currency = 'USD'
+      self.money_format = :cents
+      self.supported_cardtypes = %i[visa master american_express diners_club maestro discover jcb mada bp_plus]
+      self.currencies_without_fractions = %w(BIF DJF GNF ISK KMF XAF CLF XPF JPY PYG RWF KRW VUV VND XOF)
+      self.currencies_with_three_decimal_places = %w(BHD LYD JOD KWD OMR TND)
+
+      SUCCESS_CODES = %w{10000 10008 10011 10076 10077 10081}.freeze
+
+      SOFT_DECLINE_CODES = %w{
+        20001 20002 20003 20005 20006 20009 20010 20012 20013 20014 20017
+        20018 20019 20020 20021 20022 20023 20024 20025 20026 20027 20028
+        20029 20030 20031 20032 20038 20039 20040 20042 20044 20046 20051
+        20052 20053 20054 20055 20056 20057 20058 20059 20060 20061 20062
+        20063 20064 20065 20066 20067 20068 20075 20078 20082 20083 20084
+        20085 20086 20087 20088 20089 20090 20091 20092 20093 20094 20095
+        20096 20097 20098 20099 2006P 200N0 200N7 200O5 200P1 200P9 200R1
+        200R3 200S4 200T2 200T3 200T5 20100 20101 20102 20103 20104 20105
+        20106 20107 20108 20109 20110 20111 20112 20113 20114 20115 20116
+        20117 20118 20119 20120 20121 20123 20124 20150 20151 20152 20153
+        20154 20155 20156 20157 20158 20179 20182 20183 20193
+      }.freeze
+      LIVE_ACCESS_TOKEN_URL = 'https://access.checkout.com/connect/token'
+      TEST_ACCESS_TOKEN_URL = 'https://access.sandbox.checkout.com/connect/token'
+
+      def initialize(options = {})
+        @options = options
+        @access_token = nil
+        @response_http_code = nil
+
+        if options.has_key?(:secret_key)
+          requires!(options, :secret_key)
+        else
+          requires!(options, :client_id, :client_secret)
+          @access_token = setup_access_token
+        end
+
+        super
+      end
+
+      def purchase(amount, payment_method, options = {})
+        post = {}
+        build_auth_or_purchase(post, amount, payment_method, options)
+
+        commit(:purchase, post, options)
+      end
+
+      def authorize(amount, payment_method, options = {})
+        post = {}
+        post[:capture] = false
+        build_auth_or_purchase(post, amount, payment_method, options)
+        options[:incremental_authorization] ? commit(:incremental_authorize, post, options, options[:incremental_authorization]) : commit(:authorize, post, options)
+      end
+
+      def capture(amount, authorization, options = {})
+        post = {}
+        post[:capture_type] = options[:capture_type] || 'Final'
+        add_invoice(post, amount, options)
+        add_customer_data(post, options)
+        add_shipping_address(post, options)
+        add_metadata(post, options)
+
+        commit(:capture, post, options, authorization)
+      end
+
+      def credit(amount, payment, options = {})
+        post = {}
+        post[:instruction] = {}
+        post[:instruction][:funds_transfer_type] = options[:funds_transfer_type] || 'FD'
+        add_processing_channel(post, options)
+        add_invoice(post, amount, options)
+        add_payment_method(post, payment, options, :destination)
+        add_source(post, payment, options)
+
+        commit(:credit, post, options)
+      end
+
+      def void(authorization, _options = {})
+        post = {}
+        add_metadata(post, options)
+
+        commit(:void, post, options, authorization)
+      end
+
+      def refund(amount, authorization, options = {})
+        post = {}
+        add_invoice(post, amount, options)
+        add_customer_data(post, options)
+        add_metadata(post, options)
+
+        commit(:refund, post, options, authorization)
+      end
+
+      def verify(credit_card, options = {})
+        authorize(0, credit_card, options)
+      end
+
+      def verify_payment(authorization, option = {})
+        commit(:verify_payment, nil, options, authorization, :get)
+      end
+
+      def supports_scrubbing?
+        true
+      end
+
+      def scrub(transcript)
+        transcript.
+          gsub(/(Authorization: )[^\\]*/i, '\1[FILTERED]').
+          gsub(/("number\\":\\")\d+/, '\1[FILTERED]').
+          gsub(/("cvv\\":\\")\d+/, '\1[FILTERED]').
+          gsub(/("cryptogram\\":\\")\w+/, '\1[FILTERED]').
+          gsub(/(source\\":\{.*\\"token\\":\\")\d+/, '\1[FILTERED]').
+          gsub(/("token\\":\\")\w+/, '\1[FILTERED]')
+      end
+
+      def store(payment_method, options = {})
+        post = {}
+        MultiResponse.run do |r|
+          if payment_method.is_a?(NetworkTokenizationCreditCard)
+            r.process { verify(payment_method, options) }
+            break r unless r.success?
+
+            r.params['source']['customer'] = r.params['customer']
+            r.process { response(:store, true, r.params['source']) }
+          else
+            r.process { tokenize(payment_method, options) }
+            break r unless r.success?
+
+            token = r.params['token']
+            add_payment_method(post, token, options)
+            post.merge!(post.delete(:source))
+            add_customer_data(post, options)
+            add_shipping_address(post, options)
+            r.process { commit(:store, post, options) }
+          end
+        end
+      end
+
+      def unstore(id, options = {})
+        commit(:unstore, nil, options, id, :delete)
+      end
+
+      private
+
+      def build_auth_or_purchase(post, amount, payment_method, options)
+        add_invoice(post, amount, options)
+        add_authorization_type(post, options)
+        add_payment_method(post, payment_method, options)
+        add_customer_data(post, options)
+        add_extra_customer_data(post, payment_method, options)
+        add_shipping_address(post, options)
+        add_stored_credential_options(post, options)
+        add_transaction_data(post, options)
+        add_3ds(post, options)
+        add_metadata(post, options, payment_method)
+        add_processing_channel(post, options)
+        add_marketplace_data(post, options)
+      end
+
+      def add_invoice(post, money, options)
+        post[:amount] = localized_amount(money, options[:currency])
+        post[:reference] = options[:order_id]
+        post[:currency] = options[:currency] || currency(money)
+        if options[:descriptor_name] || options[:descriptor_city]
+          post[:billing_descriptor] = {}
+          post[:billing_descriptor][:name] = options[:descriptor_name] if options[:descriptor_name]
+          post[:billing_descriptor][:city] = options[:descriptor_city] if options[:descriptor_city]
+        end
+        post[:metadata] = {}
+        post[:metadata][:udf5] = application_id || 'ActiveMerchant'
+      end
+
+      def add_authorization_type(post, options)
+        post[:authorization_type] = options[:authorization_type] if options[:authorization_type]
+      end
+
+      def add_metadata(post, options, payment_method = nil)
+        post[:metadata] = {} unless post[:metadata]
+        post[:metadata].merge!(options[:metadata]) if options[:metadata]
+        post[:metadata][:udf1] = 'mada' if payment_method.try(:brand) == 'mada'
+      end
+
+      def add_payment_method(post, payment_method, options, key = :source)
+        post[key] = {}
+        case payment_method
+        when NetworkTokenizationCreditCard
+          token_type = token_type_from(payment_method)
+          cryptogram = payment_method.payment_cryptogram
+          eci = payment_method.eci || options[:eci]
+          eci ||= '05' if token_type == 'vts'
+
+          post[key][:type] = 'network_token'
+          post[key][:token] = payment_method.number
+          post[key][:token_type] = token_type
+          post[key][:cryptogram] = cryptogram if cryptogram
+          post[key][:eci] = eci if eci
+        when ->(pm) { pm.try(:credit_card?) }
+          post[key][:type] = 'card'
+          post[key][:name] = payment_method.name
+          post[key][:number] = payment_method.number
+          post[key][:cvv] = payment_method.verification_value
+          post[key][:stored] = 'true' if options[:card_on_file] == true
+          if options[:account_holder_type]
+            post[key][:account_holder] = {}
+            post[key][:account_holder][:type] = options[:account_holder_type]
+            post[key][:account_holder][:first_name] = payment_method.first_name if payment_method.first_name
+            post[key][:account_holder][:last_name] = payment_method.last_name if payment_method.last_name
+          else
+            post[key][:first_name] = payment_method.first_name if payment_method.first_name
+            post[key][:last_name] = payment_method.last_name if payment_method.last_name
+          end
+        end
+        if payment_method.is_a?(String)
+          if /tok/.match?(payment_method)
+            post[:source][:type] = 'token'
+            post[:source][:token] = payment_method
+          elsif /src/.match?(payment_method)
+            post[key][:type] = 'id'
+            post[key][:id] = payment_method
+          else
+            add_source(post, payment_method, options)
+          end
+        elsif payment_method.try(:year)
+          post[key][:expiry_year] = format(payment_method.year, :four_digits)
+          post[key][:expiry_month] = format(payment_method.month, :two_digits)
+        end
+      end
+
+      def add_source(post, payment_method, options)
+        post[:source] = {}
+
+        case payment_method
+        when 'paypal'
+          post[:source][:type] = payment_method
+        when 'sofort'
+          post[:source][:type] = payment_method
+        when 'klarna'
+          post[:source][:type] = payment_method
+          post[:source][:account_holder] = {}
+          post[:source][:account_holder][:first_name] = options[:first_name] if options[:first_name]
+          post[:source][:account_holder][:last_name] = options[:last_name] if options[:last_name]
+          post[:source][:account_holder][:email] = options[:email] || nil
+          post[:source][:account_holder][:phone] = {}
+          post[:source][:account_holder][:phone][:country_code] = options[:phone_country_code] if options[:phone_country_code]
+          post[:source][:account_holder][:phone][:number] = options[:phone] || options.dig(:billing_address, :phone) || options.dig(:billing_address, :phone_number)
+        when 'giropay'
+          post[:source][:type] = payment_method
+          post[:source][:account_holder] = {}
+          post[:source][:account_holder][:first_name] = options[:first_name] if options[:first_name]
+          post[:source][:account_holder][:last_name] = options[:last_name] if options[:last_name]
+        else
+          post[:source][:type] = options[:source_type] if options[:source_type]
+          post[:source][:id] = options[:source_id] if options[:source_id]
+        end
+      end
+
+      def add_customer_data(post, options)
+        post[:customer] = {}
+        post[:customer][:email] = options[:email] || nil
+        post[:payment_ip] = options[:ip] if options[:ip]
+        address = options[:billing_address]
+        if address && post[:source]
+          post[:source][:billing_address] = {}
+          post[:source][:billing_address][:address_line1] = address[:address1] unless address[:address1].blank?
+          post[:source][:billing_address][:address_line2] = address[:address2] unless address[:address2].blank?
+          post[:source][:billing_address][:city] = address[:city] unless address[:city].blank?
+          post[:source][:billing_address][:state] = address[:state] unless address[:state].blank?
+          post[:source][:billing_address][:country] = address[:country] unless address[:country].blank?
+          post[:source][:billing_address][:zip] = address[:zip] unless address[:zip].blank?
+        end
+      end
+
+      # created a separate method for these fields because they should not be included
+      # in all transaction types that include methods with source and customer fields
+      def add_extra_customer_data(post, payment_method, options)
+        post[:source][:phone] = {}
+        post[:source][:phone][:number] = options[:phone] || options.dig(:billing_address, :phone) || options.dig(:billing_address, :phone_number)
+        post[:source][:phone][:country_code] = options[:phone_country_code] if options[:phone_country_code]
+        post[:customer][:name] = payment_method.name if payment_method.respond_to?(:name)
+      end
+
+      def add_shipping_address(post, options)
+        if address = options[:shipping_address]
+          post[:shipping] = {}
+          post[:shipping][:address] = {}
+          post[:shipping][:address][:address_line1] = address[:address1] unless address[:address1].blank?
+          post[:shipping][:address][:address_line2] = address[:address2] unless address[:address2].blank?
+          post[:shipping][:address][:city] = address[:city] unless address[:city].blank?
+          post[:shipping][:address][:state] = address[:state] unless address[:state].blank?
+          post[:shipping][:address][:country] = address[:country] unless address[:country].blank?
+          post[:shipping][:address][:zip] = address[:zip] unless address[:zip].blank?
+        end
+      end
+
+      def add_transaction_data(post, options = {})
+        post[:payment_type] = 'Regular' if options[:transaction_indicator] == 1
+        post[:payment_type] = 'Recurring' if options[:transaction_indicator] == 2
+        post[:payment_type] = 'MOTO' if options[:transaction_indicator] == 3 || options.dig(:metadata, :manual_entry)
+        post[:previous_payment_id] = options[:previous_charge_id] if options[:previous_charge_id]
+      end
+
+      def merchant_initiated_override(post, options)
+        post[:merchant_initiated] = true
+        post[:source][:stored] = true
+        post[:previous_payment_id] = options[:merchant_initiated_transaction_id]
+      end
+
+      def add_stored_credentials_using_normalized_fields(post, options)
+        if options[:stored_credential][:initial_transaction] == true
+          post[:merchant_initiated] = false
+        else
+          post[:source][:stored] = true
+          post[:previous_payment_id] = options[:stored_credential][:network_transaction_id] if options[:stored_credential][:network_transaction_id]
+          post[:merchant_initiated] = true
+        end
+      end
+
+      def add_stored_credential_options(post, options = {})
+        return unless options[:stored_credential]
+
+        post[:payment_type] = 'Recurring' if %w(recurring installment).include? options[:stored_credential][:reason_type]
+
+        if options[:merchant_initiated_transaction_id]
+          merchant_initiated_override(post, options)
+        else
+          add_stored_credentials_using_normalized_fields(post, options)
+        end
+      end
+
+      def add_3ds(post, options)
+        if options[:three_d_secure] || options[:execute_threed]
+          post[:'3ds'] = {}
+          post[:'3ds'][:enabled] = true
+          post[:success_url] = options[:redirect_links][:success_url] if options[:redirect_links]
+          post[:failure_url] = options[:redirect_links][:failure_url] if options[:redirect_links]
+          post[:'3ds'][:attempt_n3d] = options[:attempt_n3d] if options[:attempt_n3d]
+          post[:'3ds'][:challenge_indicator] = options[:challenge_indicator] if options[:challenge_indicator]
+          post[:'3ds'][:exemption] = options[:exemption] if options[:exemption]
+        end
+
+        if options[:three_d_secure]
+          post[:'3ds'][:eci] = options[:three_d_secure][:eci] if options[:three_d_secure][:eci]
+          post[:'3ds'][:cryptogram] = options[:three_d_secure][:cavv] if options[:three_d_secure][:cavv]
+          post[:'3ds'][:version] = options[:three_d_secure][:version] if options[:three_d_secure][:version]
+          post[:'3ds'][:xid] = options[:three_d_secure][:ds_transaction_id] || options[:three_d_secure][:xid]
+          post[:'3ds'][:status] = options[:three_d_secure][:authentication_response_status]
+        end
+      end
+
+      def add_processing_channel(post, options)
+        post[:processing_channel_id] = options[:processing_channel_id] if options[:processing_channel_id]
+      end
+
+      def add_marketplace_data(post, options)
+        if options[:marketplace]
+          post[:marketplace] = {}
+          post[:marketplace][:sub_entity_id] = options[:marketplace][:sub_entity_id] if options[:marketplace][:sub_entity_id]
+        end
+      end
+
+      def access_token_header
+        {
+          'Authorization' => "Basic #{Base64.encode64("#{@options[:client_id]}:#{@options[:client_secret]}").delete("\n")}",
+          'Content-Type' => 'application/x-www-form-urlencoded'
+        }
+      end
+
+      def access_token_url
+        test? ? TEST_ACCESS_TOKEN_URL : LIVE_ACCESS_TOKEN_URL
+      end
+
+      def setup_access_token
+        request = 'grant_type=client_credentials'
+        response = parse(ssl_post(access_token_url, request, access_token_header))
+        response['access_token']
+      end
+
+      def commit(action, post, options, authorization = nil, method = :post)
+        begin
+          request_endpoint = url(action, authorization)
+          request_body = post.nil? || post.empty? ? nil : post.to_json
+
+          raw_response = ssl_request(method, request_endpoint, request_body, headers(action, options))
+          response = parse(raw_response)
+          response['id'] = response['_links']['payment']['href'].split('/')[-1] if action == :capture && response.key?('_links')
+          source_id = authorization if action == :unstore
+        rescue ResponseError => e
+          raise unless e.response.code.to_s =~ /4\d\d/
+
+          response = parse(e.response.body, error: e.response)
+        end
+
+        succeeded = success_from(action, response)
+
+        additional_data = {
+          request_endpoint:,
+          request_method: method,
+          request_body: parse(request_body),
+          response_http_code: @response_http_code
+        }
+
+        response(action, succeeded, response, source_id, additional_data)
+      end
+
+      def response(action, succeeded, response, source_id = nil, options = {})
+        successful_response = succeeded && action == :purchase || action == :authorize
+        avs_result = successful_response ? avs_result(response) : nil
+        cvv_result = successful_response ? cvv_result(response) : nil
+        authorization = authorization_from(response) unless action == :unstore
+        body = action == :unstore ? { response_code: response.to_s } : response
+        response_code = (action == :refund && succeeded) ? '10000' : response.dig('response_code')
+
+        Response.new(
+          succeeded,
+          message_from(succeeded, response),
+          body,
+          authorization: authorization,
+          error_code: error_code_from(succeeded, body),
+          test: test?,
+          avs_result: avs_result,
+          cvv_result: cvv_result,
+          response_type: response_type(response_code),
+          response_http_code: options[:response_http_code],
+          request_endpoint: options[:request_endpoint],
+          request_method: options[:request_method],
+          request_body: options[:request_body]
+        )
+      end
+
+      def headers(action, options)
+        auth_token = @access_token ? "Bearer #{@access_token}" : "Bearer #{@options[:secret_key]}"
+        auth_token = @options[:public_key] if action == :tokens
+        headers = {
+          'Authorization' => auth_token,
+          'Content-Type' => 'application/json;charset=UTF-8'
+        }
+        headers['Cko-Idempotency-Key'] = options[:idempotency_key] if options[:idempotency_key]
+        headers
+      end
+
+      def tokenize(payment_method, options = {})
+        post = {}
+        add_authorization_type(post, options)
+        add_payment_method(post, payment_method, options)
+        add_customer_data(post, options)
+        commit(:tokens, post[:source], options)
+      end
+
+      def url(action, authorization)
+        case action
+        when :authorize, :purchase, :credit
+          "#{base_url}/payments"
+        when :unstore, :store
+          "#{base_url}/instruments/#{authorization}"
+        when :capture
+          "#{base_url}/payments/#{authorization}/captures"
+        when :refund
+          "#{base_url}/payments/#{authorization}/refunds"
+        when :void
+          "#{base_url}/payments/#{authorization}/voids"
+        when :incremental_authorize
+          "#{base_url}/payments/#{authorization}/authorizations"
+        when :tokens
+          "#{base_url}/tokens"
+        when :verify_payment
+          "#{base_url}/payments/#{authorization}"
+        else
+          "#{base_url}/payments/#{authorization}/#{action}"
+        end
+      end
+
+      def base_url
+        test? ? test_url : live_url
+      end
+
+      def avs_result(response)
+        response['source'] && response['source']['avs_check'] ? AVSResult.new(code: response['source']['avs_check']) : nil
+      end
+
+      def cvv_result(response)
+        response['source'] && response['source']['cvv_check'] ? CVVResult.new(response['source']['cvv_check']) : nil
+      end
+
+      def parse(body, error: nil)
+        JSON.parse(body)
+      rescue JSON::ParserError
+        response = {
+          'error_type' => error&.code,
+          'message' => 'Invalid JSON response received from Checkout.com Unified Payments Gateway. Please contact Checkout.com if you continue to receive this message.',
+          'raw_response' => scrub(body)
+        }
+        response['error_codes'] = [error&.message] if error&.message
+        response
+      end
+
+      def success_from(action, response)
+        return response['status'] == 'Pending' if action == :credit
+        return true if action == :unstore && response == 204
+
+        store_response = response['token'] || response['id']
+        if store_response
+          return true if (action == :tokens && store_response.match(/tok/)) || (action == :store && store_response.match(/src_/))
+        end
+        response['response_summary'] == 'Approved' || response['approved'] == true || !response.key?('response_summary') && response.key?('action_id')
+      end
+
+      def message_from(succeeded, response)
+        if succeeded
+          'Succeeded'
+        elsif response['error_type']
+          response['error_type'] + ': ' + response['error_codes'].first
+        else
+          response['response_summary'] || response['response_code'] || response['status'] || response['message'] || 'Unable to read error message'
+        end
+      end
+
+      STANDARD_ERROR_CODE_MAPPING = {
+        '20014' => STANDARD_ERROR_CODE[:invalid_number],
+        '20100' => STANDARD_ERROR_CODE[:invalid_expiry_date],
+        '20054' => STANDARD_ERROR_CODE[:expired_card],
+        '40104' => STANDARD_ERROR_CODE[:incorrect_cvc],
+        '40108' => STANDARD_ERROR_CODE[:incorrect_zip],
+        '40111' => STANDARD_ERROR_CODE[:incorrect_address],
+        '20005' => STANDARD_ERROR_CODE[:card_declined],
+        '20088' => STANDARD_ERROR_CODE[:processing_error],
+        '20001' => STANDARD_ERROR_CODE[:call_issuer],
+        '30004' => STANDARD_ERROR_CODE[:pickup_card]
+      }
+
+      def authorization_from(raw)
+        raw['id'] || raw['action_id']
+      end
+
+      def error_code_from(succeeded, response)
+        return if succeeded
+
+        if response['error_type'] && response['error_codes']
+          "#{response['error_type']}: #{response['error_codes'].join(', ')}"
+        elsif response['error_type']
+          response['error_type']
+        else
+          STANDARD_ERROR_CODE_MAPPING[response['response_code']]
+        end
+      end
+
+      def token_type_from(payment_method)
+        case payment_method.source
+        when :network_token
+          payment_method.brand == 'visa' ? 'vts' : 'mdes'
+        when :google_pay, :android_pay
+          'googlepay'
+        when :apple_pay
+          'applepay'
+        end
+      end
+
+      def handle_response(response)
+        @response_http_code = response.code.to_i
+        case @response_http_code
+        # to get the response code after unstore(delete instrument), because the body is nil
+        when 200...300
+          response.body || response.code
+        else
+          raise ResponseError.new(response)
+        end
+      end
+
+      def response_type(code)
+        if SUCCESS_CODES.include?(code)
+          0
+        elsif SOFT_DECLINE_CODES.include?(code) || code.nil?
+          1
+        else
+          2
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+module ActiveMerchant
+  module Billing
+    class CitrusPayGateway < Gateway
+      include MastercardGateway
+
+      class_attribute :live_na_url, :live_ap_url, :test_na_url, :test_ap_url
+
+      self.test_na_url = 'https://test-gateway.mastercard.com/api/rest/version/39/'
+      self.test_ap_url = 'https://test-gateway.mastercard.com/api/rest/version/39/'
+
+      self.live_na_url = 'https://na-gateway.mastercard.com/api/rest/version/39/'
+      self.live_ap_url = 'https://ap-gateway.mastercard.com/api/rest/version/39/'
+
+      self.display_name = 'Citrus Pay'
+      self.homepage_url = 'http://www.citruspay.com/'
+      self.supported_countries = %w(AR AU BR FR DE HK MX NZ SG GB US)
+      self.default_currency = 'USD'
+      self.supported_cardtypes = %i[visa master american_express discover diners_club jcb maestro]
+    end
+  end
+end