require 'active_support/core_ext/hash/slice' module ActiveMerchant #:nodoc: module Billing #:nodoc: class StripeGateway < Gateway self.live_url = 'https://api.stripe.com/v1/' AVS_CODE_TRANSLATOR = { 'line1: pass, zip: pass' => 'Y', 'line1: pass, zip: fail' => 'A', 'line1: pass, zip: unchecked' => 'B', 'line1: fail, zip: pass' => 'Z', 'line1: fail, zip: fail' => 'N', 'line1: unchecked, zip: pass' => 'P', 'line1: unchecked, zip: unchecked' => 'I' } CVC_CODE_TRANSLATOR = { 'pass' => 'M', 'fail' => 'N', 'unchecked' => 'P' } # Source: https://support.stripe.com/questions/which-zero-decimal-currencies-does-stripe-support CURRENCIES_WITHOUT_FRACTIONS = ['BIF', 'CLP', 'DJF', 'GNF', 'JPY', 'KMF', 'KRW', 'MGA', 'PYG', 'RWF', 'VUV', 'XAF', 'XOF', 'XPF'] self.supported_countries = %w(AT AU BE CA CH DE DK ES FI FR GB IE IT LU NL NO SE US) self.default_currency = 'USD' self.money_format = :cents self.supported_cardtypes = [:visa, :master, :american_express, :discover, :jcb, :diners_club, :maestro] self.homepage_url = 'https://stripe.com/' self.display_name = 'Stripe' STANDARD_ERROR_CODE_MAPPING = { 'incorrect_number' => STANDARD_ERROR_CODE[:incorrect_number], 'invalid_number' => STANDARD_ERROR_CODE[:invalid_number], 'invalid_expiry_month' => STANDARD_ERROR_CODE[:invalid_expiry_date], 'invalid_expiry_year' => STANDARD_ERROR_CODE[:invalid_expiry_date], 'invalid_cvc' => STANDARD_ERROR_CODE[:invalid_cvc], 'expired_card' => STANDARD_ERROR_CODE[:expired_card], 'incorrect_cvc' => STANDARD_ERROR_CODE[:incorrect_cvc], 'incorrect_zip' => STANDARD_ERROR_CODE[:incorrect_zip], 'card_declined' => STANDARD_ERROR_CODE[:card_declined], 'call_issuer' => STANDARD_ERROR_CODE[:call_issuer], 'processing_error' => STANDARD_ERROR_CODE[:processing_error], 'incorrect_pin' => STANDARD_ERROR_CODE[:incorrect_pin] } def initialize(options = {}) requires!(options, :login) @api_key = options[:login] @fee_refund_api_key = options[:fee_refund_login] super end def authorize(money, payment, options = {}) MultiResponse.run do |r| if payment.is_a?(ApplePayPaymentToken) r.process { tokenize_apple_pay_token(payment) } payment = StripePaymentToken.new(r.params["token"]) if r.success? end r.process do post = create_post_for_auth_or_purchase(money, payment, options) if emv_payment?(payment) add_application_fee(post, options) else post[:capture] = "false" end commit(:post, 'charges', post, options) end end.responses.last end # To create a charge on a card or a token, call # # purchase(money, card_hash_or_token, { ... }) # # To create a charge on a customer, call # # purchase(money, nil, { :customer => id, ... }) def purchase(money, payment, options = {}) MultiResponse.run do |r| if payment.is_a?(ApplePayPaymentToken) r.process { tokenize_apple_pay_token(payment) } payment = StripePaymentToken.new(r.params["token"]) if r.success? end r.process do post = create_post_for_auth_or_purchase(money, payment, options) commit(:post, 'charges', post, options) end end.responses.last end def capture(money, authorization, options = {}) post = {} if emv_tc_response = options.delete(:icc_data) post[:card] = { emv_approval_data: emv_tc_response } commit(:post, "charges/#{CGI.escape(authorization)}", post, options) else add_application_fee(post, options) add_amount(post, money, options) commit(:post, "charges/#{CGI.escape(authorization)}/capture", post, options) end end def void(identification, options = {}) commit(:post, "charges/#{CGI.escape(identification)}/refund", {}, options) end def refund(money, identification, options = {}) post = {} add_amount(post, money, options) post[:refund_application_fee] = true if options[:refund_application_fee] post[:reverse_transfer] = options[:reverse_transfer] if options[:reverse_transfer] MultiResponse.run(:first) do |r| r.process { commit(:post, "charges/#{CGI.escape(identification)}/refund", post, options) } return r unless options[:refund_fee_amount] r.process { fetch_application_fees(identification, options) } r.process { refund_application_fee(options[:refund_fee_amount], application_fee_from_response(r.responses.last), options) } end end def verify(payment, options = {}) MultiResponse.run(:use_first_response) do |r| r.process { authorize(50, payment, options) } r.process(:ignore_result) { void(r.authorization, options) } end end def application_fee_from_response(response) return unless response.success? application_fees = response.params["data"].select { |fee| fee["object"] == "application_fee" } application_fees.first["id"] unless application_fees.empty? end def refund_application_fee(money, identification, options = {}) return Response.new(false, "Application fee id could not be found") unless identification post = {} add_amount(post, money, options) options.merge!(:key => @fee_refund_api_key) commit(:post, "application_fees/#{CGI.escape(identification)}/refund", post, options) end # Note: creating a new credit card will not change the customer's existing default credit card (use :set_default => true) def store(payment, options = {}) card_params = {} post = {} if payment.is_a?(ApplePayPaymentToken) token_exchange_response = tokenize_apple_pay_token(payment) card_params = { card: token_exchange_response.params["token"]["id"] } if token_exchange_response.success? else add_creditcard(card_params, payment, options) end post[:validate] = options[:validate] unless options[:validate].nil? post[:description] = options[:description] if options[:description] post[:email] = options[:email] if options[:email] if options[:customer] MultiResponse.run(:first) do |r| # The /cards endpoint does not update other customer parameters. r.process { commit(:post, "customers/#{CGI.escape(options[:customer])}/cards", card_params, options) } if options[:set_default] and r.success? and !r.params['id'].blank? post[:default_card] = r.params['id'] end if post.count > 0 r.process { update_customer(options[:customer], post) } end end else commit(:post, 'customers', post.merge(card_params), options) end end def update(customer_id, card_id, options = {}) commit(:post, "customers/#{CGI.escape(customer_id)}/cards/#{CGI.escape(card_id)}", options, options) end def update_customer(customer_id, options = {}) commit(:post, "customers/#{CGI.escape(customer_id)}", options, options) end def unstore(identification, options = {}, deprecated_options = {}) customer_id, card_id = identification.split("|") if options.kind_of?(String) ActiveMerchant.deprecated "Passing the card_id as the 2nd parameter is deprecated. The response authorization includes both the customer_id and the card_id." card_id ||= options options = deprecated_options end commit(:delete, "customers/#{CGI.escape(customer_id)}/cards/#{CGI.escape(card_id)}", nil, options) end def tokenize_apple_pay_token(apple_pay_payment_token, options = {}) token_response = api_request(:post, "tokens?pk_token=#{CGI.escape(apple_pay_payment_token.payment_data.to_json)}") success = !token_response.key?("error") if success && token_response.key?("id") Response.new(success, nil, token: token_response) else Response.new(success, token_response["error"]["message"]) end end def supports_scrubbing? true end def scrub(transcript) transcript. gsub(%r((Authorization: Basic )\w+), '\1[FILTERED]'). gsub(%r((card\[number\]=)\d+), '\1[FILTERED]'). gsub(%r((card\[cvc\]=)\d+), '\1[FILTERED]'). gsub(%r((&?three_d_secure\[cryptogram\]=)[\w=]*(&?)), '\1[FILTERED]\2') end def supports_network_tokenization? true end private class StripePaymentToken < PaymentToken def type 'stripe' end end def create_post_for_auth_or_purchase(money, payment, options) post = {} if payment.is_a?(StripePaymentToken) add_payment_token(post, payment, options) else add_creditcard(post, payment, options) end unless emv_payment?(payment) add_amount(post, money, options, true) add_customer_data(post, options) add_metadata(post, options) post[:description] = options[:description] post[:statement_descriptor] = options[:statement_description] add_customer(post, payment, options) add_flags(post, options) end add_application_fee(post, options) add_destination(post, options) post end def add_amount(post, money, options, include_currency = false) currency = options[:currency] || currency(money) post[:amount] = localized_amount(money, currency) post[:currency] = currency.downcase if include_currency end def add_application_fee(post, options) post[:application_fee] = options[:application_fee] if options[:application_fee] end def add_destination(post, options) post[:destination] = options[:destination] if options[:destination] end def add_expand_parameters(post, options) post[:expand] = Array.wrap(options[:expand]) end def add_customer_data(post, options) metadata_options = [:description, :ip, :user_agent, :referrer] post.update(options.slice(*metadata_options)) post[:external_id] = options[:order_id] post[:payment_user_agent] = "Stripe/v1 ActiveMerchantBindings/#{ActiveMerchant::VERSION}" end def add_address(post, options) return unless post[:card] && post[:card].kind_of?(Hash) if address = options[:billing_address] || options[:address] post[:card][:address_line1] = address[:address1] if address[:address1] post[:card][:address_line2] = address[:address2] if address[:address2] post[:card][:address_country] = address[:country] if address[:country] post[:card][:address_zip] = address[:zip] if address[:zip] post[:card][:address_state] = address[:state] if address[:state] post[:card][:address_city] = address[:city] if address[:city] end end def add_creditcard(post, creditcard, options) card = {} if emv_payment?(creditcard) add_emv_creditcard(post, creditcard.icc_data) post[:card][:read_method] = "contactless" if creditcard.contactless if creditcard.encrypted_pin_cryptogram.present? && creditcard.encrypted_pin_ksn.present? post[:card][:encrypted_pin] = creditcard.encrypted_pin_cryptogram post[:card][:encrypted_pin_key_id] = creditcard.encrypted_pin_ksn end elsif creditcard.respond_to?(:number) if creditcard.respond_to?(:track_data) && creditcard.track_data.present? card[:swipe_data] = creditcard.track_data card[:fallback_reason] = creditcard.fallback_reason if creditcard.fallback_reason card[:read_method] = "contactless" if creditcard.contactless else card[:number] = creditcard.number card[:exp_month] = creditcard.month card[:exp_year] = creditcard.year card[:cvc] = creditcard.verification_value if creditcard.verification_value? card[:name] = creditcard.name if creditcard.name end post[:card] = card if creditcard.is_a?(NetworkTokenizationCreditCard) post[:three_d_secure] = { apple_pay: true, cryptogram: creditcard.payment_cryptogram } end add_address(post, options) elsif creditcard.kind_of?(String) if options[:track_data] card[:swipe_data] = options[:track_data] elsif creditcard.include?("|") customer_id, card_id = creditcard.split("|") card = card_id post[:customer] = customer_id else card = creditcard end post[:card] = card end end def add_emv_creditcard(post, icc_data, options = {}) post[:card] = { emv_auth_data: icc_data } end def add_payment_token(post, token, options = {}) post[:card] = token.payment_data["id"] end def add_customer(post, payment, options) if options[:customer] && !payment.respond_to?(:number) ActiveMerchant.deprecated "Passing the customer in the options is deprecated. Just use the response.authorization instead." post[:customer] = options[:customer] end end def add_flags(post, options) post[:uncaptured] = true if options[:uncaptured] post[:recurring] = true if (options[:eci] == 'recurring' || options[:recurring]) end def add_metadata(post, options = {}) post[:metadata] = options[:metadata] || {} post[:metadata][:email] = options[:email] if options[:email] post[:metadata][:order_id] = options[:order_id] if options[:order_id] post.delete(:metadata) if post[:metadata].empty? end def fetch_application_fees(identification, options = {}) options.merge!(:key => @fee_refund_api_key) commit(:get, "application_fees?charge=#{identification}", nil, options) end def parse(body) JSON.parse(body) end def post_data(params) return nil unless params params.map do |key, value| next if value != false && value.blank? if value.is_a?(Hash) h = {} value.each do |k, v| h["#{key}[#{k}]"] = v unless v.blank? end post_data(h) elsif value.is_a?(Array) value.map { |v| "#{key}[]=#{CGI.escape(v.to_s)}" }.join("&") else "#{key}=#{CGI.escape(value.to_s)}" end end.compact.join("&") end def headers(options = {}) key = options[:key] || @api_key idempotency_key = options[:idempotency_key] headers = { "Authorization" => "Basic " + Base64.encode64(key.to_s + ":").strip, "User-Agent" => "Stripe/v1 ActiveMerchantBindings/#{ActiveMerchant::VERSION}", "Stripe-Version" => api_version(options), "X-Stripe-Client-User-Agent" => user_agent, "X-Stripe-Client-User-Metadata" => {:ip => options[:ip]}.to_json } headers.merge!("Idempotency-Key" => idempotency_key) if idempotency_key headers end def api_version(options) options[:version] || @options[:version] || "2015-04-07" end def api_request(method, endpoint, parameters = nil, options = {}) raw_response = response = nil begin raw_response = ssl_request(method, self.live_url + endpoint, post_data(parameters), headers(options)) response = parse(raw_response) rescue ResponseError => e raw_response = e.response.body response = response_error(raw_response) rescue JSON::ParserError response = json_error(raw_response) end response end def commit(method, url, parameters = nil, options = {}) add_expand_parameters(parameters, options) if parameters response = api_request(method, url, parameters, options) success = !response.key?("error") card = card_from_response(response) avs_code = AVS_CODE_TRANSLATOR["line1: #{card["address_line1_check"]}, zip: #{card["address_zip_check"]}"] cvc_code = CVC_CODE_TRANSLATOR[card["cvc_check"]] Response.new(success, success ? "Transaction approved" : response["error"]["message"], response, :test => response.has_key?("livemode") ? !response["livemode"] : false, :authorization => authorization_from(success, url, method, response), :avs_result => { :code => avs_code }, :cvv_result => cvc_code, :emv_authorization => emv_authorization_from_response(response), :error_code => success ? nil : error_code_from(response) ) end def authorization_from(success, url, method, response) return response["error"]["charge"] unless success if url == "customers" [response["id"], response["sources"]["data"].first["id"]].join("|") elsif method == :post && url.match(/customers\/.*\/cards/) [response["customer"], response["id"]].join("|") elsif url.include?("refund") && response["refunds"] response["refunds"]["data"].first["id"] else response["id"] end end def response_error(raw_response) begin parse(raw_response) rescue JSON::ParserError json_error(raw_response) end end def json_error(raw_response) msg = 'Invalid response received from the Stripe API. Please contact support@stripe.com if you continue to receive this message.' msg += " (The raw response returned by the API was #{raw_response.inspect})" { "error" => { "message" => msg } } end def non_fractional_currency?(currency) CURRENCIES_WITHOUT_FRACTIONS.include?(currency.to_s) end def emv_payment?(payment) payment.respond_to?(:emv?) && payment.emv? end def card_from_response(response) response["card"] || response["active_card"] || response["source"] || {} end def emv_authorization_from_response(response) return response["error"]["emv_auth_data"] if response["error"] card_from_response(response)["emv_auth_data"] end def error_code_from(response) code = response['error']['code'] decline_code = response['error']['decline_code'] if code == 'card_declined' error_code = STANDARD_ERROR_CODE_MAPPING[decline_code] error_code ||= STANDARD_ERROR_CODE_MAPPING[code] error_code end end end end