Class: Lithic::Models::FinancialAccountBalance

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

Defined Under Namespace

Modules: Type

Instance Attribute 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:, available_amount:, created:, currency:, last_transaction_event_token:, last_transaction_token:, pending_amount:, total_amount:, type:, updated:) ⇒ Object

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

Balance of a Financial Account

Parameters:

  • token (String) —

    Globally unique identifier for the financial account that holds this balance.

  • available_amount (Integer) —

    Funds available for spend in the currency’s smallest unit (e.g., cents for USD)

  • created (Time) —

    Date and time for when the balance was first created.

  • currency (String) —

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

  • last_transaction_event_token (String) —

    Globally unique identifier for the last financial transaction event that impacte

  • last_transaction_token (String) —

    Globally unique identifier for the last financial transaction that impacted this

  • pending_amount (Integer) —

    Funds not available for spend due to card authorizations or pending ACH release.

  • total_amount (Integer) —

    The sum of available and pending balance in the currency’s smallest unit (e.g.,

  • type (Symbol, Lithic::Models::FinancialAccountBalance::Type) —

    Type of financial account.

  • updated (Time) —

    Date and time for when the balance was last updated.




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

Instance Attribute Details

#available_amount ⇒ Integer

Funds available for spend in the currency’s smallest unit (e.g., cents for USD)

Returns:

  • (Integer) 


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

required :available_amount, Integer

#created ⇒ Time

Date and time for when the balance was first created.

Returns:

  • (Time) 


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

required :created, Time

#currency ⇒ String

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

Returns:

  • (String) 


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

required :currency, String

#last_transaction_event_token ⇒ String

Globally unique identifier for the last financial transaction event that impacted this balance.

Returns:

  • (String) 


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

required :last_transaction_event_token, String

#last_transaction_token ⇒ String

Globally unique identifier for the last financial transaction that impacted this balance.

Returns:

  • (String) 


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

required :last_transaction_token, String

#pending_amount ⇒ Integer

Funds not available for spend due to card authorizations or pending ACH release. Shown in the currency’s smallest unit (e.g., cents for USD).

Returns:

  • (Integer) 


49
 
# File 'lib/lithic/models/financial_account_balance.rb', line 49

required :pending_amount, Integer

#token ⇒ String

Globally unique identifier for the financial account that holds this balance.

Returns:

  • (String) 


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

required :token, String

#total_amount ⇒ Integer

The sum of available and pending balance in the currency’s smallest unit (e.g., cents for USD).

Returns:

  • (Integer) 


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

required :total_amount, Integer

#type ⇒ Symbol, Lithic::Models::FinancialAccountBalance::Type

Type of financial account.

Returns:



62
 
# File 'lib/lithic/models/financial_account_balance.rb', line 62

required :type, enum: -> { Lithic::FinancialAccountBalance::Type }

#updated ⇒ Time

Date and time for when the balance was last updated.

Returns:

  • (Time) 


68
 
# File 'lib/lithic/models/financial_account_balance.rb', line 68

required :updated, Time