Class: Lithic::Models::CardholderAuthentication

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/cardholder_authentication.rb

Defined Under Namespace

Modules: AuthenticationMethod, AuthenticationResult, DecisionMadeBy, LiabilityShift

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(authentication_method:, authentication_result:, decision_made_by:, liability_shift:, three_ds_authentication_token:) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::CardholderAuthentication for more details.

Parameters:




# File 'lib/lithic/models/cardholder_authentication.rb', line 48

Instance Attribute Details

#authentication_method ⇒ Symbol, Lithic::Models::CardholderAuthentication::AuthenticationMethod

Indicates the method used to authenticate the cardholder.

Returns:



10
 
# File 'lib/lithic/models/cardholder_authentication.rb', line 10

required :authentication_method, enum: -> { Lithic::CardholderAuthentication::AuthenticationMethod }

#authentication_result ⇒ Symbol, Lithic::Models::CardholderAuthentication::AuthenticationResult

Indicates the outcome of the 3DS authentication process.

Returns:



16
 
# File 'lib/lithic/models/cardholder_authentication.rb', line 16

required :authentication_result, enum: -> { Lithic::CardholderAuthentication::AuthenticationResult }

#decision_made_by ⇒ Symbol, Lithic::Models::CardholderAuthentication::DecisionMadeBy

Indicates which party made the 3DS authentication decision.

Returns:



22
 
# File 'lib/lithic/models/cardholder_authentication.rb', line 22

required :decision_made_by, enum: -> { Lithic::CardholderAuthentication::DecisionMadeBy }

#liability_shift ⇒ Symbol, Lithic::Models::CardholderAuthentication::LiabilityShift

Indicates whether chargeback liability shift applies to the transaction. Possible enum values:

  • ‘3DS_AUTHENTICATED`: The transaction was fully authenticated through a 3-D Secure flow, chargeback liability shift applies.

  • ‘NONE`: Chargeback liability shift has not shifted to the issuer, i.e. the merchant is liable.

  • ‘TOKEN_AUTHENTICATED`: The transaction was a tokenized payment with validated cryptography, possibly recurring. Chargeback liability shift to the issuer applies.

Returns:



37
 
# File 'lib/lithic/models/cardholder_authentication.rb', line 37

required :liability_shift, enum: -> { Lithic::CardholderAuthentication::LiabilityShift }

#three_ds_authentication_token ⇒ String?

Unique identifier you can use to match a given 3DS authentication (available via the three_ds_authentication.created event webhook) and the transaction. Note that in cases where liability shift does not occur, this token is matched to the transaction on a best-effort basis.

Returns:

  • (String, nil) 


46
 
# File 'lib/lithic/models/cardholder_authentication.rb', line 46

required :three_ds_authentication_token, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/cardholder_authentication.rb', line 72