Class: Lithic::Models::Payment

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

Overview

See Also:

Defined Under Namespace

Modules: Category, Direction, Method, MethodAttributes, Result, Source, Status, Type Classes: Event, RelatedAccountTokens

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(account_token:, business_account_token:) ⇒ Object

Account tokens related to a payment transaction

Parameters:

  • account_token (String, nil) —

    Globally unique identifier for the account

  • business_account_token (String, nil) —

    Globally unique identifier for the business account




# File 'lib/lithic/models/payment.rb', line 138

Instance Attribute Details

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

Transaction category

Returns:



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

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

#created ⇒ Time

ISO 8601 timestamp of when the transaction was created

Returns:

  • (Time) 


23
 
# File 'lib/lithic/models/payment.rb', line 23

required :created, Time

#currency ⇒ String?

Currency of the transaction in ISO 4217 format

Returns:

  • (String, nil) 


113
 
# File 'lib/lithic/models/payment.rb', line 113

optional :currency, String

#descriptor ⇒ String

Transaction descriptor

Returns:

  • (String) 


29
 
# File 'lib/lithic/models/payment.rb', line 29

required :descriptor, String

#direction ⇒ Symbol, Lithic::Models::Payment::Direction

Transfer direction

Returns:



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

required :direction, enum: -> { Lithic::Payment::Direction }

#events ⇒ Array<Lithic::Models::Payment::Event>

List of transaction events

Returns:



41
 
# File 'lib/lithic/models/payment.rb', line 41

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

#expected_release_date ⇒ Date?

Expected release date for the transaction

Returns:

  • (Date, nil) 


119
 
# File 'lib/lithic/models/payment.rb', line 119

optional :expected_release_date, Date, nil?: true

#external_bank_account_token ⇒ String?

External bank account token

Returns:

  • (String, nil) 


125
 
# File 'lib/lithic/models/payment.rb', line 125

optional :external_bank_account_token, String, nil?: true

#family ⇒ Symbol, :PAYMENT

PAYMENT - Payment Transaction

Returns:

  • (Symbol, :PAYMENT) 


47
 
# File 'lib/lithic/models/payment.rb', line 47

required :family, const: :PAYMENT

#financial_account_token ⇒ String

Financial account token

Returns:

  • (String) 


53
 
# File 'lib/lithic/models/payment.rb', line 53

required :financial_account_token, String

#method_ ⇒ Symbol, Lithic::Models::Payment::Method

Transfer method

Returns:



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

required :method_, enum: -> { Lithic::Payment::Method }, api_name: :method

#method_attributes ⇒ Lithic::Models::Payment::MethodAttributes::ACHMethodAttributes, Lithic::Models::Payment::MethodAttributes::WireMethodAttributes

Method-specific attributes

Returns:



65
 
# File 'lib/lithic/models/payment.rb', line 65

required :method_attributes, union: -> { Lithic::Payment::MethodAttributes }

#pending_amount ⇒ Integer

Pending amount in cents

Returns:

  • (Integer) 


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

required :pending_amount, Integer

#related_account_tokens ⇒ Lithic::Models::Payment::RelatedAccountTokens?

Account tokens related to a payment transaction

Returns:



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

required :related_account_tokens, -> { Lithic::Payment::RelatedAccountTokens }, nil?: true

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

Transaction result

Returns:



83
 
# File 'lib/lithic/models/payment.rb', line 83

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

#settled_amount ⇒ Integer

Settled amount in cents

Returns:

  • (Integer) 


89
 
# File 'lib/lithic/models/payment.rb', line 89

required :settled_amount, Integer

#source ⇒ Symbol, Lithic::Models::Payment::Source

Transaction source

Returns:



95
 
# File 'lib/lithic/models/payment.rb', line 95

required :source, enum: -> { Lithic::Payment::Source }

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

The status of the transaction

Returns:



101
 
# File 'lib/lithic/models/payment.rb', line 101

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

#token ⇒ String

Unique identifier for the transaction

Returns:

  • (String) 


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

required :token, String

#type ⇒ Symbol, ...

Returns:



130
 
# File 'lib/lithic/models/payment.rb', line 130

optional :type, enum: -> { Lithic::Payment::Type }

#updated ⇒ Time

ISO 8601 timestamp of when the transaction was last updated

Returns:

  • (Time) 


107
 
# File 'lib/lithic/models/payment.rb', line 107

required :updated, Time

#user_defined_id ⇒ String?

User-defined identifier

Returns:

  • (String, nil) 


136
 
# File 'lib/lithic/models/payment.rb', line 136

optional :user_defined_id, String, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/payment.rb', line 212

.variants ⇒ Array(Lithic::Models::Payment::MethodAttributes::ACHMethodAttributes, Lithic::Models::Payment::MethodAttributes::WireMethodAttributes)

Returns:




# File 'lib/lithic/models/payment.rb', line 563