Class: Payment::Apis::Stripe

Inherits:
BaseService
  • Object
show all
Includes:
Singleton
Defined in:
app/services/payment/apis/stripe.rb

Constant Summary collapse

FLEXIBLE_CARD_FEATURES = 
{
  usa: {
    multicapture:              true,
    incremental_authorization: true,
    extended_authorization:    true,
    overcapture:               false
  }.freeze,
  can: {
    multicapture:              true,
    incremental_authorization: true,
    extended_authorization:    true,
    overcapture:               false
  }.freeze
}.freeze

Class Method Summary collapse

Class Method Details

.api_key(currency_or_country) ⇒ Object

========================================
Account Routing (US / CA)



11
12
13
14
 
# File 'app/services/payment/apis/stripe.rb', line 11

def self.api_key(currency_or_country)
  region = region_for(currency_or_country)
  Heatwave::Configuration.fetch(:stripe, region, :login)
end

.attach_payment_method(payment_method_id, customer_id:, currency:) ⇒ Object 



144
145
146
 
# File 'app/services/payment/apis/stripe.rb', line 144

def self.attach_payment_method(payment_method_id, customer_id:, currency:)
  ::Stripe::PaymentMethod.attach(payment_method_id, { customer: customer_id }, stripe_options(currency))
end

.cancel_payment_intent(payment_intent_id, currency:, reason: nil) ⇒ Object 



88
89
90
91
92
93
94
95
 
# File 'app/services/payment/apis/stripe.rb', line 88

def self.cancel_payment_intent(payment_intent_id, currency:, reason: nil)
  resolved_id = resolve_payment_intent_id(payment_intent_id, currency: currency)
  return refund_charge(payment_intent_id, currency: currency) if resolved_id.nil?

  params = {}
  params[:cancellation_reason] = reason if reason.present?
  ::Stripe::PaymentIntent.cancel(resolved_id, params, stripe_options(currency))
end

.capture_charge(charge_id, currency:, amount_cents: nil) ⇒ Object 



183
184
185
186
187
 
# File 'app/services/payment/apis/stripe.rb', line 183

def self.capture_charge(charge_id, currency:, amount_cents: nil)
  params = {}
  params[:amount] = amount_cents if amount_cents.present?
  ::Stripe::Charge.capture(charge_id, params, stripe_options(currency))
end

.capture_payment_intent(payment_intent_id, currency:, amount_cents: nil, final_capture: true) ⇒ Object 



72
73
74
75
76
77
78
79
80
 
# File 'app/services/payment/apis/stripe.rb', line 72

def self.capture_payment_intent(payment_intent_id, currency:, amount_cents: nil, final_capture: true)
  resolved_id = resolve_payment_intent_id(payment_intent_id, currency: currency)
  return capture_charge(payment_intent_id, currency: currency, amount_cents: amount_cents) if resolved_id.nil?

  params = {}
  params[:amount_to_capture] = amount_cents if amount_cents.present?
  params[:final_capture] = false unless final_capture
  ::Stripe::PaymentIntent.capture(resolved_id, params, stripe_options(currency))
end

.charge?(id) ⇒ Boolean

Returns:

  • (Boolean) 


204
205
206
 
# File 'app/services/payment/apis/stripe.rb', line 204

def self.charge?(id)
  id.to_s.start_with?('ch_')
end

.confirm_payment_intent(payment_intent_id, currency:, payment_method: nil, return_url: nil) ⇒ Object 



97
98
99
100
101
102
 
# File 'app/services/payment/apis/stripe.rb', line 97

def self.confirm_payment_intent(payment_intent_id, currency:, payment_method: nil, return_url: nil)
  params = {}
  params[:payment_method] = payment_method if payment_method.present?
  params[:return_url] = return_url if return_url.present?
  ::Stripe::PaymentIntent.confirm(payment_intent_id, params, stripe_options(currency))
end

.create_customer(currency:, email: nil, name: nil, metadata: {}) ⇒ Object

========================================
Customer Operations



125
126
127
128
129
130
 
# File 'app/services/payment/apis/stripe.rb', line 125

def self.create_customer(currency:, email: nil, name: nil, metadata: {})
  params = { metadata: metadata }
  params[:email] = email if email.present?
  params[:name] = name if name.present?
  ::Stripe::Customer.create(params, stripe_options(currency))
end

.create_payment_intent(amount_cents:, currency:, customer_id: nil, payment_method: nil, capture_method: 'manual', confirm: false, off_session: false, setup_future_usage: nil, metadata: {}, description: nil, statement_descriptor: nil, shipping: nil, return_url: nil, payment_method_types: nil, allow_redirects: 'never', payment_method_options: nil) ⇒ Object

========================================
PaymentIntent Operations



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'app/services/payment/apis/stripe.rb', line 25

def self.create_payment_intent(amount_cents:, currency:, customer_id: nil, payment_method: nil,
                               capture_method: 'manual', confirm: false, off_session: false,
                               setup_future_usage: nil, metadata: {}, description: nil,
                               statement_descriptor: nil, shipping: nil, return_url: nil,
                               payment_method_types: nil, allow_redirects: 'never',
                               payment_method_options: nil)
  params = {
    amount: amount_cents,
    currency: currency.downcase,
    capture_method: capture_method,
    metadata: metadata
  }
  merged_pmo = if capture_method == 'manual'
                 base = flexible_card_options(currency)
                 base ? base.deep_merge(payment_method_options || {}) : payment_method_options
               else
                 payment_method_options
               end
  params[:payment_method_options] = merged_pmo if merged_pmo.present?
  params[:customer] = customer_id if customer_id.present?
  params[:payment_method] = payment_method if payment_method.present?
  params[:confirm] = confirm if confirm
  params[:off_session] = off_session if off_session
  params[:setup_future_usage] = setup_future_usage if setup_future_usage.present?
  params[:description] = description if description.present?
  params[:statement_descriptor_suffix] = truncate_descriptor(statement_descriptor) if statement_descriptor.present?
  params[:shipping] = shipping if shipping.present?
  params[:return_url] = return_url if return_url.present?

  if payment_method_types.present?
    params[:payment_method_types] = payment_method_types
  elsif confirm && off_session
    params[:payment_method_types] = ['card']
  else
    params[:automatic_payment_methods] = { enabled: true, allow_redirects: allow_redirects }
  end

  ::Stripe::PaymentIntent.create(params, stripe_options(currency))
end

.create_refund(payment_intent_id:, currency:, amount_cents: nil, reason: nil) ⇒ Object

========================================
Refund Operations



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'app/services/payment/apis/stripe.rb', line 108

def self.create_refund(payment_intent_id:, currency:, amount_cents: nil, reason: nil)
  resolved_id = resolve_payment_intent_id(payment_intent_id, currency: currency)
  params = {}
  if resolved_id.nil?
    params[:charge] = payment_intent_id
  else
    params[:payment_intent] = resolved_id
  end
  params[:amount] = amount_cents if amount_cents.present?
  params[:reason] = reason if reason.present?
  ::Stripe::Refund.create(params, stripe_options(currency))
end

.create_setup_intent(currency:, customer_id: nil, payment_method_types: ['card'], usage: 'off_session', metadata: {}) ⇒ Object

========================================
SetupIntent Operations



160
161
162
163
164
165
166
167
168
169
 
# File 'app/services/payment/apis/stripe.rb', line 160

def self.create_setup_intent(currency:, customer_id: nil, payment_method_types: ['card'],
                             usage: 'off_session', metadata: {})
  params = {
    payment_method_types: payment_method_types,
    usage: usage,
    metadata: metadata
  }
  params[:customer] = customer_id if customer_id.present?
  ::Stripe::SetupIntent.create(params, stripe_options(currency))
end

.detach_payment_method(payment_method_id, currency:) ⇒ Object 



148
149
150
 
# File 'app/services/payment/apis/stripe.rb', line 148

def self.detach_payment_method(payment_method_id, currency:)
  ::Stripe::PaymentMethod.detach(payment_method_id, {}, stripe_options(currency))
end

.increment_authorization(payment_intent_id, amount_cents:, currency:, description: nil) ⇒ Object 



82
83
84
85
86
 
# File 'app/services/payment/apis/stripe.rb', line 82

def self.increment_authorization(payment_intent_id, amount_cents:, currency:, description: nil)
  params = { amount: amount_cents }
  params[:description] = description if description.present?
  ::Stripe::PaymentIntent.increment_authorization(payment_intent_id, params, stripe_options(currency))
end

.list_payment_methods(customer_id, currency:, type: 'card') ⇒ Object 



152
153
154
 
# File 'app/services/payment/apis/stripe.rb', line 152

def self.list_payment_methods(customer_id, currency:, type: 'card')
  ::Stripe::Customer.list_payment_methods(customer_id, { type: type }, stripe_options(currency))
end

.payment_intent?(id) ⇒ Boolean

========================================
Helpers

Returns:

  • (Boolean) 


200
201
202
 
# File 'app/services/payment/apis/stripe.rb', line 200

def self.payment_intent?(id)
  id.to_s.start_with?('pi_')
end

.publishable_key(currency_or_country) ⇒ Object 



16
17
18
19
 
# File 'app/services/payment/apis/stripe.rb', line 16

def self.publishable_key(currency_or_country)
  region = region_for(currency_or_country)
  Heatwave::Configuration.fetch(:stripe, region, :key)
end

.refund_charge(charge_id, currency:, amount_cents: nil, reason: nil) ⇒ Object 



189
190
191
192
193
194
 
# File 'app/services/payment/apis/stripe.rb', line 189

def self.refund_charge(charge_id, currency:, amount_cents: nil, reason: nil)
  params = { charge: charge_id }
  params[:amount] = amount_cents if amount_cents.present?
  params[:reason] = reason if reason.present?
  ::Stripe::Refund.create(params, stripe_options(currency))
end

.retrieve_charge(charge_id, currency:) ⇒ Object

========================================
Charge Operations (backward compat for old ch_xxx payments)



179
180
181
 
# File 'app/services/payment/apis/stripe.rb', line 179

def self.retrieve_charge(charge_id, currency:)
  ::Stripe::Charge.retrieve(charge_id, stripe_options(currency))
end

.retrieve_customer(customer_id, currency:) ⇒ Object 



132
133
134
 
# File 'app/services/payment/apis/stripe.rb', line 132

def self.retrieve_customer(customer_id, currency:)
  ::Stripe::Customer.retrieve(customer_id, stripe_options(currency))
end

.retrieve_payment_intent(payment_intent_id, currency:, expand: %w[latest_charge latest_charge.payment_method_details])) ⇒ Object 



65
66
67
68
69
70
 
# File 'app/services/payment/apis/stripe.rb', line 65

def self.retrieve_payment_intent(payment_intent_id, currency:, expand: %w[latest_charge latest_charge.payment_method_details])
  ::Stripe::PaymentIntent.retrieve(
    { id: payment_intent_id, expand: expand },
    stripe_options(currency)
  )
end

.retrieve_payment_method(payment_method_id, currency:) ⇒ Object

========================================
PaymentMethod Operations



140
141
142
 
# File 'app/services/payment/apis/stripe.rb', line 140

def self.retrieve_payment_method(payment_method_id, currency:)
  ::Stripe::PaymentMethod.retrieve(payment_method_id, stripe_options(currency))
end

.retrieve_payment_object(id, currency:) ⇒ Object 



208
209
210
211
212
213
214
 
# File 'app/services/payment/apis/stripe.rb', line 208

def self.retrieve_payment_object(id, currency:)
  if payment_intent?(id)
    retrieve_payment_intent(id, currency: currency)
  elsif charge?(id)
    retrieve_charge(id, currency: currency)
  end
end

.retrieve_setup_intent(setup_intent_id, currency:) ⇒ Object 



171
172
173
 
# File 'app/services/payment/apis/stripe.rb', line 171

def self.retrieve_setup_intent(setup_intent_id, currency:)
  ::Stripe::SetupIntent.retrieve(setup_intent_id, stripe_options(currency))
end