Class: Lithic::Models::Transaction

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

Overview

See Also:

Defined Under Namespace

Modules: Network, Result, Status Classes: Amounts, Avs, Event, Pos

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(address:, zipcode:) ⇒ Object

Parameters:

  • address (String) —

    Cardholder address

  • zipcode (String) —

    Cardholder ZIP code




# File 'lib/lithic/models/transaction.rb', line 181

Instance Attribute Details

#account_token ⇒ String

The token for the account associated with this transaction.

Returns:

  • (String) 


17
 
# File 'lib/lithic/models/transaction.rb', line 17

required :account_token, String

#acquirer_fee ⇒ Integer?

Fee assessed by the merchant and paid for by the cardholder in the smallest unit of the currency. Will be zero if no fee is assessed. Rebates may be transmitted as a negative value to indicate credited fees.

Returns:

  • (Integer, nil) 


25
 
# File 'lib/lithic/models/transaction.rb', line 25

required :acquirer_fee, Integer, nil?: true

#acquirer_reference_number ⇒ String?

Deprecated.

Unique identifier assigned to a transaction by the acquirer that can be used in dispute and chargeback filing. This field has been deprecated in favor of the ‘acquirer_reference_number` that resides in the event-level `network_info`.

Returns:

  • (String, nil) 


35
 
# File 'lib/lithic/models/transaction.rb', line 35

required :acquirer_reference_number, String, nil?: true

#amount ⇒ Integer

Deprecated.

When the transaction is pending, this represents the authorization amount of the transaction in the anticipated settlement currency. Once the transaction has settled, this field represents the settled amount in the settlement currency.

Returns:

  • (Integer) 


45
 
# File 'lib/lithic/models/transaction.rb', line 45

required :amount, Integer

#amounts ⇒ Lithic::Models::Transaction::Amounts

Returns:



50
 
# File 'lib/lithic/models/transaction.rb', line 50

required :amounts, -> { Lithic::Transaction::Amounts }

#authorization_amount ⇒ Integer?

Deprecated.

The authorization amount of the transaction in the anticipated settlement currency.

Returns:

  • (Integer, nil) 


59
 
# File 'lib/lithic/models/transaction.rb', line 59

required :authorization_amount, Integer, nil?: true

#authorization_code ⇒ String?

A fixed-width 6-digit numeric identifier that can be used to identify a transaction with networks.

Returns:

  • (String, nil) 


66
 
# File 'lib/lithic/models/transaction.rb', line 66

required :authorization_code, String, nil?: true

#avs ⇒ Lithic::Models::Transaction::Avs?

Returns:



71
 
# File 'lib/lithic/models/transaction.rb', line 71

required :avs, -> { Lithic::Transaction::Avs }, nil?: true

#card_token ⇒ String

Token for the card used in this transaction.

Returns:

  • (String) 


77
 
# File 'lib/lithic/models/transaction.rb', line 77

required :card_token, String

#cardholder_authentication ⇒ Lithic::Models::CardholderAuthentication?

Returns:



82
 
# File 'lib/lithic/models/transaction.rb', line 82

required :cardholder_authentication, -> { Lithic::CardholderAuthentication }, nil?: true

#created ⇒ Time

Date and time when the transaction first occurred. UTC time zone.

Returns:

  • (Time) 


88
 
# File 'lib/lithic/models/transaction.rb', line 88

required :created, Time

#events ⇒ Array<Lithic::Models::Transaction::Event>?

Returns:



179
 
# File 'lib/lithic/models/transaction.rb', line 179

optional :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::Transaction::Event] }

#financial_account_token ⇒ String?

Returns:

  • (String, nil) 


93
 
# File 'lib/lithic/models/transaction.rb', line 93

required :financial_account_token, String, nil?: true

#merchant ⇒ Lithic::Models::Merchant

Returns:



98
 
# File 'lib/lithic/models/transaction.rb', line 98

required :merchant, -> { Lithic::Merchant }

#merchant_amount ⇒ Integer?

Deprecated.

Analogous to the ‘amount’, but in the merchant currency.

Returns:

  • (Integer, nil) 


106
 
# File 'lib/lithic/models/transaction.rb', line 106

required :merchant_amount, Integer, nil?: true

#merchant_authorization_amount ⇒ Integer?

Deprecated.

Analogous to the ‘authorization_amount’, but in the merchant currency.

Returns:

  • (Integer, nil) 


114
 
# File 'lib/lithic/models/transaction.rb', line 114

required :merchant_authorization_amount, Integer, nil?: true

#merchant_currency ⇒ String

Deprecated.

3-character alphabetic ISO 4217 code for the local currency of the transaction.

Returns:

  • (String) 


122
 
# File 'lib/lithic/models/transaction.rb', line 122

required :merchant_currency, String

#network ⇒ Symbol, ...

Card network of the authorization. Value is ‘UNKNOWN` when Lithic cannot determine the network code from the upstream provider.

Returns:



129
 
# File 'lib/lithic/models/transaction.rb', line 129

required :network, enum: -> { Lithic::Transaction::Network }, nil?: true

#network_risk_score ⇒ Integer?

Network-provided score assessing risk level associated with a given authorization. Scores are on a range of 0-999, with 0 representing the lowest risk and 999 representing the highest risk. For Visa transactions, where the raw score has a range of 0-99, Lithic will normalize the score by multiplying the raw score by 10x.

Returns:

  • (Integer, nil) 


139
 
# File 'lib/lithic/models/transaction.rb', line 139

required :network_risk_score, Integer, nil?: true

#pos ⇒ Lithic::Models::Transaction::Pos

Returns:



144
 
# File 'lib/lithic/models/transaction.rb', line 144

required :pos, -> { Lithic::Transaction::Pos }

#result ⇒ Symbol, Lithic::Models::Transaction::Result

Returns:



149
 
# File 'lib/lithic/models/transaction.rb', line 149

required :result, enum: -> { Lithic::Transaction::Result }

#settled_amount ⇒ Integer

Deprecated.

The settled amount of the transaction in the settlement currency.

Returns:

  • (Integer) 


157
 
# File 'lib/lithic/models/transaction.rb', line 157

required :settled_amount, Integer

#status ⇒ Symbol, Lithic::Models::Transaction::Status

Status of the transaction.

Returns:



163
 
# File 'lib/lithic/models/transaction.rb', line 163

required :status, enum: -> { Lithic::Transaction::Status }

#token ⇒ String

Globally unique identifier.

Returns:

  • (String) 


11
 
# File 'lib/lithic/models/transaction.rb', line 11

required :token, String

#token_info ⇒ Lithic::Models::TokenInfo?

Returns:



168
 
# File 'lib/lithic/models/transaction.rb', line 168

required :token_info, -> { Lithic::TokenInfo }, nil?: true

#updated ⇒ Time

Date and time when the transaction last updated. UTC time zone.

Returns:

  • (Time) 


174
 
# File 'lib/lithic/models/transaction.rb', line 174

required :updated, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/transaction.rb', line 393