Class: Increase::Models::Transaction::Source::InterestPayment

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/transaction.rb

Overview

See Also:

Defined Under Namespace

Modules: Currency

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(accrued_on_account_id: , amount: , currency: , period_end: , period_start: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::Transaction::Source::InterestPayment for more details.

An Interest Payment object. This field will be present in the JSON response if and only if ‘category` is equal to `interest_payment`. An Interest Payment represents a payment of interest on an account. Interest is usually paid monthly.

Parameters:

  • accrued_on_account_id (String) (defaults to: ) —

    The account on which the interest was accrued.

  • amount (Integer) (defaults to: ) —

    The amount in the minor unit of the transaction’s currency. For dollars, for exa

  • currency (Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency) (defaults to: ) —

    The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the transaction

  • period_end (Time) (defaults to: ) —

    The end of the period for which this transaction paid interest.

  • period_start (Time) (defaults to: ) —

    The start of the period for which this transaction paid interest.




# File 'lib/increase/models/transaction.rb', line 6570

Instance Attribute Details

#accrued_on_account_id ⇒ String

The account on which the interest was accrued.

Returns:

  • (String) 


6542
 
# File 'lib/increase/models/transaction.rb', line 6542

required :accrued_on_account_id, String

#amount ⇒ Integer

The amount in the minor unit of the transaction’s currency. For dollars, for example, this is cents.

Returns:

  • (Integer) 


6549
 
# File 'lib/increase/models/transaction.rb', line 6549

required :amount, Integer

#currency ⇒ Symbol, Increase::Models::Transaction::Source::InterestPayment::Currency

The [ISO 4217](en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.

Returns:



6556
 
# File 'lib/increase/models/transaction.rb', line 6556

required :currency, enum: -> { Increase::Transaction::Source::InterestPayment::Currency }

#period_end ⇒ Time

The end of the period for which this transaction paid interest.

Returns:

  • (Time) 


6562
 
# File 'lib/increase/models/transaction.rb', line 6562

required :period_end, Time

#period_start ⇒ Time

The start of the period for which this transaction paid interest.

Returns:

  • (Time) 


6568
 
# File 'lib/increase/models/transaction.rb', line 6568

required :period_start, Time