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] 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) def initialize(options = {}) requires!(options, :secret_key) super end def purchase(amount, payment_method, options = {}) post = {} build_auth_or_purchase(post, amount, payment_method, options) commit(:purchase, post) end def authorize(amount, payment_method, options = {}) post = {} post[:capture] = false build_auth_or_purchase(post, amount, payment_method, options) commit(:authorize, post) end def capture(amount, authorization, options = {}) post = {} add_invoice(post, amount, options) add_customer_data(post, options) commit(:capture, post, authorization) end def void(authorization, _options = {}) post = {} commit(:void, post, authorization) end def refund(amount, authorization, options = {}) post = {} add_invoice(post, amount, options) add_customer_data(post, options) commit(:refund, post, authorization) end def verify(credit_card, options = {}) authorize(0, credit_card, options) end def verify_payment(authorization, option = {}) commit(:verify_payment, authorization) 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]') end private def build_auth_or_purchase(post, amount, payment_method, options) add_invoice(post, amount, options) add_payment_method(post, payment_method, options) add_customer_data(post, options) add_transaction_data(post, options) add_3ds(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_payment_method(post, payment_method, options) post[:source] = {} if payment_method.is_a?(NetworkTokenizationCreditCard) && payment_method.source == :network_token post[:source][:type] = 'network_token' post[:source][:token] = payment_method.number post[:source][:token_type] = payment_method.brand == 'visa' ? 'vts' : 'mdes' post[:source][:cryptogram] = payment_method.payment_cryptogram post[:source][:eci] = options[:eci] || '05' else post[:source][:type] = 'card' post[:source][:name] = payment_method.name post[:source][:number] = payment_method.number post[:source][:cvv] = payment_method.verification_value post[:source][:stored] = 'true' if options[:card_on_file] == true end post[:source][:expiry_year] = format(payment_method.year, :four_digits) post[:source][:expiry_month] = format(payment_method.month, :two_digits) 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 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 add_3ds(post, options) if options[:three_d_secure] || options[:execute_threed] post[:'3ds'] = {} post[:'3ds'][:enabled] = true post[:success_url] = options[:callback_url] if options[:callback_url] post[:failure_url] = options[:callback_url] if options[:callback_url] 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'][:attempt_n3d] = options[:attempt_n3d] if options[:attempt_n3d] end end def commit(action, post, authorization = nil) begin raw_response = (action == :verify_payment ? ssl_get("#{base_url}/payments/#{post}", headers) : ssl_post(url(post, action, authorization), post.to_json, headers)) response = parse(raw_response) response['id'] = response['_links']['payment']['href'].split('/')[-1] if action == :capture && response.key?('_links') 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(response) response(action, succeeded, response) end def response(action, succeeded, response) successful_response = succeeded && action == :purchase || action == :authorize avs_result = successful_response ? avs_result(response) : nil cvv_result = successful_response ? cvv_result(response) : nil Response.new( succeeded, message_from(succeeded, response), response, authorization: authorization_from(response), error_code: error_code_from(succeeded, response), test: test?, avs_result: avs_result, cvv_result: cvv_result ) end def headers { 'Authorization' => @options[:secret_key], 'Content-Type' => 'application/json;charset=UTF-8' } end def url(_post, action, authorization) if %i[authorize purchase].include?(action) "#{base_url}/payments" elsif action == :capture "#{base_url}/payments/#{authorization}/captures" elsif action == :refund "#{base_url}/payments/#{authorization}/refunds" elsif action == :void "#{base_url}/payments/#{authorization}/voids" 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(response) 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'] 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 end end end