Class: ActiveMerchant::Billing::StripeGateway
- Inherits:
-
Gateway
- Object
- Gateway
- ActiveMerchant::Billing::StripeGateway
show all
- Defined in:
- lib/active_merchant/billing/gateways/stripe.rb
Defined Under Namespace
Classes: StripePaymentToken
Constant Summary
collapse
- 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'
}
- 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],
'test_mode_live_card' => STANDARD_ERROR_CODE[:test_mode_live_card]
}
- BANK_ACCOUNT_HOLDER_TYPE_MAPPING =
{
"personal" => "individual",
"business" => "company",
}
Constants inherited
from Gateway
Gateway::CREDIT_DEPRECATION_MESSAGE, Gateway::DEBIT_CARDS, Gateway::RECURRING_DEPRECATION_MESSAGE, Gateway::STANDARD_ERROR_CODE
Instance Attribute Summary
Attributes inherited from Gateway
#options
Instance Method Summary
collapse
-
#application_fee_from_response(response) ⇒ Object
-
#authorize(money, payment, options = {}) ⇒ Object
-
#capture(money, authorization, options = {}) ⇒ Object
-
#initialize(options = {}) ⇒ StripeGateway
constructor
A new instance of StripeGateway.
-
#purchase(money, payment, options = {}) ⇒ Object
To create a charge on a card or a token, call.
-
#refund(money, identification, options = {}) ⇒ Object
-
#refund_application_fee(money, identification, options = {}) ⇒ Object
-
#scrub(transcript) ⇒ Object
-
#store(payment, options = {}) ⇒ Object
Note: creating a new credit card will not change the customer’s existing default credit card (use :set_default => true).
-
#supports_network_tokenization? ⇒ Boolean
-
#supports_scrubbing? ⇒ Boolean
-
#tokenize_apple_pay_token(apple_pay_payment_token, options = {}) ⇒ Object
-
#unstore(identification, options = {}, deprecated_options = {}) ⇒ Object
-
#update(customer_id, card_id, options = {}) ⇒ Object
-
#update_customer(customer_id, options = {}) ⇒ Object
-
#verify(payment, options = {}) ⇒ Object
-
#verify_credentials ⇒ Object
-
#void(identification, options = {}) ⇒ Object
Methods inherited from Gateway
#card_brand, card_brand, #generate_unique_id, inherited, supported_countries, #supported_countries, supported_countries=, supports?, #test?
#expdate, #format
Methods included from PostsData
included, #raw_ssl_request, #ssl_get, #ssl_post, #ssl_request
Constructor Details
#initialize(options = {}) ⇒ StripeGateway
Returns a new instance of StripeGateway.
54
55
56
57
58
59
60
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 54
def initialize(options = {})
requires!(options, :login)
@api_key = options[:login]
@fee_refund_api_key = options[:fee_refund_login]
super
end
|
Instance Method Details
#application_fee_from_response(response) ⇒ Object
149
150
151
152
153
154
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 149
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
|
#authorize(money, payment, options = {}) ⇒ Object
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 62
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
|
#capture(money, authorization, options = {}) ⇒ Object
105
106
107
108
109
110
111
112
113
114
115
116
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 105
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
|
#purchase(money, payment, options = {}) ⇒ Object
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, ... })
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 87
def purchase(money, payment, options = {})
if ach?(payment)
direct_bank_error = "Direct bank account transactions are not supported. Bank accounts must be stored and verified before use."
return Response.new(false, direct_bank_error)
end
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
|
#refund(money, identification, options = {}) ⇒ Object
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 124
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]
post[:metadata] = options[:metadata] if options[:metadata]
post[:expand] = [:charge]
MultiResponse.run(:first) do |r|
r.process { commit(:post, "charges/#{CGI.escape(identification)}/refunds", 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
|
#refund_application_fee(money, identification, options = {}) ⇒ Object
156
157
158
159
160
161
162
163
164
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 156
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
|
#scrub(transcript) ⇒ Object
254
255
256
257
258
259
260
261
262
263
264
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 254
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').
gsub(%r((card\[swipe_data\]=)[^&]+(&?)), '\1[FILTERED]\2').
gsub(%r((card\[encrypted_pin\]=)[^&]+(&?)), '\1[FILTERED]\2').
gsub(%r((card\[encrypted_pin_key_id\]=)[\w=]+(&?)), '\1[FILTERED]\2').
gsub(%r((card\[emv_auth_data\]=)[^&]+(&?)), '\1[FILTERED]\2')
end
|
#store(payment, options = {}) ⇒ Object
Note: creating a new credit card will not change the customer’s existing default credit card (use :set_default => true)
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 167
def store(payment, options = {})
params = {}
post = {}
if payment.is_a?(ApplePayPaymentToken)
token_exchange_response = tokenize_apple_pay_token(payment)
params = { card: token_exchange_response.params["token"]["id"] } if token_exchange_response.success?
elsif payment.is_a?(StripePaymentToken)
add_payment_token(params, payment, options)
elsif payment.is_a?(Check)
bank_token_response = tokenize_bank_account(payment)
return bank_token_response unless bank_token_response.success?
params = { source: bank_token_response.params["token"]["id"] }
else
add_creditcard(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[:account]
add_external_account(post, params, payment)
commit(:post, "accounts/#{CGI.escape(options[:account])}/external_accounts", post, options)
elsif options[:customer]
MultiResponse.run(:first) do |r|
r.process { commit(:post, "customers/#{CGI.escape(options[:customer])}/cards", 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(params), options)
end
end
|
#supports_network_tokenization? ⇒ Boolean
266
267
268
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 266
def supports_network_tokenization?
true
end
|
#supports_scrubbing? ⇒ Boolean
250
251
252
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 250
def supports_scrubbing?
true
end
|
#tokenize_apple_pay_token(apple_pay_payment_token, options = {}) ⇒ Object
229
230
231
232
233
234
235
236
237
238
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 229
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
|
#unstore(identification, options = {}, deprecated_options = {}) ⇒ Object
217
218
219
220
221
222
223
224
225
226
227
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 217
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
|
#update(customer_id, card_id, options = {}) ⇒ Object
209
210
211
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 209
def update(customer_id, card_id, options = {})
commit(:post, "customers/#{CGI.escape(customer_id)}/cards/#{CGI.escape(card_id)}", options, options)
end
|
#update_customer(customer_id, options = {}) ⇒ Object
213
214
215
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 213
def update_customer(customer_id, options = {})
commit(:post, "customers/#{CGI.escape(customer_id)}", options, options)
end
|
#verify(payment, options = {}) ⇒ Object
142
143
144
145
146
147
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 142
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
|
#verify_credentials ⇒ Object
240
241
242
243
244
245
246
247
248
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 240
def verify_credentials
begin
ssl_get(live_url + "charges/nonexistent", )
rescue ResponseError => e
return false if e.response.code.to_i == 401
end
true
end
|
#void(identification, options = {}) ⇒ Object
118
119
120
121
122
|
# File 'lib/active_merchant/billing/gateways/stripe.rb', line 118
def void(identification, options = {})
post = {}
post[:expand] = [:charge]
commit(:post, "charges/#{CGI.escape(identification)}/refunds", post, options)
end
|