increase 1.232.0 → 1.234.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +16 -0
- data/README.md +1 -1
- data/lib/increase/models/card_payment.rb +24 -6
- data/lib/increase/models/declined_transaction.rb +8 -2
- data/lib/increase/models/pending_transaction.rb +4 -1
- data/lib/increase/models/real_time_decision.rb +613 -5
- data/lib/increase/models/simulations/card_authorization_create_params.rb +8 -2
- data/lib/increase/models/simulations/card_balance_inquiry_create_params.rb +8 -2
- data/lib/increase/models/transaction.rb +4 -1
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/card_payment.rbi +48 -6
- data/rbi/increase/models/declined_transaction.rbi +16 -2
- data/rbi/increase/models/pending_transaction.rbi +8 -1
- data/rbi/increase/models/real_time_decision.rbi +1157 -67
- data/rbi/increase/models/simulations/card_authorization_create_params.rbi +16 -2
- data/rbi/increase/models/simulations/card_balance_inquiry_create_params.rbi +16 -2
- data/rbi/increase/models/transaction.rbi +8 -1
- data/sig/increase/models/card_payment.rbs +30 -6
- data/sig/increase/models/declined_transaction.rbs +10 -2
- data/sig/increase/models/pending_transaction.rbs +5 -1
- data/sig/increase/models/real_time_decision.rbs +493 -2
- data/sig/increase/models/simulations/card_authorization_create_params.rbs +10 -2
- data/sig/increase/models/simulations/card_balance_inquiry_create_params.rbs +10 -2
- data/sig/increase/models/transaction.rbs +5 -1
- metadata +2 -2
|
@@ -118,24 +118,245 @@ module Increase
|
|
|
118
118
|
|
|
119
119
|
# @see Increase::Models::RealTimeDecision#card_authentication
|
|
120
120
|
class CardAuthentication < Increase::Internal::Type::BaseModel
|
|
121
|
+
# @!attribute access_control_server_transaction_id
|
|
122
|
+
# A unique identifier assigned by the Access Control Server (us) for this
|
|
123
|
+
# transaction.
|
|
124
|
+
#
|
|
125
|
+
# @return [String]
|
|
126
|
+
required :access_control_server_transaction_id, String
|
|
127
|
+
|
|
121
128
|
# @!attribute account_id
|
|
122
129
|
# The identifier of the Account the card belongs to.
|
|
123
130
|
#
|
|
124
131
|
# @return [String]
|
|
125
132
|
required :account_id, String
|
|
126
133
|
|
|
134
|
+
# @!attribute billing_address_city
|
|
135
|
+
# The city of the cardholder billing address associated with the card used for
|
|
136
|
+
# this purchase.
|
|
137
|
+
#
|
|
138
|
+
# @return [String, nil]
|
|
139
|
+
required :billing_address_city, String, nil?: true
|
|
140
|
+
|
|
141
|
+
# @!attribute billing_address_country
|
|
142
|
+
# The country of the cardholder billing address associated with the card used for
|
|
143
|
+
# this purchase.
|
|
144
|
+
#
|
|
145
|
+
# @return [String, nil]
|
|
146
|
+
required :billing_address_country, String, nil?: true
|
|
147
|
+
|
|
148
|
+
# @!attribute billing_address_line1
|
|
149
|
+
# The first line of the cardholder billing address associated with the card used
|
|
150
|
+
# for this purchase.
|
|
151
|
+
#
|
|
152
|
+
# @return [String, nil]
|
|
153
|
+
required :billing_address_line1, String, nil?: true
|
|
154
|
+
|
|
155
|
+
# @!attribute billing_address_line2
|
|
156
|
+
# The second line of the cardholder billing address associated with the card used
|
|
157
|
+
# for this purchase.
|
|
158
|
+
#
|
|
159
|
+
# @return [String, nil]
|
|
160
|
+
required :billing_address_line2, String, nil?: true
|
|
161
|
+
|
|
162
|
+
# @!attribute billing_address_line3
|
|
163
|
+
# The third line of the cardholder billing address associated with the card used
|
|
164
|
+
# for this purchase.
|
|
165
|
+
#
|
|
166
|
+
# @return [String, nil]
|
|
167
|
+
required :billing_address_line3, String, nil?: true
|
|
168
|
+
|
|
169
|
+
# @!attribute billing_address_postal_code
|
|
170
|
+
# The postal code of the cardholder billing address associated with the card used
|
|
171
|
+
# for this purchase.
|
|
172
|
+
#
|
|
173
|
+
# @return [String, nil]
|
|
174
|
+
required :billing_address_postal_code, String, nil?: true
|
|
175
|
+
|
|
176
|
+
# @!attribute billing_address_state
|
|
177
|
+
# The US state of the cardholder billing address associated with the card used for
|
|
178
|
+
# this purchase.
|
|
179
|
+
#
|
|
180
|
+
# @return [String, nil]
|
|
181
|
+
required :billing_address_state, String, nil?: true
|
|
182
|
+
|
|
127
183
|
# @!attribute card_id
|
|
128
|
-
# The identifier of the Card
|
|
184
|
+
# The identifier of the Card.
|
|
129
185
|
#
|
|
130
186
|
# @return [String]
|
|
131
187
|
required :card_id, String
|
|
132
188
|
|
|
189
|
+
# @!attribute cardholder_email
|
|
190
|
+
# The email address of the cardholder.
|
|
191
|
+
#
|
|
192
|
+
# @return [String, nil]
|
|
193
|
+
required :cardholder_email, String, nil?: true
|
|
194
|
+
|
|
195
|
+
# @!attribute cardholder_name
|
|
196
|
+
# The name of the cardholder.
|
|
197
|
+
#
|
|
198
|
+
# @return [String, nil]
|
|
199
|
+
required :cardholder_name, String, nil?: true
|
|
200
|
+
|
|
201
|
+
# @!attribute category
|
|
202
|
+
# The category of the card authentication attempt.
|
|
203
|
+
#
|
|
204
|
+
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Category, nil]
|
|
205
|
+
required :category, enum: -> { Increase::RealTimeDecision::CardAuthentication::Category }, nil?: true
|
|
206
|
+
|
|
133
207
|
# @!attribute decision
|
|
134
208
|
# Whether or not the authentication attempt was approved.
|
|
135
209
|
#
|
|
136
210
|
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil]
|
|
137
211
|
required :decision, enum: -> { Increase::RealTimeDecision::CardAuthentication::Decision }, nil?: true
|
|
138
212
|
|
|
213
|
+
# @!attribute device_channel
|
|
214
|
+
# The device channel of the card authentication attempt.
|
|
215
|
+
#
|
|
216
|
+
# @return [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel]
|
|
217
|
+
required :device_channel, -> { Increase::RealTimeDecision::CardAuthentication::DeviceChannel }
|
|
218
|
+
|
|
219
|
+
# @!attribute directory_server_transaction_id
|
|
220
|
+
# A unique identifier assigned by the Directory Server (the card network) for this
|
|
221
|
+
# transaction.
|
|
222
|
+
#
|
|
223
|
+
# @return [String]
|
|
224
|
+
required :directory_server_transaction_id, String
|
|
225
|
+
|
|
226
|
+
# @!attribute merchant_acceptor_id
|
|
227
|
+
# The merchant identifier (commonly abbreviated as MID) of the merchant the card
|
|
228
|
+
# is transacting with.
|
|
229
|
+
#
|
|
230
|
+
# @return [String]
|
|
231
|
+
required :merchant_acceptor_id, String
|
|
232
|
+
|
|
233
|
+
# @!attribute merchant_category_code
|
|
234
|
+
# The Merchant Category Code (commonly abbreviated as MCC) of the merchant the
|
|
235
|
+
# card is transacting with.
|
|
236
|
+
#
|
|
237
|
+
# @return [String]
|
|
238
|
+
required :merchant_category_code, String
|
|
239
|
+
|
|
240
|
+
# @!attribute merchant_country
|
|
241
|
+
# The country the merchant resides in.
|
|
242
|
+
#
|
|
243
|
+
# @return [String]
|
|
244
|
+
required :merchant_country, String
|
|
245
|
+
|
|
246
|
+
# @!attribute merchant_name
|
|
247
|
+
# The name of the merchant.
|
|
248
|
+
#
|
|
249
|
+
# @return [String]
|
|
250
|
+
required :merchant_name, String
|
|
251
|
+
|
|
252
|
+
# @!attribute prior_card_authentication_id
|
|
253
|
+
# The ID of a prior Card Authentication that the requestor used to authenticate
|
|
254
|
+
# this cardholder for a previous transaction.
|
|
255
|
+
#
|
|
256
|
+
# @return [String, nil]
|
|
257
|
+
required :prior_card_authentication_id, String, nil?: true
|
|
258
|
+
|
|
259
|
+
# @!attribute purchase_amount
|
|
260
|
+
# The purchase amount in minor units.
|
|
261
|
+
#
|
|
262
|
+
# @return [Integer, nil]
|
|
263
|
+
required :purchase_amount, Integer, nil?: true
|
|
264
|
+
|
|
265
|
+
# @!attribute purchase_currency
|
|
266
|
+
# The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the
|
|
267
|
+
# authentication attempt's purchase currency.
|
|
268
|
+
#
|
|
269
|
+
# @return [String, nil]
|
|
270
|
+
required :purchase_currency, String, nil?: true
|
|
271
|
+
|
|
272
|
+
# @!attribute requestor_authentication_indicator
|
|
273
|
+
# The 3DS requestor authentication indicator describes why the authentication
|
|
274
|
+
# attempt is performed, such as for a recurring transaction.
|
|
275
|
+
#
|
|
276
|
+
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator, nil]
|
|
277
|
+
required :requestor_authentication_indicator,
|
|
278
|
+
enum: -> {
|
|
279
|
+
Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator
|
|
280
|
+
},
|
|
281
|
+
nil?: true
|
|
282
|
+
|
|
283
|
+
# @!attribute requestor_challenge_indicator
|
|
284
|
+
# Indicates whether a challenge is requested for this transaction.
|
|
285
|
+
#
|
|
286
|
+
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator, nil]
|
|
287
|
+
required :requestor_challenge_indicator,
|
|
288
|
+
enum: -> { Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator },
|
|
289
|
+
nil?: true
|
|
290
|
+
|
|
291
|
+
# @!attribute requestor_name
|
|
292
|
+
# The name of the 3DS requestor.
|
|
293
|
+
#
|
|
294
|
+
# @return [String]
|
|
295
|
+
required :requestor_name, String
|
|
296
|
+
|
|
297
|
+
# @!attribute requestor_url
|
|
298
|
+
# The URL of the 3DS requestor.
|
|
299
|
+
#
|
|
300
|
+
# @return [String]
|
|
301
|
+
required :requestor_url, String
|
|
302
|
+
|
|
303
|
+
# @!attribute shipping_address_city
|
|
304
|
+
# The city of the shipping address associated with this purchase.
|
|
305
|
+
#
|
|
306
|
+
# @return [String, nil]
|
|
307
|
+
required :shipping_address_city, String, nil?: true
|
|
308
|
+
|
|
309
|
+
# @!attribute shipping_address_country
|
|
310
|
+
# The country of the shipping address associated with this purchase.
|
|
311
|
+
#
|
|
312
|
+
# @return [String, nil]
|
|
313
|
+
required :shipping_address_country, String, nil?: true
|
|
314
|
+
|
|
315
|
+
# @!attribute shipping_address_line1
|
|
316
|
+
# The first line of the shipping address associated with this purchase.
|
|
317
|
+
#
|
|
318
|
+
# @return [String, nil]
|
|
319
|
+
required :shipping_address_line1, String, nil?: true
|
|
320
|
+
|
|
321
|
+
# @!attribute shipping_address_line2
|
|
322
|
+
# The second line of the shipping address associated with this purchase.
|
|
323
|
+
#
|
|
324
|
+
# @return [String, nil]
|
|
325
|
+
required :shipping_address_line2, String, nil?: true
|
|
326
|
+
|
|
327
|
+
# @!attribute shipping_address_line3
|
|
328
|
+
# The third line of the shipping address associated with this purchase.
|
|
329
|
+
#
|
|
330
|
+
# @return [String, nil]
|
|
331
|
+
required :shipping_address_line3, String, nil?: true
|
|
332
|
+
|
|
333
|
+
# @!attribute shipping_address_postal_code
|
|
334
|
+
# The postal code of the shipping address associated with this purchase.
|
|
335
|
+
#
|
|
336
|
+
# @return [String, nil]
|
|
337
|
+
required :shipping_address_postal_code, String, nil?: true
|
|
338
|
+
|
|
339
|
+
# @!attribute shipping_address_state
|
|
340
|
+
# The US state of the shipping address associated with this purchase.
|
|
341
|
+
#
|
|
342
|
+
# @return [String, nil]
|
|
343
|
+
required :shipping_address_state, String, nil?: true
|
|
344
|
+
|
|
345
|
+
# @!attribute three_d_secure_server_transaction_id
|
|
346
|
+
# A unique identifier assigned by the 3DS Server initiating the authentication
|
|
347
|
+
# attempt for this transaction.
|
|
348
|
+
#
|
|
349
|
+
# @return [String]
|
|
350
|
+
required :three_d_secure_server_transaction_id, String
|
|
351
|
+
|
|
352
|
+
# @!attribute transaction_type
|
|
353
|
+
# The type of transaction being authenticated.
|
|
354
|
+
#
|
|
355
|
+
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::TransactionType, nil]
|
|
356
|
+
required :transaction_type,
|
|
357
|
+
enum: -> { Increase::RealTimeDecision::CardAuthentication::TransactionType },
|
|
358
|
+
nil?: true
|
|
359
|
+
|
|
139
360
|
# @!attribute upcoming_card_payment_id
|
|
140
361
|
# The identifier of the Card Payment this authentication attempt will belong to.
|
|
141
362
|
# Available in the API once the card authentication has completed.
|
|
@@ -143,20 +364,102 @@ module Increase
|
|
|
143
364
|
# @return [String]
|
|
144
365
|
required :upcoming_card_payment_id, String
|
|
145
366
|
|
|
146
|
-
# @!method initialize(account_id:, card_id:, decision:, upcoming_card_payment_id:)
|
|
367
|
+
# @!method initialize(access_control_server_transaction_id:, account_id:, billing_address_city:, billing_address_country:, billing_address_line1:, billing_address_line2:, billing_address_line3:, billing_address_postal_code:, billing_address_state:, card_id:, cardholder_email:, cardholder_name:, category:, decision:, device_channel:, directory_server_transaction_id:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, prior_card_authentication_id:, purchase_amount:, purchase_currency:, requestor_authentication_indicator:, requestor_challenge_indicator:, requestor_name:, requestor_url:, shipping_address_city:, shipping_address_country:, shipping_address_line1:, shipping_address_line2:, shipping_address_line3:, shipping_address_postal_code:, shipping_address_state:, three_d_secure_server_transaction_id:, transaction_type:, upcoming_card_payment_id:)
|
|
147
368
|
# Some parameter documentations has been truncated, see
|
|
148
369
|
# {Increase::Models::RealTimeDecision::CardAuthentication} for more details.
|
|
149
370
|
#
|
|
150
371
|
# Fields related to a 3DS authentication attempt.
|
|
151
372
|
#
|
|
373
|
+
# @param access_control_server_transaction_id [String] A unique identifier assigned by the Access Control Server (us) for this transact
|
|
374
|
+
#
|
|
152
375
|
# @param account_id [String] The identifier of the Account the card belongs to.
|
|
153
376
|
#
|
|
154
|
-
# @param
|
|
377
|
+
# @param billing_address_city [String, nil] The city of the cardholder billing address associated with the card used for thi
|
|
378
|
+
#
|
|
379
|
+
# @param billing_address_country [String, nil] The country of the cardholder billing address associated with the card used for
|
|
380
|
+
#
|
|
381
|
+
# @param billing_address_line1 [String, nil] The first line of the cardholder billing address associated with the card used f
|
|
382
|
+
#
|
|
383
|
+
# @param billing_address_line2 [String, nil] The second line of the cardholder billing address associated with the card used
|
|
384
|
+
#
|
|
385
|
+
# @param billing_address_line3 [String, nil] The third line of the cardholder billing address associated with the card used f
|
|
386
|
+
#
|
|
387
|
+
# @param billing_address_postal_code [String, nil] The postal code of the cardholder billing address associated with the card used
|
|
388
|
+
#
|
|
389
|
+
# @param billing_address_state [String, nil] The US state of the cardholder billing address associated with the card used for
|
|
390
|
+
#
|
|
391
|
+
# @param card_id [String] The identifier of the Card.
|
|
392
|
+
#
|
|
393
|
+
# @param cardholder_email [String, nil] The email address of the cardholder.
|
|
394
|
+
#
|
|
395
|
+
# @param cardholder_name [String, nil] The name of the cardholder.
|
|
396
|
+
#
|
|
397
|
+
# @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Category, nil] The category of the card authentication attempt.
|
|
155
398
|
#
|
|
156
399
|
# @param decision [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil] Whether or not the authentication attempt was approved.
|
|
157
400
|
#
|
|
401
|
+
# @param device_channel [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel] The device channel of the card authentication attempt.
|
|
402
|
+
#
|
|
403
|
+
# @param directory_server_transaction_id [String] A unique identifier assigned by the Directory Server (the card network) for this
|
|
404
|
+
#
|
|
405
|
+
# @param merchant_acceptor_id [String] The merchant identifier (commonly abbreviated as MID) of the merchant the card i
|
|
406
|
+
#
|
|
407
|
+
# @param merchant_category_code [String] The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car
|
|
408
|
+
#
|
|
409
|
+
# @param merchant_country [String] The country the merchant resides in.
|
|
410
|
+
#
|
|
411
|
+
# @param merchant_name [String] The name of the merchant.
|
|
412
|
+
#
|
|
413
|
+
# @param prior_card_authentication_id [String, nil] The ID of a prior Card Authentication that the requestor used to authenticate th
|
|
414
|
+
#
|
|
415
|
+
# @param purchase_amount [Integer, nil] The purchase amount in minor units.
|
|
416
|
+
#
|
|
417
|
+
# @param purchase_currency [String, nil] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authenticati
|
|
418
|
+
#
|
|
419
|
+
# @param requestor_authentication_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator, nil] The 3DS requestor authentication indicator describes why the authentication atte
|
|
420
|
+
#
|
|
421
|
+
# @param requestor_challenge_indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator, nil] Indicates whether a challenge is requested for this transaction.
|
|
422
|
+
#
|
|
423
|
+
# @param requestor_name [String] The name of the 3DS requestor.
|
|
424
|
+
#
|
|
425
|
+
# @param requestor_url [String] The URL of the 3DS requestor.
|
|
426
|
+
#
|
|
427
|
+
# @param shipping_address_city [String, nil] The city of the shipping address associated with this purchase.
|
|
428
|
+
#
|
|
429
|
+
# @param shipping_address_country [String, nil] The country of the shipping address associated with this purchase.
|
|
430
|
+
#
|
|
431
|
+
# @param shipping_address_line1 [String, nil] The first line of the shipping address associated with this purchase.
|
|
432
|
+
#
|
|
433
|
+
# @param shipping_address_line2 [String, nil] The second line of the shipping address associated with this purchase.
|
|
434
|
+
#
|
|
435
|
+
# @param shipping_address_line3 [String, nil] The third line of the shipping address associated with this purchase.
|
|
436
|
+
#
|
|
437
|
+
# @param shipping_address_postal_code [String, nil] The postal code of the shipping address associated with this purchase.
|
|
438
|
+
#
|
|
439
|
+
# @param shipping_address_state [String, nil] The US state of the shipping address associated with this purchase.
|
|
440
|
+
#
|
|
441
|
+
# @param three_d_secure_server_transaction_id [String] A unique identifier assigned by the 3DS Server initiating the authentication att
|
|
442
|
+
#
|
|
443
|
+
# @param transaction_type [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::TransactionType, nil] The type of transaction being authenticated.
|
|
444
|
+
#
|
|
158
445
|
# @param upcoming_card_payment_id [String] The identifier of the Card Payment this authentication attempt will belong to. A
|
|
159
446
|
|
|
447
|
+
# The category of the card authentication attempt.
|
|
448
|
+
#
|
|
449
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication#category
|
|
450
|
+
module Category
|
|
451
|
+
extend Increase::Internal::Type::Enum
|
|
452
|
+
|
|
453
|
+
# The authentication attempt is for a payment.
|
|
454
|
+
PAYMENT_AUTHENTICATION = :payment_authentication
|
|
455
|
+
|
|
456
|
+
# The authentication attempt is not for a payment.
|
|
457
|
+
NON_PAYMENT_AUTHENTICATION = :non_payment_authentication
|
|
458
|
+
|
|
459
|
+
# @!method self.values
|
|
460
|
+
# @return [Array<Symbol>]
|
|
461
|
+
end
|
|
462
|
+
|
|
160
463
|
# Whether or not the authentication attempt was approved.
|
|
161
464
|
#
|
|
162
465
|
# @see Increase::Models::RealTimeDecision::CardAuthentication#decision
|
|
@@ -175,6 +478,305 @@ module Increase
|
|
|
175
478
|
# @!method self.values
|
|
176
479
|
# @return [Array<Symbol>]
|
|
177
480
|
end
|
|
481
|
+
|
|
482
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication#device_channel
|
|
483
|
+
class DeviceChannel < Increase::Internal::Type::BaseModel
|
|
484
|
+
# @!attribute browser
|
|
485
|
+
# Fields specific to the browser device channel.
|
|
486
|
+
#
|
|
487
|
+
# @return [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Browser, nil]
|
|
488
|
+
required :browser,
|
|
489
|
+
-> { Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser },
|
|
490
|
+
nil?: true
|
|
491
|
+
|
|
492
|
+
# @!attribute category
|
|
493
|
+
# The category of the device channel.
|
|
494
|
+
#
|
|
495
|
+
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Category]
|
|
496
|
+
required :category, enum: -> { Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Category }
|
|
497
|
+
|
|
498
|
+
# @!attribute merchant_initiated
|
|
499
|
+
# Fields specific to merchant initiated transactions.
|
|
500
|
+
#
|
|
501
|
+
# @return [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated, nil]
|
|
502
|
+
required :merchant_initiated,
|
|
503
|
+
-> { Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated },
|
|
504
|
+
nil?: true
|
|
505
|
+
|
|
506
|
+
# @!method initialize(browser:, category:, merchant_initiated:)
|
|
507
|
+
# The device channel of the card authentication attempt.
|
|
508
|
+
#
|
|
509
|
+
# @param browser [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Browser, nil] Fields specific to the browser device channel.
|
|
510
|
+
#
|
|
511
|
+
# @param category [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Category] The category of the device channel.
|
|
512
|
+
#
|
|
513
|
+
# @param merchant_initiated [Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated, nil] Fields specific to merchant initiated transactions.
|
|
514
|
+
|
|
515
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel#browser
|
|
516
|
+
class Browser < Increase::Internal::Type::BaseModel
|
|
517
|
+
# @!attribute accept_header
|
|
518
|
+
# The accept header from the cardholder's browser.
|
|
519
|
+
#
|
|
520
|
+
# @return [String, nil]
|
|
521
|
+
required :accept_header, String, nil?: true
|
|
522
|
+
|
|
523
|
+
# @!attribute ip_address
|
|
524
|
+
# The IP address of the cardholder's browser.
|
|
525
|
+
#
|
|
526
|
+
# @return [String, nil]
|
|
527
|
+
required :ip_address, String, nil?: true
|
|
528
|
+
|
|
529
|
+
# @!attribute javascript_enabled
|
|
530
|
+
# Whether JavaScript is enabled in the cardholder's browser.
|
|
531
|
+
#
|
|
532
|
+
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled, nil]
|
|
533
|
+
required :javascript_enabled,
|
|
534
|
+
enum: -> {
|
|
535
|
+
Increase::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled
|
|
536
|
+
},
|
|
537
|
+
nil?: true
|
|
538
|
+
|
|
539
|
+
# @!attribute language
|
|
540
|
+
# The language of the cardholder's browser.
|
|
541
|
+
#
|
|
542
|
+
# @return [String, nil]
|
|
543
|
+
required :language, String, nil?: true
|
|
544
|
+
|
|
545
|
+
# @!attribute user_agent
|
|
546
|
+
# The user agent of the cardholder's browser.
|
|
547
|
+
#
|
|
548
|
+
# @return [String, nil]
|
|
549
|
+
required :user_agent, String, nil?: true
|
|
550
|
+
|
|
551
|
+
# @!method initialize(accept_header:, ip_address:, javascript_enabled:, language:, user_agent:)
|
|
552
|
+
# Fields specific to the browser device channel.
|
|
553
|
+
#
|
|
554
|
+
# @param accept_header [String, nil] The accept header from the cardholder's browser.
|
|
555
|
+
#
|
|
556
|
+
# @param ip_address [String, nil] The IP address of the cardholder's browser.
|
|
557
|
+
#
|
|
558
|
+
# @param javascript_enabled [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Browser::JavascriptEnabled, nil] Whether JavaScript is enabled in the cardholder's browser.
|
|
559
|
+
#
|
|
560
|
+
# @param language [String, nil] The language of the cardholder's browser.
|
|
561
|
+
#
|
|
562
|
+
# @param user_agent [String, nil] The user agent of the cardholder's browser.
|
|
563
|
+
|
|
564
|
+
# Whether JavaScript is enabled in the cardholder's browser.
|
|
565
|
+
#
|
|
566
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::Browser#javascript_enabled
|
|
567
|
+
module JavascriptEnabled
|
|
568
|
+
extend Increase::Internal::Type::Enum
|
|
569
|
+
|
|
570
|
+
# JavaScript is enabled in the cardholder's browser.
|
|
571
|
+
ENABLED = :enabled
|
|
572
|
+
|
|
573
|
+
# JavaScript is not enabled in the cardholder's browser.
|
|
574
|
+
DISABLED = :disabled
|
|
575
|
+
|
|
576
|
+
# @!method self.values
|
|
577
|
+
# @return [Array<Symbol>]
|
|
578
|
+
end
|
|
579
|
+
end
|
|
580
|
+
|
|
581
|
+
# The category of the device channel.
|
|
582
|
+
#
|
|
583
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel#category
|
|
584
|
+
module Category
|
|
585
|
+
extend Increase::Internal::Type::Enum
|
|
586
|
+
|
|
587
|
+
# The authentication attempt was made from an app.
|
|
588
|
+
APP = :app
|
|
589
|
+
|
|
590
|
+
# The authentication attempt was made from a browser.
|
|
591
|
+
BROWSER = :browser
|
|
592
|
+
|
|
593
|
+
# The authentication attempt was initiated by the 3DS Requestor.
|
|
594
|
+
THREE_DS_REQUESTOR_INITIATED = :three_ds_requestor_initiated
|
|
595
|
+
|
|
596
|
+
# @!method self.values
|
|
597
|
+
# @return [Array<Symbol>]
|
|
598
|
+
end
|
|
599
|
+
|
|
600
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel#merchant_initiated
|
|
601
|
+
class MerchantInitiated < Increase::Internal::Type::BaseModel
|
|
602
|
+
# @!attribute indicator
|
|
603
|
+
# The merchant initiated indicator for the transaction.
|
|
604
|
+
#
|
|
605
|
+
# @return [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator]
|
|
606
|
+
required :indicator,
|
|
607
|
+
enum: -> { Increase::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator }
|
|
608
|
+
|
|
609
|
+
# @!method initialize(indicator:)
|
|
610
|
+
# Fields specific to merchant initiated transactions.
|
|
611
|
+
#
|
|
612
|
+
# @param indicator [Symbol, Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated::Indicator] The merchant initiated indicator for the transaction.
|
|
613
|
+
|
|
614
|
+
# The merchant initiated indicator for the transaction.
|
|
615
|
+
#
|
|
616
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel::MerchantInitiated#indicator
|
|
617
|
+
module Indicator
|
|
618
|
+
extend Increase::Internal::Type::Enum
|
|
619
|
+
|
|
620
|
+
# Recurring transaction.
|
|
621
|
+
RECURRING_TRANSACTION = :recurring_transaction
|
|
622
|
+
|
|
623
|
+
# Installment transaction.
|
|
624
|
+
INSTALLMENT_TRANSACTION = :installment_transaction
|
|
625
|
+
|
|
626
|
+
# Add card.
|
|
627
|
+
ADD_CARD = :add_card
|
|
628
|
+
|
|
629
|
+
# Maintain card information.
|
|
630
|
+
MAINTAIN_CARD_INFORMATION = :maintain_card_information
|
|
631
|
+
|
|
632
|
+
# Account verification.
|
|
633
|
+
ACCOUNT_VERIFICATION = :account_verification
|
|
634
|
+
|
|
635
|
+
# Split or delayed shipment.
|
|
636
|
+
SPLIT_DELAYED_SHIPMENT = :split_delayed_shipment
|
|
637
|
+
|
|
638
|
+
# Top up.
|
|
639
|
+
TOP_UP = :top_up
|
|
640
|
+
|
|
641
|
+
# Mail order.
|
|
642
|
+
MAIL_ORDER = :mail_order
|
|
643
|
+
|
|
644
|
+
# Telephone order.
|
|
645
|
+
TELEPHONE_ORDER = :telephone_order
|
|
646
|
+
|
|
647
|
+
# Whitelist status check.
|
|
648
|
+
WHITELIST_STATUS_CHECK = :whitelist_status_check
|
|
649
|
+
|
|
650
|
+
# Other payment.
|
|
651
|
+
OTHER_PAYMENT = :other_payment
|
|
652
|
+
|
|
653
|
+
# Billing agreement.
|
|
654
|
+
BILLING_AGREEMENT = :billing_agreement
|
|
655
|
+
|
|
656
|
+
# Device binding status check.
|
|
657
|
+
DEVICE_BINDING_STATUS_CHECK = :device_binding_status_check
|
|
658
|
+
|
|
659
|
+
# Card security code status check.
|
|
660
|
+
CARD_SECURITY_CODE_STATUS_CHECK = :card_security_code_status_check
|
|
661
|
+
|
|
662
|
+
# Delayed shipment.
|
|
663
|
+
DELAYED_SHIPMENT = :delayed_shipment
|
|
664
|
+
|
|
665
|
+
# Split payment.
|
|
666
|
+
SPLIT_PAYMENT = :split_payment
|
|
667
|
+
|
|
668
|
+
# FIDO credential deletion.
|
|
669
|
+
FIDO_CREDENTIAL_DELETION = :fido_credential_deletion
|
|
670
|
+
|
|
671
|
+
# FIDO credential registration.
|
|
672
|
+
FIDO_CREDENTIAL_REGISTRATION = :fido_credential_registration
|
|
673
|
+
|
|
674
|
+
# Decoupled authentication fallback.
|
|
675
|
+
DECOUPLED_AUTHENTICATION_FALLBACK = :decoupled_authentication_fallback
|
|
676
|
+
|
|
677
|
+
# @!method self.values
|
|
678
|
+
# @return [Array<Symbol>]
|
|
679
|
+
end
|
|
680
|
+
end
|
|
681
|
+
end
|
|
682
|
+
|
|
683
|
+
# The 3DS requestor authentication indicator describes why the authentication
|
|
684
|
+
# attempt is performed, such as for a recurring transaction.
|
|
685
|
+
#
|
|
686
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication#requestor_authentication_indicator
|
|
687
|
+
module RequestorAuthenticationIndicator
|
|
688
|
+
extend Increase::Internal::Type::Enum
|
|
689
|
+
|
|
690
|
+
# The authentication is for a payment transaction.
|
|
691
|
+
PAYMENT_TRANSACTION = :payment_transaction
|
|
692
|
+
|
|
693
|
+
# The authentication is for a recurring transaction.
|
|
694
|
+
RECURRING_TRANSACTION = :recurring_transaction
|
|
695
|
+
|
|
696
|
+
# The authentication is for an installment transaction.
|
|
697
|
+
INSTALLMENT_TRANSACTION = :installment_transaction
|
|
698
|
+
|
|
699
|
+
# The authentication is for adding a card.
|
|
700
|
+
ADD_CARD = :add_card
|
|
701
|
+
|
|
702
|
+
# The authentication is for maintaining a card.
|
|
703
|
+
MAINTAIN_CARD = :maintain_card
|
|
704
|
+
|
|
705
|
+
# The authentication is for EMV token cardholder verification.
|
|
706
|
+
EMV_TOKEN_CARDHOLDER_VERIFICATION = :emv_token_cardholder_verification
|
|
707
|
+
|
|
708
|
+
# The authentication is for a billing agreement.
|
|
709
|
+
BILLING_AGREEMENT = :billing_agreement
|
|
710
|
+
|
|
711
|
+
# @!method self.values
|
|
712
|
+
# @return [Array<Symbol>]
|
|
713
|
+
end
|
|
714
|
+
|
|
715
|
+
# Indicates whether a challenge is requested for this transaction.
|
|
716
|
+
#
|
|
717
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication#requestor_challenge_indicator
|
|
718
|
+
module RequestorChallengeIndicator
|
|
719
|
+
extend Increase::Internal::Type::Enum
|
|
720
|
+
|
|
721
|
+
# No preference.
|
|
722
|
+
NO_PREFERENCE = :no_preference
|
|
723
|
+
|
|
724
|
+
# No challenge requested.
|
|
725
|
+
NO_CHALLENGE_REQUESTED = :no_challenge_requested
|
|
726
|
+
|
|
727
|
+
# Challenge requested, 3DS Requestor preference.
|
|
728
|
+
CHALLENGE_REQUESTED_3DS_REQUESTOR_PREFERENCE = :challenge_requested_3ds_requestor_preference
|
|
729
|
+
|
|
730
|
+
# Challenge requested, mandate.
|
|
731
|
+
CHALLENGE_REQUESTED_MANDATE = :challenge_requested_mandate
|
|
732
|
+
|
|
733
|
+
# No challenge requested, transactional risk analysis already performed.
|
|
734
|
+
NO_CHALLENGE_REQUESTED_TRANSACTIONAL_RISK_ANALYSIS_ALREADY_PERFORMED =
|
|
735
|
+
:no_challenge_requested_transactional_risk_analysis_already_performed
|
|
736
|
+
|
|
737
|
+
# No challenge requested, data share only.
|
|
738
|
+
NO_CHALLENGE_REQUESTED_DATA_SHARE_ONLY = :no_challenge_requested_data_share_only
|
|
739
|
+
|
|
740
|
+
# No challenge requested, strong consumer authentication already performed.
|
|
741
|
+
NO_CHALLENGE_REQUESTED_STRONG_CONSUMER_AUTHENTICATION_ALREADY_PERFORMED =
|
|
742
|
+
:no_challenge_requested_strong_consumer_authentication_already_performed
|
|
743
|
+
|
|
744
|
+
# No challenge requested, utilize whitelist exemption if no challenge required.
|
|
745
|
+
NO_CHALLENGE_REQUESTED_UTILIZE_WHITELIST_EXEMPTION_IF_NO_CHALLENGE_REQUIRED =
|
|
746
|
+
:no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required
|
|
747
|
+
|
|
748
|
+
# Challenge requested, whitelist prompt requested if challenge required.
|
|
749
|
+
CHALLENGE_REQUESTED_WHITELIST_PROMPT_REQUESTED_IF_CHALLENGE_REQUIRED =
|
|
750
|
+
:challenge_requested_whitelist_prompt_requested_if_challenge_required
|
|
751
|
+
|
|
752
|
+
# @!method self.values
|
|
753
|
+
# @return [Array<Symbol>]
|
|
754
|
+
end
|
|
755
|
+
|
|
756
|
+
# The type of transaction being authenticated.
|
|
757
|
+
#
|
|
758
|
+
# @see Increase::Models::RealTimeDecision::CardAuthentication#transaction_type
|
|
759
|
+
module TransactionType
|
|
760
|
+
extend Increase::Internal::Type::Enum
|
|
761
|
+
|
|
762
|
+
# Purchase of goods or services.
|
|
763
|
+
GOODS_SERVICE_PURCHASE = :goods_service_purchase
|
|
764
|
+
|
|
765
|
+
# Check acceptance.
|
|
766
|
+
CHECK_ACCEPTANCE = :check_acceptance
|
|
767
|
+
|
|
768
|
+
# Account funding.
|
|
769
|
+
ACCOUNT_FUNDING = :account_funding
|
|
770
|
+
|
|
771
|
+
# Quasi-cash transaction.
|
|
772
|
+
QUASI_CASH_TRANSACTION = :quasi_cash_transaction
|
|
773
|
+
|
|
774
|
+
# Prepaid activation and load.
|
|
775
|
+
PREPAID_ACTIVATION_AND_LOAD = :prepaid_activation_and_load
|
|
776
|
+
|
|
777
|
+
# @!method self.values
|
|
778
|
+
# @return [Array<Symbol>]
|
|
779
|
+
end
|
|
178
780
|
end
|
|
179
781
|
|
|
180
782
|
# @see Increase::Models::RealTimeDecision#card_authentication_challenge
|
|
@@ -1220,9 +1822,12 @@ module Increase
|
|
|
1220
1822
|
# Increase failed to process the authorization in a timely manner.
|
|
1221
1823
|
ISSUER_ERROR = :issuer_error
|
|
1222
1824
|
|
|
1223
|
-
# The physical card read had an invalid CVV
|
|
1825
|
+
# The physical card read had an invalid CVV or dCVV.
|
|
1224
1826
|
INVALID_PHYSICAL_CARD = :invalid_physical_card
|
|
1225
1827
|
|
|
1828
|
+
# The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.
|
|
1829
|
+
INVALID_CRYPTOGRAM = :invalid_cryptogram
|
|
1830
|
+
|
|
1226
1831
|
# The 3DS cardholder authentication verification value was invalid.
|
|
1227
1832
|
INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE =
|
|
1228
1833
|
:invalid_cardholder_authentication_verification_value
|
|
@@ -2496,9 +3101,12 @@ module Increase
|
|
|
2496
3101
|
# Increase failed to process the authorization in a timely manner.
|
|
2497
3102
|
ISSUER_ERROR = :issuer_error
|
|
2498
3103
|
|
|
2499
|
-
# The physical card read had an invalid CVV
|
|
3104
|
+
# The physical card read had an invalid CVV or dCVV.
|
|
2500
3105
|
INVALID_PHYSICAL_CARD = :invalid_physical_card
|
|
2501
3106
|
|
|
3107
|
+
# The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase.
|
|
3108
|
+
INVALID_CRYPTOGRAM = :invalid_cryptogram
|
|
3109
|
+
|
|
2502
3110
|
# The 3DS cardholder authentication verification value was invalid.
|
|
2503
3111
|
INVALID_CARDHOLDER_AUTHENTICATION_VERIFICATION_VALUE =
|
|
2504
3112
|
:invalid_cardholder_authentication_verification_value
|