Class: Lithic::Models::Transfer

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

Overview

See Also:

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

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

Parameters:

  • token (String) (defaults to: nil) —

    Globally unique identifier for the transfer event.

  • category (Symbol, Lithic::Models::Transfer::Category) (defaults to: nil) —

    Status types:

  • created (Time) (defaults to: nil) —

    Date and time when the transfer occurred. UTC time zone.

  • currency (String) (defaults to: nil) —

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

  • descriptor (String) (defaults to: nil) —

    A string that provides a description of the transfer; may be useful to display t

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

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

  • from_balance (Array<Lithic::Models::Balance>) (defaults to: nil) —

    The updated balance of the sending financial account.

  • pending_amount (Integer) (defaults to: nil) —

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

  • result (Symbol, Lithic::Models::Transfer::Result) (defaults to: nil) —

    APPROVED transactions were successful while DECLINED transactions were declined

  • settled_amount (Integer) (defaults to: nil) —

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

  • status (Symbol, Lithic::Models::Transfer::Status) (defaults to: nil) —

    Status types:

  • to_balance (Array<Lithic::Models::Balance>) (defaults to: nil) —

    The updated balance of the receiving financial account.

  • updated (Time) (defaults to: nil) —

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




# File 'lib/lithic/models/transfer.rb', line 100

Instance Attribute Details

#category ⇒ Symbol, ...

Status types:

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

Returns:



20
 
# File 'lib/lithic/models/transfer.rb', line 20

optional :category, enum: -> { Lithic::Transfer::Category }

#created ⇒ Time?

Date and time when the transfer occurred. UTC time zone.

Returns:

  • (Time, nil) 


26
 
# File 'lib/lithic/models/transfer.rb', line 26

optional :created, Time

#currency ⇒ String?

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

Returns:

  • (String, nil) 


33
 
# File 'lib/lithic/models/transfer.rb', line 33

optional :currency, String

#descriptor ⇒ String?

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

Returns:

  • (String, nil) 


40
 
# File 'lib/lithic/models/transfer.rb', line 40

optional :descriptor, String

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

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

Returns:



46
 
# File 'lib/lithic/models/transfer.rb', line 46

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

#from_balance ⇒ Array<Lithic::Models::Balance>?

The updated balance of the sending financial account.

Returns:



52
 
# File 'lib/lithic/models/transfer.rb', line 52

optional :from_balance, -> { Lithic::Internal::Type::ArrayOf[Lithic::Balance] }

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


60
 
# File 'lib/lithic/models/transfer.rb', line 60

optional :pending_amount, Integer

#result ⇒ Symbol, ...

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

Returns:



67
 
# File 'lib/lithic/models/transfer.rb', line 67

optional :result, enum: -> { Lithic::Transfer::Result }

#settled_amount ⇒ Integer?

Amount of the transaction that has been settled in the currency’s smallest unit (e.g., cents).

Returns:

  • (Integer, nil) 


74
 
# File 'lib/lithic/models/transfer.rb', line 74

optional :settled_amount, Integer

#status ⇒ Symbol, ...

Status types:

  • ‘DECLINED` - The transfer was declined.

  • ‘EXPIRED` - The transfer was held in pending for too long and expired.

  • ‘PENDING` - The transfer is pending release from a hold.

  • ‘SETTLED` - The transfer is completed.

  • ‘VOIDED` - The transfer was reversed before it settled.

Returns:



86
 
# File 'lib/lithic/models/transfer.rb', line 86

optional :status, enum: -> { Lithic::Transfer::Status }

#to_balance ⇒ Array<Lithic::Models::Balance>?

The updated balance of the receiving financial account.

Returns:



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

optional :to_balance, -> { Lithic::Internal::Type::ArrayOf[Lithic::Balance] }

#token ⇒ String?

Globally unique identifier for the transfer event.

Returns:

  • (String, nil) 


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

optional :token, String

#updated ⇒ Time?

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

Returns:

  • (Time, nil) 


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

optional :updated, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/transfer.rb', line 141