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



84
85
86
 
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 84

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 



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

def capture(money, intent_id, options = {})
  post = {}
  post[:amount_to_capture] = money
  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]
  commit(:post, "payment_intents/#{intent_id}/capture", post, options)
end

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



43
44
45
46
47
48
49
50
51
 
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 43

def confirm_intent(intent_id, payment_method, options = {})
  post = {}
  add_payment_method_token(post, payment_method, options)
  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 



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

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)
  add_payment_method_token(post, payment_method, options)
  add_metadata(post, options)
  add_return_url(post, options)
  (post, options)
  add_shipping_address(post, options)
  setup_future_usage(post, options)
  add_exemption(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 



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 53

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)

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

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



88
89
90
 
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 88

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 



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

def refund(money, intent_id, options = {})
  intent = commit(:get, "payment_intents/#{intent_id}", nil, options)
  charge_id = intent.params.dig('charges', 'data')[0].dig('id')
  super(money, charge_id, options)
end

#show_intent(intent_id, options) ⇒ Object 



39
40
41
 
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 39

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



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 118

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)
    add_payment_method_token(params, payment_method, options)
    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]
      customer = commit(:post, 'customers', post, options)
      customer_id = customer.params['id']
    end
    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 



141
142
143
144
145
146
147
148
 
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 141

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 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/active_merchant/billing/gateways/stripe_payment_intents.rb', line 66

def update_intent(money, intent_id, payment_method, options = {})
  post = {}
  post[:amount] = money if money

  add_payment_method_token(post, payment_method, options)
  add_payment_method_types(post, options)
  add_customer(post, options)
  add_metadata(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

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



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

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