Class: Increase::Models::RealTimeDecision::CardAuthentication

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/real_time_decision.rb

Overview

See Also:

Defined Under Namespace

Modules: Category, Decision, RequestorAuthenticationIndicator, RequestorChallengeIndicator, TransactionType Classes: DeviceChannel

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#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_amount_cardholder_estimated:, 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:) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::RealTimeDecision::CardAuthentication for more details.

Fields related to a 3DS authentication attempt.

Parameters:

  • access_control_server_transaction_id (String) —

    A unique identifier assigned by the Access Control Server (us) for this transact

  • account_id (String) —

    The identifier of the Account the card belongs to.

  • billing_address_city (String, nil) —

    The city of the cardholder billing address associated with the card used for thi

  • billing_address_country (String, nil) —

    The country of the cardholder billing address associated with the card used for

  • billing_address_line1 (String, nil) —

    The first line of the cardholder billing address associated with the card used f

  • billing_address_line2 (String, nil) —

    The second line of the cardholder billing address associated with the card used

  • billing_address_line3 (String, nil) —

    The third line of the cardholder billing address associated with the card used f

  • billing_address_postal_code (String, nil) —

    The postal code of the cardholder billing address associated with the card used

  • billing_address_state (String, nil) —

    The US state of the cardholder billing address associated with the card used for

  • card_id (String) —

    The identifier of the Card.

  • cardholder_email (String, nil) —

    The email address of the cardholder.

  • cardholder_name (String, nil) —

    The name of the cardholder.

  • category (Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Category, nil) —

    The category of the card authentication attempt.

  • decision (Symbol, Increase::Models::RealTimeDecision::CardAuthentication::Decision, nil) —

    Whether or not the authentication attempt was approved.

  • device_channel (Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel) —

    The device channel of the card authentication attempt.

  • directory_server_transaction_id (String) —

    A unique identifier assigned by the Directory Server (the card network) for this

  • merchant_acceptor_id (String, nil) —

    The merchant identifier (commonly abbreviated as MID) of the merchant the card i

  • merchant_category_code (String, nil) —

    The Merchant Category Code (commonly abbreviated as MCC) of the merchant the car

  • merchant_country (String, nil) —

    The country the merchant resides in.

  • merchant_name (String, nil) —

    The name of the merchant.

  • prior_card_authentication_id (String, nil) —

    The ID of a prior Card Authentication that the requestor used to authenticate th

  • purchase_amount (Integer, nil) —

    The purchase amount in minor units.

  • purchase_amount_cardholder_estimated (Integer, nil) —

    The purchase amount in the cardholder’s currency (i.e., USD) estimated using dai

  • purchase_currency (String, nil) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the authenticati

  • requestor_authentication_indicator (Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator, nil) —

    The 3DS requestor authentication indicator describes why the authentication atte

  • requestor_challenge_indicator (Symbol, Increase::Models::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator, nil) —

    Indicates whether a challenge is requested for this transaction.

  • requestor_name (String) —

    The name of the 3DS requestor.

  • requestor_url (String) —

    The URL of the 3DS requestor.

  • shipping_address_city (String, nil) —

    The city of the shipping address associated with this purchase.

  • shipping_address_country (String, nil) —

    The country of the shipping address associated with this purchase.

  • shipping_address_line1 (String, nil) —

    The first line of the shipping address associated with this purchase.

  • shipping_address_line2 (String, nil) —

    The second line of the shipping address associated with this purchase.

  • shipping_address_line3 (String, nil) —

    The third line of the shipping address associated with this purchase.

  • shipping_address_postal_code (String, nil) —

    The postal code of the shipping address associated with this purchase.

  • shipping_address_state (String, nil) —

    The US state of the shipping address associated with this purchase.

  • three_d_secure_server_transaction_id (String) —

    A unique identifier assigned by the 3DS Server initiating the authentication att

  • transaction_type (Symbol, Increase::Models::RealTimeDecision::CardAuthentication::TransactionType, nil) —

    The type of transaction being authenticated.

  • upcoming_card_payment_id (String) —

    The identifier of the Card Payment this authentication attempt will belong to. A




# File 'lib/increase/models/real_time_decision.rb', line 374

Instance Attribute Details

#access_control_server_transaction_id ⇒ String

A unique identifier assigned by the Access Control Server (us) for this transaction.

Returns:

  • (String) 


126
 
# File 'lib/increase/models/real_time_decision.rb', line 126

required :access_control_server_transaction_id, String

#account_id ⇒ String

The identifier of the Account the card belongs to.

Returns:

  • (String) 


132
 
# File 'lib/increase/models/real_time_decision.rb', line 132

required :account_id, String

#billing_address_city ⇒ String?

The city of the cardholder billing address associated with the card used for this purchase.

Returns:

  • (String, nil) 


139
 
# File 'lib/increase/models/real_time_decision.rb', line 139

required :billing_address_city, String, nil?: true

#billing_address_country ⇒ String?

The country of the cardholder billing address associated with the card used for this purchase.

Returns:

  • (String, nil) 


146
 
# File 'lib/increase/models/real_time_decision.rb', line 146

required :billing_address_country, String, nil?: true

#billing_address_line1 ⇒ String?

The first line of the cardholder billing address associated with the card used for this purchase.

Returns:

  • (String, nil) 


153
 
# File 'lib/increase/models/real_time_decision.rb', line 153

required :billing_address_line1, String, nil?: true

#billing_address_line2 ⇒ String?

The second line of the cardholder billing address associated with the card used for this purchase.

Returns:

  • (String, nil) 


160
 
# File 'lib/increase/models/real_time_decision.rb', line 160

required :billing_address_line2, String, nil?: true

#billing_address_line3 ⇒ String?

The third line of the cardholder billing address associated with the card used for this purchase.

Returns:

  • (String, nil) 


167
 
# File 'lib/increase/models/real_time_decision.rb', line 167

required :billing_address_line3, String, nil?: true

#billing_address_postal_code ⇒ String?

The postal code of the cardholder billing address associated with the card used for this purchase.

Returns:

  • (String, nil) 


174
 
# File 'lib/increase/models/real_time_decision.rb', line 174

required :billing_address_postal_code, String, nil?: true

#billing_address_state ⇒ String?

The US state of the cardholder billing address associated with the card used for this purchase.

Returns:

  • (String, nil) 


181
 
# File 'lib/increase/models/real_time_decision.rb', line 181

required :billing_address_state, String, nil?: true

#card_id ⇒ String

The identifier of the Card.

Returns:

  • (String) 


187
 
# File 'lib/increase/models/real_time_decision.rb', line 187

required :card_id, String

#cardholder_email ⇒ String?

The email address of the cardholder.

Returns:

  • (String, nil) 


193
 
# File 'lib/increase/models/real_time_decision.rb', line 193

required :cardholder_email, String, nil?: true

#cardholder_name ⇒ String?

The name of the cardholder.

Returns:

  • (String, nil) 


199
 
# File 'lib/increase/models/real_time_decision.rb', line 199

required :cardholder_name, String, nil?: true

#category ⇒ Symbol, ...

The category of the card authentication attempt.

Returns:



205
 
# File 'lib/increase/models/real_time_decision.rb', line 205

required :category, enum: -> { Increase::RealTimeDecision::CardAuthentication::Category }, nil?: true

#decision ⇒ Symbol, ...

Whether or not the authentication attempt was approved.

Returns:



211
 
# File 'lib/increase/models/real_time_decision.rb', line 211

required :decision, enum: -> { Increase::RealTimeDecision::CardAuthentication::Decision }, nil?: true

#device_channel ⇒ Increase::Models::RealTimeDecision::CardAuthentication::DeviceChannel

The device channel of the card authentication attempt.

Returns:



217
 
# File 'lib/increase/models/real_time_decision.rb', line 217

required :device_channel, -> { Increase::RealTimeDecision::CardAuthentication::DeviceChannel }

#directory_server_transaction_id ⇒ String

A unique identifier assigned by the Directory Server (the card network) for this transaction.

Returns:

  • (String) 


224
 
# File 'lib/increase/models/real_time_decision.rb', line 224

required :directory_server_transaction_id, String

#merchant_acceptor_id ⇒ String?

The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.

Returns:

  • (String, nil) 


231
 
# File 'lib/increase/models/real_time_decision.rb', line 231

required :merchant_acceptor_id, String, nil?: true

#merchant_category_code ⇒ String?

The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.

Returns:

  • (String, nil) 


238
 
# File 'lib/increase/models/real_time_decision.rb', line 238

required :merchant_category_code, String, nil?: true

#merchant_country ⇒ String?

The country the merchant resides in.

Returns:

  • (String, nil) 


244
 
# File 'lib/increase/models/real_time_decision.rb', line 244

required :merchant_country, String, nil?: true

#merchant_name ⇒ String?

The name of the merchant.

Returns:

  • (String, nil) 


250
 
# File 'lib/increase/models/real_time_decision.rb', line 250

required :merchant_name, String, nil?: true

#prior_card_authentication_id ⇒ String?

The ID of a prior Card Authentication that the requestor used to authenticate this cardholder for a previous transaction.

Returns:

  • (String, nil) 


257
 
# File 'lib/increase/models/real_time_decision.rb', line 257

required :prior_card_authentication_id, String, nil?: true

#purchase_amount ⇒ Integer?

The purchase amount in minor units.

Returns:

  • (Integer, nil) 


263
 
# File 'lib/increase/models/real_time_decision.rb', line 263

required :purchase_amount, Integer, nil?: true

#purchase_amount_cardholder_estimated ⇒ Integer?

The purchase amount in the cardholder’s currency (i.e., USD) estimated using daily conversion rates from the card network.

Returns:

  • (Integer, nil) 


270
 
# File 'lib/increase/models/real_time_decision.rb', line 270

required :purchase_amount_cardholder_estimated, Integer, nil?: true

#purchase_currency ⇒ String?

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the authentication attempt’s purchase currency.

Returns:

  • (String, nil) 


277
 
# File 'lib/increase/models/real_time_decision.rb', line 277

required :purchase_currency, String, nil?: true

#requestor_authentication_indicator ⇒ Symbol, ...

The 3DS requestor authentication indicator describes why the authentication attempt is performed, such as for a recurring transaction.

Returns:



284
285
286
287
288
 
# File 'lib/increase/models/real_time_decision.rb', line 284

required :requestor_authentication_indicator,
enum: -> {
  Increase::RealTimeDecision::CardAuthentication::RequestorAuthenticationIndicator
},
nil?: true

#requestor_challenge_indicator ⇒ Symbol, ...

Indicates whether a challenge is requested for this transaction.

Returns:



294
295
296
 
# File 'lib/increase/models/real_time_decision.rb', line 294

required :requestor_challenge_indicator,
enum: -> { Increase::RealTimeDecision::CardAuthentication::RequestorChallengeIndicator },
nil?: true

#requestor_name ⇒ String

The name of the 3DS requestor.

Returns:

  • (String) 


302
 
# File 'lib/increase/models/real_time_decision.rb', line 302

required :requestor_name, String

#requestor_url ⇒ String

The URL of the 3DS requestor.

Returns:

  • (String) 


308
 
# File 'lib/increase/models/real_time_decision.rb', line 308

required :requestor_url, String

#shipping_address_city ⇒ String?

The city of the shipping address associated with this purchase.

Returns:

  • (String, nil) 


314
 
# File 'lib/increase/models/real_time_decision.rb', line 314

required :shipping_address_city, String, nil?: true

#shipping_address_country ⇒ String?

The country of the shipping address associated with this purchase.

Returns:

  • (String, nil) 


320
 
# File 'lib/increase/models/real_time_decision.rb', line 320

required :shipping_address_country, String, nil?: true

#shipping_address_line1 ⇒ String?

The first line of the shipping address associated with this purchase.

Returns:

  • (String, nil) 


326
 
# File 'lib/increase/models/real_time_decision.rb', line 326

required :shipping_address_line1, String, nil?: true

#shipping_address_line2 ⇒ String?

The second line of the shipping address associated with this purchase.

Returns:

  • (String, nil) 


332
 
# File 'lib/increase/models/real_time_decision.rb', line 332

required :shipping_address_line2, String, nil?: true

#shipping_address_line3 ⇒ String?

The third line of the shipping address associated with this purchase.

Returns:

  • (String, nil) 


338
 
# File 'lib/increase/models/real_time_decision.rb', line 338

required :shipping_address_line3, String, nil?: true

#shipping_address_postal_code ⇒ String?

The postal code of the shipping address associated with this purchase.

Returns:

  • (String, nil) 


344
 
# File 'lib/increase/models/real_time_decision.rb', line 344

required :shipping_address_postal_code, String, nil?: true

#shipping_address_state ⇒ String?

The US state of the shipping address associated with this purchase.

Returns:

  • (String, nil) 


350
 
# File 'lib/increase/models/real_time_decision.rb', line 350

required :shipping_address_state, String, nil?: true

#three_d_secure_server_transaction_id ⇒ String

A unique identifier assigned by the 3DS Server initiating the authentication attempt for this transaction.

Returns:

  • (String) 


357
 
# File 'lib/increase/models/real_time_decision.rb', line 357

required :three_d_secure_server_transaction_id, String

#transaction_type ⇒ Symbol, ...

The type of transaction being authenticated.

Returns:



363
364
365
 
# File 'lib/increase/models/real_time_decision.rb', line 363

required :transaction_type,
enum: -> { Increase::RealTimeDecision::CardAuthentication::TransactionType },
nil?: true

#upcoming_card_payment_id ⇒ String

The identifier of the Card Payment this authentication attempt will belong to. Available in the API once the card authentication has completed.

Returns:

  • (String) 


372
 
# File 'lib/increase/models/real_time_decision.rb', line 372

required :upcoming_card_payment_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/real_time_decision.rb', line 468