activemerchant 1.130.0 → 1.137.0

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

@@ -68,6 +68,9 @@ module ActiveMerchant #:nodoc:
         add_application_info(post, options)
         add_level_2_data(post, options)
         add_level_3_data(post, options)
+        add_data_airline(post, options)
+        add_data_lodging(post, options)
+        add_metadata(post, options)
         commit('authorise', post, options)
       end
 
@@ -91,12 +94,28 @@ module ActiveMerchant #:nodoc:
       end
 
       def credit(money, payment, options = {})
-        action = 'refundWithData'
+        action = options[:payout] ? 'payout' : 'refundWithData'
         post = init_post(options)
         add_invoice(post, money, options)
         add_payment(post, payment, options, action)
         add_shopper_reference(post, options)
         add_network_transaction_reference(post, options)
+
+        if action == 'payout'
+          add_shopper_interaction(post, payment, options)
+          add_fraud_offset(post, options)
+          add_fund_source(post, options)
+          add_recurring_contract(post, options)
+          add_shopper_data(post, payment, options)
+
+          if (address = options[:billing_address] || options[:address]) && address[:country]
+            add_billing_address(post, options, address)
+          end
+
+          post[:dateOfBirth] = options[:date_of_birth] if options[:date_of_birth]
+          post[:nationality] = options[:nationality] if options[:nationality]
+        end
+
         commit(action, post, options)
       end
 
@@ -228,12 +247,30 @@ module ActiveMerchant #:nodoc:
 
       def add_extra_data(post, payment, options)
         post[:telephoneNumber] = (options[:billing_address][:phone_number] if options.dig(:billing_address, :phone_number)) || (options[:billing_address][:phone] if options.dig(:billing_address, :phone)) || ''
-        post[:fraudOffset] = options[:fraud_offset] if options[:fraud_offset]
         post[:selectedBrand] = options[:selected_brand] if options[:selected_brand]
         post[:selectedBrand] ||= NETWORK_TOKENIZATION_CARD_SOURCE[payment.source.to_s] if payment.is_a?(NetworkTokenizationCreditCard)
         post[:deliveryDate] = options[:delivery_date] if options[:delivery_date]
         post[:merchantOrderReference] = options[:merchant_order_reference] if options[:merchant_order_reference]
         post[:captureDelayHours] = options[:capture_delay_hours] if options[:capture_delay_hours]
+        post[:deviceFingerprint] = options[:device_fingerprint] if options[:device_fingerprint]
+        post[:shopperIP] = options[:shopper_ip] || options[:ip] if options[:shopper_ip] || options[:ip]
+        post[:shopperStatement] = options[:shopper_statement] if options[:shopper_statement]
+        post[:store] = options[:store] if options[:store]
+        post[:mcc] = options[:mcc] if options[:mcc]
+
+        add_shopper_data(post, payment, options)
+        add_additional_data(post, payment, options)
+        add_risk_data(post, options)
+        add_shopper_reference(post, options)
+        add_merchant_data(post, options)
+        add_fraud_offset(post, options)
+      end
+
+      def add_fraud_offset(post, options)
+        post[:fraudOffset] = options[:fraud_offset] if options[:fraud_offset]
+      end
+
+      def add_additional_data(post, payment, options)
         post[:additionalData] ||= {}
         post[:additionalData][:overwriteBrand] = normalize(options[:overwrite_brand]) if options[:overwrite_brand]
         post[:additionalData][:customRoutingFlag] = options[:custom_routing_flag] if options[:custom_routing_flag]
@@ -242,11 +279,7 @@ module ActiveMerchant #:nodoc:
         post[:additionalData][:adjustAuthorisationData] = options[:adjust_authorisation_data] if options[:adjust_authorisation_data]
         post[:additionalData][:industryUsage] = options[:industry_usage] if options[:industry_usage]
         post[:additionalData][:RequestedTestAcquirerResponseCode] = options[:requested_test_acquirer_response_code] if options[:requested_test_acquirer_response_code] && test?
-        post[:deviceFingerprint] = options[:device_fingerprint] if options[:device_fingerprint]
-        add_shopper_data(post, options)
-        add_risk_data(post, options)
-        add_shopper_reference(post, options)
-        add_merchant_data(post, options)
+        post[:additionalData][:updateShopperStatement] = options[:update_shopper_statement] if options[:update_shopper_statement]
       end
 
       def extract_and_transform(mapper, from)
@@ -291,13 +324,82 @@ module ActiveMerchant #:nodoc:
         post[:additionalData].compact!
       end
 
-      def add_shopper_data(post, options)
-        post[:shopperEmail] = options[:email] if options[:email]
-        post[:shopperEmail] = options[:shopper_email] if options[:shopper_email]
-        post[:shopperIP] = options[:ip] if options[:ip]
-        post[:shopperIP] = options[:shopper_ip] if options[:shopper_ip]
-        post[:shopperStatement] = options[:shopper_statement] if options[:shopper_statement]
-        post[:additionalData][:updateShopperStatement] = options[:update_shopper_statement] if options[:update_shopper_statement]
+      def add_data_airline(post, options)
+        return unless options[:additional_data_airline]
+
+        mapper = %w[
+          agency_invoice_number
+          agency_plan_name
+          airline_code
+          airline_designator_code
+          boarding_fee
+          computerized_reservation_system
+          customer_reference_number
+          document_type
+          flight_date
+          ticket_issue_address
+          ticket_number
+          travel_agency_code
+          travel_agency_name
+          passenger_name
+        ].each_with_object({}) { |value, hash| hash["airline.#{value}"] = value }
+
+        post[:additionalData].merge!(extract_and_transform(mapper, options[:additional_data_airline]))
+
+        if options[:additional_data_airline][:leg].present?
+          leg_data = %w[
+            carrier_code
+            class_of_travel
+            date_of_travel
+            depart_airport
+            depart_tax
+            destination_code
+            fare_base_code
+            flight_number
+            stop_over_code
+          ].each_with_object({}) { |value, hash| hash["airline.leg.#{value}"] = value }
+
+          post[:additionalData].merge!(extract_and_transform(leg_data, options[:additional_data_airline][:leg]))
+        end
+
+        if options[:additional_data_airline][:passenger].present?
+          passenger_data = %w[
+            date_of_birth
+            first_name
+            last_name
+            telephone_number
+            traveller_type
+          ].each_with_object({}) { |value, hash| hash["airline.passenger.#{value}"] = value }
+
+          post[:additionalData].merge!(extract_and_transform(passenger_data, options[:additional_data_airline][:passenger]))
+        end
+        post[:additionalData].compact!
+      end
+
+      def add_data_lodging(post, options)
+        return unless options[:additional_data_lodging]
+
+        mapper = {
+          'lodging.checkInDate': 'check_in_date',
+          'lodging.checkOutDate': 'check_out_date',
+          'lodging.customerServiceTollFreeNumber': 'customer_service_toll_free_number',
+          'lodging.fireSafetyActIndicator': 'fire_safety_act_indicator',
+          'lodging.folioCashAdvances': 'folio_cash_advances',
+          'lodging.folioNumber': 'folio_number',
+          'lodging.foodBeverageCharges': 'food_beverage_charges',
+          'lodging.noShowIndicator': 'no_show_indicator',
+          'lodging.prepaidExpenses': 'prepaid_expenses',
+          'lodging.propertyPhoneNumber': 'property_phone_number',
+          'lodging.room1.numberOfNights': 'number_of_nights',
+          'lodging.room1.rate': 'rate',
+          'lodging.totalRoomTax': 'total_room_tax',
+          'lodging.totalTax': 'totalTax',
+          'travelEntertainmentAuthData.duration': 'duration',
+          'travelEntertainmentAuthData.market': 'market'
+        }
+
+        post[:additionalData].merge!(extract_and_transform(mapper, options[:additional_data_lodging]))
+        post[:additionalData].compact!
       end
 
       def add_shopper_statement(post, options)
@@ -323,7 +425,7 @@ module ActiveMerchant #:nodoc:
 
       def add_risk_data(post, options)
         if (risk_data = options[:risk_data])
-          risk_data = Hash[risk_data.map { |k, v| ["riskdata.#{k}", v] }]
+          risk_data = risk_data.map { |k, v| ["riskdata.#{k}", v] }.to_h
           post[:additionalData].merge!(risk_data)
         end
       end
@@ -393,30 +495,39 @@ module ActiveMerchant #:nodoc:
       def add_address(post, options)
         if address = options[:shipping_address]
           post[:deliveryAddress] = {}
-          post[:deliveryAddress][:street] = address[:address1] || 'NA'
-          post[:deliveryAddress][:houseNumberOrName] = address[:address2] || 'NA'
+          post[:deliveryAddress][:street] = options[:address_override] == true ? address[:address2] : address[:address1] || 'NA'
+          post[:deliveryAddress][:houseNumberOrName] = options[:address_override] == true ? address[:address1] : address[:address2] || 'NA'
           post[:deliveryAddress][:postalCode] = address[:zip] if address[:zip]
           post[:deliveryAddress][:city] = address[:city] || 'NA'
           post[:deliveryAddress][:stateOrProvince] = get_state(address)
-          post[:deliveryAddress][:country] = address[:country] if address[:country]
+          post[:deliveryAddress][:country] = get_country(address)
         end
         return unless post[:bankAccount]&.kind_of?(Hash) || post[:card]&.kind_of?(Hash)
 
         if (address = options[:billing_address] || options[:address]) && address[:country]
-          post[:billingAddress] = {}
-          post[:billingAddress][:street] = address[:address1] || 'NA'
-          post[:billingAddress][:houseNumberOrName] = address[:address2] || 'NA'
-          post[:billingAddress][:postalCode] = address[:zip] if address[:zip]
-          post[:billingAddress][:city] = address[:city] || 'NA'
-          post[:billingAddress][:stateOrProvince] = get_state(address)
-          post[:billingAddress][:country] = address[:country] if address[:country]
+          add_billing_address(post, options, address)
         end
       end
 
+      def add_billing_address(post, options, address)
+        post[:billingAddress] = {}
+        post[:billingAddress][:street] = options[:address_override] == true ? address[:address2] : address[:address1] || 'NA'
+        post[:billingAddress][:houseNumberOrName] = options[:address_override] == true ? address[:address1] : address[:address2] || 'NA'
+        post[:billingAddress][:postalCode] = address[:zip] if address[:zip]
+        post[:billingAddress][:city] = address[:city] || 'NA'
+        post[:billingAddress][:stateOrProvince] = get_state(address)
+        post[:billingAddress][:country] = get_country(address)
+        post[:telephoneNumber] = address[:phone_number] || address[:phone] || ''
+      end
+
       def get_state(address)
         address[:state] && !address[:state].blank? ? address[:state] : 'NA'
       end
 
+      def get_country(address)
+        address[:country].present? ? address[:country] : 'ZZ'
+      end
+
       def add_invoice(post, money, options)
         currency = options[:currency] || currency(money)
         amount = {
@@ -477,6 +588,17 @@ module ActiveMerchant #:nodoc:
         post[:card] = card
       end
 
+      def add_shopper_data(post, payment, options)
+        if payment && !payment.is_a?(String)
+          post[:shopperName] = {}
+          post[:shopperName][:firstName] = payment.first_name
+          post[:shopperName][:lastName] = payment.last_name
+        end
+
+        post[:shopperEmail] = options[:email] if options[:email]
+        post[:shopperEmail] = options[:shopper_email] if options[:shopper_email]
+      end
+
       def capture_options(options)
         return options.merge(idempotency_key: "#{options[:idempotency_key]}-cap") if options[:idempotency_key]
 
@@ -508,11 +630,12 @@ module ActiveMerchant #:nodoc:
       def add_recurring_contract(post, options = {})
         return unless options[:recurring_contract_type]
 
-        recurring = {
-          contract: options[:recurring_contract_type]
-        }
-
-        post[:recurring] = recurring
+        post[:recurring] = {}
+        post[:recurring][:contract] = options[:recurring_contract_type]
+        post[:recurring][:recurringDetailName] = options[:recurring_detail_name] if options[:recurring_detail_name]
+        post[:recurring][:recurringExpiry] = options[:recurring_expiry] if options[:recurring_expiry]
+        post[:recurring][:recurringFrequency] = options[:recurring_frequency] if options[:recurring_frequency]
+        post[:recurring][:tokenService] = options[:token_service] if options[:token_service]
       end
 
       def add_application_info(post, options)
@@ -608,10 +731,58 @@ module ActiveMerchant #:nodoc:
         }
       end
 
+      def add_fund_source(post, options)
+        return unless fund_source = options[:fund_source]
+
+        post[:fundSource] = {}
+        post[:fundSource][:additionalData] = fund_source[:additional_data] if fund_source[:additional_data]
+
+        if fund_source[:first_name] && fund_source[:last_name]
+          post[:fundSource][:shopperName] = {}
+          post[:fundSource][:shopperName][:firstName] = fund_source[:first_name]
+          post[:fundSource][:shopperName][:lastName] = fund_source[:last_name]
+        end
+
+        if (address = fund_source[:billing_address])
+          add_billing_address(post[:fundSource], options, address)
+        end
+      end
+
+      def add_metadata(post, options = {})
+        return unless options[:metadata]
+
+        post[:metadata] ||= {}
+        post[:metadata].merge!(options[:metadata]) if options[:metadata]
+      end
+
+      def add_header_fields(response)
+        return unless @response_headers.present?
+
+        headers = {}
+        headers['response_headers'] = {}
+        headers['response_headers']['transient_error'] = @response_headers['transient-error'] if @response_headers['transient-error']
+
+        response.merge!(headers)
+      end
+
       def parse(body)
         return {} if body.blank?
 
-        JSON.parse(body)
+        response = JSON.parse(body)
+        add_header_fields(response)
+        response
+      end
+
+      # Override the regular handle response so we can access the headers
+      # set header fields and values so we can add them to the response body
+      def handle_response(response)
+        @response_headers = response.each_header.to_h if response.respond_to?(:header)
+        case response.code.to_i
+        when 200...300
+          response.body
+        else
+          raise ResponseError.new(response)
+        end
       end
 
       def commit(action, parameters, options)
@@ -626,7 +797,7 @@ module ActiveMerchant #:nodoc:
         success = success_from(action, response, options)
         Response.new(
           success,
-          message_from(action, response),
+          message_from(action, response, options),
           response,
           authorization: authorization_from(action, parameters, response),
           test: test?,
@@ -646,8 +817,14 @@ module ActiveMerchant #:nodoc:
       end
 
       def endpoint(action)
-        recurring = %w(disable storeToken).include?(action)
-        recurring ? "Recurring/#{RECURRING_API_VERSION}/#{action}" : "Payment/#{PAYMENT_API_VERSION}/#{action}"
+        case action
+        when 'disable', 'storeToken'
+          "Recurring/#{RECURRING_API_VERSION}/#{action}"
+        when 'payout'
+          "Payout/#{PAYMENT_API_VERSION}/#{action}"
+        else
+          "Payment/#{PAYMENT_API_VERSION}/#{action}"
+        end
       end
 
       def url(action)
@@ -674,7 +851,7 @@ module ActiveMerchant #:nodoc:
       end
 
       def success_from(action, response, options)
-        if %w[RedirectShopper ChallengeShopper].include?(response.dig('resultCode')) && !options[:execute_threed] && !options[:threed_dynamic]
+        if %w[RedirectShopper ChallengeShopper].include?(response.dig('resultCode')) && !options[:execute_threed] && (!options[:threed_dynamic] || options[:ignore_threed_dynamic])
           response['refusalReason'] = 'Received unexpected 3DS authentication response, but a 3DS initiation flag was not included in the request.'
           return false
         end
@@ -691,18 +868,29 @@ module ActiveMerchant #:nodoc:
           response['response'] == '[detail-successfully-disabled]'
         when 'refundWithData'
           response['resultCode'] == 'Received'
+        when 'payout'
+          return false unless response['resultCode'] && response['authCode']
+
+          %[AuthenticationFinished Authorised Received].include?(response['resultCode'])
         else
           false
         end
       end
 
-      def message_from(action, response)
-        return authorize_message_from(response) if %w(authorise authorise3d authorise3ds2).include?(action.to_s)
-
-        response['response'] || response['message'] || response['result'] || response['resultCode']
+      def message_from(action, response, options = {})
+        case action.to_s
+        when 'authorise', 'authorise3d', 'authorise3ds2'
+          authorize_message_from(response, options)
+        when 'payout'
+          response['refusalReason'] || response['resultCode'] || response['message']
+        else
+          response['response'] || response['message'] || response['result'] || response['resultCode']
+        end
       end
 
-      def authorize_message_from(response)
+      def authorize_message_from(response, options = {})
+        return raw_authorize_error_message(response) if options[:raw_error_message]
+
         if response['refusalReason'] && response['additionalData'] && (response['additionalData']['merchantAdviceCode'] || response['additionalData']['refusalReasonRaw'])
           "#{response['refusalReason']} | #{response['additionalData']['merchantAdviceCode'] || response['additionalData']['refusalReasonRaw']}"
         else
@@ -710,6 +898,14 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def raw_authorize_error_message(response)
+        if response['refusalReason'] && response['additionalData'] && response['additionalData']['refusalReasonRaw']
+          "#{response['refusalReason']} | #{response['additionalData']['refusalReasonRaw']}"
+        else
+          response['refusalReason'] || response['resultCode'] || response['message'] || response['result']
+        end
+      end
+
       def authorization_from(action, parameters, response)
         return nil if response['pspReference'].nil?
 
@@ -731,7 +927,10 @@ module ActiveMerchant #:nodoc:
       end
 
       def error_code_from(response)
-        STANDARD_ERROR_CODE_MAPPING[response['errorCode']] || response['errorCode']
+        response.dig('additionalData', 'refusalReasonRaw').try(:match, /^([a-zA-Z0-9 ]{1,5})(?=:)/).try(:[], 1).try(:strip) ||
+          STANDARD_ERROR_CODE_MAPPING[response['errorCode']] ||
+          response['errorCode'] ||
+          response['refusalReason']
       end
 
       def network_transaction_id_from(response)

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

@@ -32,7 +32,7 @@ module ActiveMerchant #:nodoc:
         @client_id = options[:client_id]
         @client_api_key = options[:client_api_key]
         super
-        @access_token = setup_access_token
+        @access_token = options[:access_token] || setup_access_token
       end
 
       def purchase(money, card, options = {})
@@ -133,13 +133,27 @@ module ActiveMerchant #:nodoc:
           'x-client-id' => @client_id,
           'x-api-key' => @client_api_key
         }
-        response = ssl_post(build_request_url(:login), nil, token_headers)
-        JSON.parse(response)['token']
+
+        begin
+          raw_response = ssl_post(build_request_url(:login), nil, token_headers)
+        rescue ResponseError => e
+          raise OAuthResponseError.new(e)
+        else
+          response = JSON.parse(raw_response)
+          if (token = response['token'])
+            token
+          else
+            oauth_response = Response.new(false, response['message'])
+            raise OAuthResponseError.new(oauth_response)
+          end
+        end
       end
 
       def build_request_url(action, id = nil)
         base_url = (test? ? test_url : live_url)
-        base_url + ENDPOINTS[action].to_s % { id: id }
+        endpoint = ENDPOINTS[action].to_s
+        endpoint = id.present? ? endpoint % { id: id } : endpoint
+        base_url + endpoint
       end
 
       def add_referrer_data(post)
@@ -278,11 +292,11 @@ module ActiveMerchant #:nodoc:
         pm_options = post.dig('payment_method_options', 'card')
 
         external_three_ds = {
-          'version': format_three_ds_version(three_d_secure),
-          'eci': three_d_secure[:eci]
+          version: format_three_ds_version(three_d_secure),
+          eci: three_d_secure[:eci]
         }.merge(three_ds_version_specific_fields(three_d_secure))
 
-        pm_options ? pm_options.merge!('external_three_ds': external_three_ds) : post['payment_method_options'] = { 'card': { 'external_three_ds': external_three_ds } }
+        pm_options ? pm_options.merge!(external_three_ds: external_three_ds) : post['payment_method_options'] = { card: { external_three_ds: external_three_ds } }
       end
 
       def format_three_ds_version(three_d_secure)
@@ -295,14 +309,14 @@ module ActiveMerchant #:nodoc:
       def three_ds_version_specific_fields(three_d_secure)
         if three_d_secure[:version].to_f >= 2
           {
-            'authentication_value': three_d_secure[:cavv],
-            'ds_transaction_id': three_d_secure[:ds_transaction_id],
-            'three_ds_server_transaction_id': three_d_secure[:three_ds_server_trans_id]
+            authentication_value: three_d_secure[:cavv],
+            ds_transaction_id: three_d_secure[:ds_transaction_id],
+            three_ds_server_transaction_id: three_d_secure[:three_ds_server_trans_id]
           }
         else
           {
-            'cavv': three_d_secure[:cavv],
-            'xid': three_d_secure[:xid]
+            cavv: three_d_secure[:cavv],
+            xid: three_d_secure[:xid]
           }
         end
       end

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

@@ -110,8 +110,18 @@ module ActiveMerchant #:nodoc:
           'Content-Type' => 'application/x-www-form-urlencoded'
         }
 
-        parsed = parse(ssl_post(url('captura-oauth-provider/oauth/token'), post_data(params), headers))
-        Response.new(true, parsed[:access_token], parsed)
+        begin
+          raw_response = ssl_post(url('captura-oauth-provider/oauth/token'), post_data(params), headers)
+        rescue ResponseError => e
+          raise OAuthResponseError.new(e)
+        else
+          response = parse(raw_response)
+          if (access_token = response[:access_token])
+            Response.new(true, access_token, response)
+          else
+            raise OAuthResponseError.new(response)
+          end
+        end
       end
 
       def remote_encryption_key(access_token)
@@ -144,9 +154,11 @@ module ActiveMerchant #:nodoc:
           access_token: access_token,
           multiresp: multiresp.responses.present? ? multiresp : nil
         }
-      rescue ResponseError => error
+      rescue ActiveMerchant::OAuthResponseError => e
+        raise e
+      rescue ResponseError => e
         # retry to generate a new access_token when the provided one is expired
-        raise error unless try_again && %w(401 404).include?(error.response.code) && @options[:access_token].present?
+        raise e unless retry?(try_again, e, :access_token)
 
         @options.delete(:access_token)
         @options.delete(:encryption_key)
@@ -206,9 +218,11 @@ module ActiveMerchant #:nodoc:
         multiresp.process { resp }
 
         multiresp
+      rescue ActiveMerchant::OAuthResponseError => e
+        raise OAuthResponseError.new(e)
       rescue ActiveMerchant::ResponseError => e
         # Retry on a possible expired encryption key
-        if try_again && %w(401 404).include?(e.response.code) && @options[:encryption_key].present?
+        if retry?(try_again, e, :encryption_key)
           @options.delete(:encryption_key)
           commit(action, body, options, false)
         else
@@ -217,6 +231,10 @@ module ActiveMerchant #:nodoc:
         end
       end
 
+      def retry?(try_again, error, key)
+        try_again && %w(401 404).include?(error.response.code) && @options[key].present?
+      end
+
       def success_from(action, response)
         case action
         when 'capture/transaction/refund'