Class: ActiveMerchant::Billing::StripePaymentIntentsGateway

Inherits:
StripeGateway show all
Defined in:
lib/active_merchant/billing/gateways/stripe_payment_intents.rb

Overview

This gateway uses the current Stripe Payment Intents API. For the legacy API, see the Stripe gateway

Constant Summary collapse

ALLOWED_METHOD_STATES =
%w[automatic manual].freeze
ALLOWED_CANCELLATION_REASONS =
%w[duplicate fraudulent requested_by_customer abandoned].freeze
CREATE_INTENT_ATTRIBUTES =
%i[description statement_descriptor_suffix statement_descriptor receipt_email save_payment_method]
CONFIRM_INTENT_ATTRIBUTES =
%i[receipt_email return_url save_payment_method setup_future_usage off_session]
UPDATE_INTENT_ATTRIBUTES =
%i[description statement_descriptor_suffix statement_descriptor receipt_email setup_future_usage]
DEFAULT_API_VERSION =
'2019-05-16'

Constants inherited from StripeGateway

ActiveMerchant::Billing::StripeGateway::AVS_CODE_TRANSLATOR, ActiveMerchant::Billing::StripeGateway::BANK_ACCOUNT_HOLDER_TYPE_MAPPING, ActiveMerchant::Billing::StripeGateway::CVC_CODE_TRANSLATOR, ActiveMerchant::Billing::StripeGateway::MINIMUM_AUTHORIZE_AMOUNTS, ActiveMerchant::Billing::StripeGateway::STANDARD_ERROR_CODE_MAPPING

Constants inherited from Gateway

Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::RECURRING_DEPRECATION_MESSAGE, Gateway::STANDARD_ERROR_CODE

Instance Attribute Summary

Attributes inherited from Gateway

#options

Instance Method Summary collapse

Methods inherited from StripeGateway

#initialize, #refund_application_fee, #scrub, #supports_network_tokenization?, #supports_scrubbing?, #tokenize_apple_pay_token, #update, #update_customer, #verify_credentials

Methods inherited from Gateway

#add_field_to_post_if_present, #add_fields_to_post_if_present, card_brand, #card_brand, #generate_unique_id, inherited, #initialize, #scrub, supported_countries, #supported_countries, supported_countries=, supports?, #supports_network_tokenization?, #supports_scrubbing?, #test?

Methods included from CreditCardFormatting

#expdate, #format

Methods included from PostsData

included, #raw_ssl_request, #ssl_get, #ssl_post, #ssl_request

Constructor Details

This class inherits a constructor from ActiveMerchant::Billing::StripeGateway

Instance Method Details

#authorize(money, payment_method, options = {}) ⇒ Object


105
106
107
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 105

def authorize(money, payment_method, options = {})
  create_intent(money, payment_method, options.merge!(confirm: true, capture_method: 'manual'))
end

#capture(money, intent_id, options = {}) ⇒ Object


113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 113

def capture(money, intent_id, options = {})
  post = {}
  currency = options[:currency] || currency(money)
  post[:amount_to_capture] = localized_amount(money, currency)
  if options[:transfer_amount]
    post[:transfer_data] = {}
    post[:transfer_data][:amount] = options[:transfer_amount]
  end
  post[:application_fee_amount] = options[:application_fee] if options[:application_fee]
  options = format_idempotency_key(options, 'capture')
  commit(:post, "payment_intents/#{intent_id}/capture", post, options)
end

#confirm_intent(intent_id, payment_method, options = {}) ⇒ Object


47
48
49
50
51
52
53
54
55
56
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 47

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)

  CONFIRM_INTENT_ATTRIBUTES.each do |attribute|
    add_whitelisted_attribute(post, options, attribute)
  end
  commit(:post, "payment_intents/#{intent_id}/confirm", post, options)
end

#create_intent(money, payment_method, options = {}) ⇒ Object


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 17

def create_intent(money, payment_method, options = {})
  post = {}
  add_amount(post, money, options, true)
  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)

  add_external_three_d_secure_auth_data(post, options)
  (post, options)
  add_return_url(post, options)
  (post, options)
  add_shipping_address(post, options)
  setup_future_usage(post, options)
  add_exemption(post, options)
  add_error_on_requires_action(post, options)
  request_three_d_secure(post, options)

  CREATE_INTENT_ATTRIBUTES.each do |attribute|
    add_whitelisted_attribute(post, options, attribute)
  end

  commit(:post, 'payment_intents', post, options)
end

#create_payment_method(payment_method, options = {}) ⇒ Object


58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 58

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)
  options = format_idempotency_key(options, 'pm')
  commit(:post, 'payment_methods', post, options)
end

#create_setup_intent(payment_method, options = {}) ⇒ Object


90
91
92
93
94
95
96
97
98
99
100
101
102
103
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 90

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)

  (post, options)
  add_return_url(post, options)
  post[:on_behalf_of] = options[:on_behalf_of] if options[:on_behalf_of]
  post[:usage] = options[:usage] if %w(on_session off_session).include?(options[:usage])
  post[:description] = options[:description] if options[:description]

  commit(:post, 'setup_intents', post, options)
end

#purchase(money, payment_method, options = {}) ⇒ Object


109
110
111
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 109

def purchase(money, payment_method, options = {})
  create_intent(money, payment_method, options.merge!(confirm: true, capture_method: 'automatic'))
end

#refund(money, intent_id, options = {}) ⇒ Object


132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 132

def refund(money, intent_id, options = {})
  if intent_id.include?('pi_')
    intent = api_request(:get, "payment_intents/#{intent_id}", nil, options)

    return Response.new(false, intent['error']['message'], intent) if intent['error']

    charge_id = intent.try(:[], 'charges').try(:[], 'data').try(:[], 0).try(:[], 'id')

    if charge_id.nil?
      error_message = "No associated charge for #{intent['id']}"
      error_message << "; payment_intent has a status of #{intent['status']}" if intent.try(:[], 'status') && intent.try(:[], 'status') != 'succeeded'
      return Response.new(false, error_message, intent)
    end
  else
    charge_id = intent_id
  end

  super(money, charge_id, options)
end

#show_intent(intent_id, options) ⇒ Object


43
44
45
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 43

def show_intent(intent_id, options)
  commit(:get, "payment_intents/#{intent_id}", nil, options)
end

#store(payment_method, options = {}) ⇒ Object

Note: Not all payment methods are currently supported by the Payment Methods API Current implementation will create a PaymentMethod object if the method is a token or credit card All other types will default to legacy Stripe store


155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 155

def store(payment_method, options = {})
  params = {}
  post = {}

  # 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)

    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')
      customer = commit(:post, 'customers', post, options)
      customer_id = customer.params['id']
    end
    options = format_idempotency_key(options, 'attach')
    commit(:post, "payment_methods/#{params[:payment_method]}/attach", { customer: customer_id }, options)
  else
    super(payment_method, options)
  end
end

#unstore(identification, options = {}, deprecated_options = {}) ⇒ Object


182
183
184
185
186
187
188
189
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 182

def unstore(identification, options = {}, deprecated_options = {})
  if identification.include?('pm_')
    _, payment_method = identification.split('|')
    commit(:post, "payment_methods/#{payment_method}/detach", nil, options)
  else
    super(identification, options, deprecated_options)
  end
end

#update_intent(money, intent_id, payment_method, options = {}) ⇒ Object


71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 71

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)

  add_payment_method_types(post, options)
  add_customer(post, options)
  (post, options)
  add_shipping_address(post, options)
  (post, options)

  UPDATE_INTENT_ATTRIBUTES.each do |attribute|
    add_whitelisted_attribute(post, options, attribute)
  end
  commit(:post, "payment_intents/#{intent_id}", post, options)
end

#verify(payment_method, options = {}) ⇒ Object


191
192
193
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 191

def verify(payment_method, options = {})
  create_setup_intent(payment_method, options.merge!(confirm: true))
end

#void(intent_id, options = {}) ⇒ Object


126
127
128
129
130
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 126

def void(intent_id, options = {})
  post = {}
  post[:cancellation_reason] = options[:cancellation_reason] if ALLOWED_CANCELLATION_REASONS.include?(options[:cancellation_reason])
  commit(:post, "payment_intents/#{intent_id}/cancel", post, options)
end