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, RequestorAuthenticationIndicator, RequestorChallengeIndicator, Status, TransactionType, Type Classes: Challenge, 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(id:, access_control_server_transaction_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:, card_payment_id:, cardholder_email:, cardholder_name:, category:, challenge:, created_at:, deny_reason:, device_channel:, directory_server_transaction_id:, merchant_acceptor_id:, merchant_category_code:, merchant_country:, merchant_name:, prior_authenticated_card_payment_id:, purchase_amount:, purchase_amount_cardholder_estimated:, purchase_currency:, real_time_decision_id:, 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:, status:, three_d_secure_server_transaction_id:, transaction_type:, 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:

  • id (String) —

    The Card Authentication identifier.

  • access_control_server_transaction_id (String) —

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

  • 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.

  • card_payment_id (String) —

    The ID of the Card Payment this transaction belongs to.

  • cardholder_email (String, nil) —

    The email address of the cardholder.

  • cardholder_name (String, nil) —

    The name of the cardholder.

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

    The category of the card authentication attempt.

  • challenge (Increase::Models::CardPayment::Element::CardAuthentication::Challenge, nil) —

    Details about the challenge, if one was requested.

  • created_at (Time) —

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

  • deny_reason (Symbol, Increase::Models::CardPayment::Element::CardAuthentication::DenyReason, nil) —

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

  • device_channel (Increase::Models::CardPayment::Element::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_authenticated_card_payment_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

  • real_time_decision_id (String, nil) —

    The identifier of the Real-Time Decision sent to approve or decline this authent

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

    The 3DS requestor authentication indicator describes why the authentication atte

  • requestor_challenge_indicator (Symbol, Increase::Models::CardPayment::Element::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.

  • status (Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Status) —

    The status of the card authentication.

  • three_d_secure_server_transaction_id (String) —

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

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

    The type of transaction being authenticated.

  • type (Symbol, Increase::Models::CardPayment::Element::CardAuthentication::Type) —

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




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

Instance Attribute Details

#access_control_server_transaction_id ⇒ String

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

Returns:

  • (String) 


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

required :access_control_server_transaction_id, String

#billing_address_city ⇒ String?

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

Returns:

  • (String, nil) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

required :billing_address_state, String, nil?: true

#card_id ⇒ String

The identifier of the Card.

Returns:

  • (String) 


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

required :card_id, String

#card_payment_id ⇒ String

The ID of the Card Payment this transaction belongs to.

Returns:

  • (String) 


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

required :card_payment_id, String

#cardholder_email ⇒ String?

The email address of the cardholder.

Returns:

  • (String, nil) 


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

required :cardholder_email, String, nil?: true

#cardholder_name ⇒ String?

The name of the cardholder.

Returns:

  • (String, nil) 


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

required :cardholder_name, String, nil?: true

#category ⇒ Symbol, ...

The category of the card authentication attempt.

Returns:



405
406
407
408
409
 
# File 'lib/increase/models/card_payment.rb', line 405

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:



415
416
417
418
419
 
# File 'lib/increase/models/card_payment.rb', line 415

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) 


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

required :created_at, Time

#deny_reason ⇒ Symbol, ...

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

Returns:



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

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

#device_channel ⇒ Increase::Models::CardPayment::Element::CardAuthentication::DeviceChannel

The device channel of the card authentication attempt.

Returns:



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

required :device_channel, -> { Increase::CardPayment::Element::CardAuthentication::DeviceChannel }

#directory_server_transaction_id ⇒ String

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

Returns:

  • (String) 


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

required :directory_server_transaction_id, String

#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, nil) 


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

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) 


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

required :merchant_category_code, String, nil?: true

#merchant_country ⇒ String?

The country the merchant resides in.

Returns:

  • (String, nil) 


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

required :merchant_country, String, nil?: true

#merchant_name ⇒ String?

The name of the merchant.

Returns:

  • (String, nil) 


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

required :merchant_name, String, nil?: true

#prior_authenticated_card_payment_id ⇒ String?

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

Returns:

  • (String, nil) 


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

required :prior_authenticated_card_payment_id, String, nil?: true

#purchase_amount ⇒ Integer?

The purchase amount in minor units.

Returns:

  • (Integer, nil) 


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

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) 


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

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) 


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

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) 


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

required :real_time_decision_id, 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:



514
515
516
517
518
 
# File 'lib/increase/models/card_payment.rb', line 514

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

#requestor_challenge_indicator ⇒ Symbol, ...

Indicates whether a challenge is requested for this transaction.

Returns:



524
525
526
527
528
 
# File 'lib/increase/models/card_payment.rb', line 524

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

#requestor_name ⇒ String

The name of the 3DS requestor.

Returns:

  • (String) 


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

required :requestor_name, String

#requestor_url ⇒ String

The URL of the 3DS requestor.

Returns:

  • (String) 


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

required :requestor_url, String

#shipping_address_city ⇒ String?

The city of the shipping address associated with this purchase.

Returns:

  • (String, nil) 


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

required :shipping_address_city, String, nil?: true

#shipping_address_country ⇒ String?

The country of the shipping address associated with this purchase.

Returns:

  • (String, nil) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

required :shipping_address_state, String, nil?: true

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

The status of the card authentication.

Returns:



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

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

#three_d_secure_server_transaction_id ⇒ String

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

Returns:

  • (String) 


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

required :three_d_secure_server_transaction_id, String

#transaction_type ⇒ Symbol, ...

The type of transaction being authenticated.

Returns:



601
602
603
 
# File 'lib/increase/models/card_payment.rb', line 601

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

#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:



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

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 718