Class: Increase::Models::CardPayment::Element::CardAuthentication

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

Overview

See Also:

Defined Under Namespace

Modules: Category, DenyReason, DeviceChannel, Status, Type Classes: Challenge

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(id:, card_id:, card_payment_id:, cardholder_email:, cardholder_name:, category:, challenge:, created_at:, deny_reason:, device_channel:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, purchase_amount:, purchase_currency:, real_time_decision_id:, status:, type:) ⇒ Object

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

A Card Authentication object. This field will be present in the JSON response if and only if ‘category` is equal to `card_authentication`. Card Authentications are attempts to authenticate a transaction or a card with 3DS.

Parameters:




# File 'lib/increase/models/card_payment.rb', line 447

Instance Attribute Details

#card_id ⇒ String

The identifier of the Card.

Returns:

  • (String) 


325
 
# File 'lib/increase/models/card_payment.rb', line 325

required :card_id, String

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Returns:

  • (String) 


331
 
# File 'lib/increase/models/card_payment.rb', line 331

required :card_payment_id, String

#cardholder_email ⇒ String?

The email address of the cardholder.

Returns:

  • (String, nil) 


337
 
# File 'lib/increase/models/card_payment.rb', line 337

required :cardholder_email, String, nil?: true

#cardholder_name ⇒ String?

The name of the cardholder.

Returns:

  • (String, nil) 


343
 
# File 'lib/increase/models/card_payment.rb', line 343

required :cardholder_name, String, nil?: true

#category ⇒ Symbol, ...

The category of the card authentication attempt.

Returns:



349
350
351
352
353
 
# File 'lib/increase/models/card_payment.rb', line 349

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

#challenge ⇒ Increase::Models::CardPayment::Element::CardAuthentication::Challenge?

Details about the challenge, if one was requested.

Returns:



359
360
361
362
363
 
# File 'lib/increase/models/card_payment.rb', line 359

required :challenge,
-> {
  Increase::CardPayment::Element::CardAuthentication::Challenge
},
nil?: true

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Card Authentication was attempted.

Returns:

  • (Time) 


370
 
# File 'lib/increase/models/card_payment.rb', line 370

required :created_at, Time

#deny_reason ⇒ Symbol, ...

The reason why this authentication attempt was denied, if it was.

Returns:



376
377
378
 
# File 'lib/increase/models/card_payment.rb', line 376

required :deny_reason,
enum: -> { Increase::CardPayment::Element::CardAuthentication::DenyReason },
nil?: true

#device_channel ⇒ Symbol, ...

The device channel of the card authentication attempt.

Returns:



384
385
386
 
# File 'lib/increase/models/card_payment.rb', line 384

required :device_channel,
enum: -> { Increase::CardPayment::Element::CardAuthentication::DeviceChannel },
nil?: true

#id ⇒ String

The Card Authentication identifier.

Returns:

  • (String) 


319
 
# File 'lib/increase/models/card_payment.rb', line 319

required :id, String

#merchant_acceptor_id ⇒ String

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

Returns:

  • (String) 


393
 
# File 'lib/increase/models/card_payment.rb', line 393

required :merchant_acceptor_id, String

#merchant_category_code ⇒ String

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

Returns:

  • (String) 


400
 
# File 'lib/increase/models/card_payment.rb', line 400

required :merchant_category_code, String

#merchant_country ⇒ String

The country the merchant resides in.

Returns:

  • (String) 


406
 
# File 'lib/increase/models/card_payment.rb', line 406

required :merchant_country, String

#merchant_name ⇒ String

The name of the merchant.

Returns:

  • (String) 


412
 
# File 'lib/increase/models/card_payment.rb', line 412

required :merchant_name, String

#purchase_amount ⇒ Integer?

The purchase amount in minor units.

Returns:

  • (Integer, nil) 


418
 
# File 'lib/increase/models/card_payment.rb', line 418

required :purchase_amount, 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) 


425
 
# File 'lib/increase/models/card_payment.rb', line 425

required :purchase_currency, String, nil?: true

#real_time_decision_id ⇒ String?

The identifier of the Real-Time Decision sent to approve or decline this authentication attempt.

Returns:

  • (String, nil) 


432
 
# File 'lib/increase/models/card_payment.rb', line 432

required :real_time_decision_id, String, nil?: true

#status ⇒ Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Status

The status of the card authentication.

Returns:



438
 
# File 'lib/increase/models/card_payment.rb', line 438

required :status, enum: -> { Increase::CardPayment::Element::CardAuthentication::Status }

#type ⇒ Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type

A constant representing the object’s type. For this resource it will always be ‘card_authentication`.

Returns:



445
 
# File 'lib/increase/models/card_payment.rb', line 445

required :type, enum: -> { Increase::CardPayment::Element::CardAuthentication::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/card_payment.rb', line 505