Class: Lithic::Models::Payment::Event

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

Defined Under Namespace

Modules: DetailedResult, Result, Type

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:, amount:, created:, result:, type:, detailed_results: nil) ⇒ Object

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

Payment Event

Parameters:




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

Instance Attribute Details

#amount ⇒ Integer

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

Returns:

  • (Integer) 


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

required :amount, Integer

#created ⇒ Time

Date and time when the financial event occurred. UTC time zone.

Returns:

  • (Time) 


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

required :created, Time

#detailed_results ⇒ Array<Symbol, Lithic::Models::Payment::Event::DetailedResult>?

More detailed reasons for the event

Returns:



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

optional :detailed_results,
-> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Payment::Event::DetailedResult] }

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

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

Returns:



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

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

#token ⇒ String

Globally unique identifier.

Returns:

  • (String) 


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

required :token, String

#type ⇒ Symbol, Lithic::Models::Payment::Event::Type

Event types:

  • ‘ACH_ORIGINATION_INITIATED` - ACH origination received and pending approval/release from an ACH hold.

  • ‘ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.

  • ‘ACH_ORIGINATION_CANCELLED` - ACH origination has been cancelled.

  • ‘ACH_ORIGINATION_PROCESSED` - ACH origination has been processed and sent to the Federal Reserve.

  • ‘ACH_ORIGINATION_SETTLED` - ACH origination has settled.

  • ‘ACH_ORIGINATION_RELEASED` - ACH origination released from pending to available balance.

  • ‘ACH_ORIGINATION_REJECTED` - ACH origination was rejected and not sent to the Federal Reserve.

  • ‘ACH_RECEIPT_PROCESSED` - ACH receipt pending release from an ACH holder.

  • ‘ACH_RECEIPT_SETTLED` - ACH receipt funds have settled.

  • ‘ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available balance.

  • ‘ACH_RETURN_INITIATED` - ACH initiated return for an ACH receipt.

  • ‘ACH_RETURN_PROCESSED` - ACH receipt returned by the Receiving Depository Financial Institution.

  • ‘ACH_RETURN_SETTLED` - ACH return settled by the Receiving Depository Financial Institution.

  • ‘ACH_RETURN_REJECTED` - ACH return was rejected by the Receiving Depository Financial Institution.

Returns:



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

required :type, enum: -> { Lithic::Payment::Event::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



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