Class: Lithic::Models::FinancialTransaction

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

Defined Under Namespace

Modules: Category, Result, Status

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(token:, category:, created:, currency:, descriptor:, events:, pending_amount:, result:, settled_amount:, status:, updated:) ⇒ Object

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

Parameters:

  • token (String) —

    Globally unique identifier.

  • category (Symbol, Lithic::Models::FinancialTransaction::Category) —

    Status types:

  • created (Time) —

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

  • currency (String) —

    3-character alphabetic ISO 4217 code for the settling currency of the transactio

  • descriptor (String) —

    A string that provides a description of the financial transaction; may be useful

  • events (Array<Lithic::Models::FinancialEvent>) —

    A list of all financial events that have modified this financial transaction.

  • pending_amount (Integer) —

    Pending amount of the transaction in the currency’s smallest unit (e.g., cents),

  • result (Symbol, Lithic::Models::FinancialTransaction::Result) —

    APPROVED transactions were successful while DECLINED transactions were declined

  • settled_amount (Integer) —

    Amount of the transaction that has been settled in the currency’s smallest unit

  • status (Symbol, Lithic::Models::FinancialTransaction::Status) —

    Status types:

  • updated (Time) —

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




# File 'lib/lithic/models/financial_transaction.rb', line 92

Instance Attribute Details

#category ⇒ Symbol, Lithic::Models::FinancialTransaction::Category

Status types:

  • ‘CARD` - Issuing card transaction.

  • ‘ACH` - Transaction over ACH.

  • ‘INTERNAL` - Transaction for internal adjustment.

  • ‘TRANSFER` - Internal transfer of funds between financial accounts in your program.

Returns:



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

required :category, enum: -> { Lithic::FinancialTransaction::Category }

#created ⇒ Time

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

Returns:

  • (Time) 


28
 
# File 'lib/lithic/models/financial_transaction.rb', line 28

required :created, Time

#currency ⇒ String

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

Returns:

  • (String) 


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

required :currency, String

#descriptor ⇒ String

A string that provides a description of the financial transaction; may be useful to display to users.

Returns:

  • (String) 


42
 
# File 'lib/lithic/models/financial_transaction.rb', line 42

required :descriptor, String

#events ⇒ Array<Lithic::Models::FinancialEvent>

A list of all financial events that have modified this financial transaction.

Returns:



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

required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent] }

#pending_amount ⇒ Integer

Pending amount of the transaction in the currency’s smallest unit (e.g., cents), including any acquirer fees. The value of this field will go to zero over time once the financial transaction is settled.

Returns:

  • (Integer) 


56
 
# File 'lib/lithic/models/financial_transaction.rb', line 56

required :pending_amount, Integer

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

APPROVED transactions were successful while DECLINED transactions were declined by user, Lithic, or the network.

Returns:



63
 
# File 'lib/lithic/models/financial_transaction.rb', line 63

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

#settled_amount ⇒ Integer

Amount of the transaction that has been settled in the currency’s smallest unit (e.g., cents), including any acquirer fees. This may change over time.

Returns:

  • (Integer) 


70
 
# File 'lib/lithic/models/financial_transaction.rb', line 70

required :settled_amount, Integer

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

Status types:

  • ‘DECLINED` - The transaction was declined.

  • ‘EXPIRED` - The authorization as it has passed its expiration time. Card transaction only.

  • ‘PENDING` - The transaction is expected to settle.

  • ‘RETURNED` - The transaction has been returned.

  • ‘SETTLED` - The transaction is completed.

  • ‘VOIDED` - The transaction was voided. Card transaction only.

Returns:



84
 
# File 'lib/lithic/models/financial_transaction.rb', line 84

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

#token ⇒ String

Globally unique identifier.

Returns:

  • (String) 


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

required :token, String

#updated ⇒ Time

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

Returns:

  • (Time) 


90
 
# File 'lib/lithic/models/financial_transaction.rb', line 90

required :updated, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/financial_transaction.rb', line 135