Class: Increase::Models::Transaction::Source::AccountTransferIntention

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(amount: , currency: , description: , destination_account_id: , source_account_id: , transfer_id: ) ⇒ Object

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

An Account Transfer Intention object. This field will be present in the JSON response if and only if ‘category` is equal to `account_transfer_intention`. Two Account Transfer Intentions are created from each Account Transfer. One decrements the source account, and the other increments the destination account.

Parameters:

  • amount (Integer) (defaults to: ) —

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

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

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

  • description (String) (defaults to: ) —

    The description you chose to give the transfer.

  • destination_account_id (String) (defaults to: ) —

    The identifier of the Account to where the Account Transfer was sent.

  • source_account_id (String) (defaults to: ) —

    The identifier of the Account from where the Account Transfer was sent.

  • transfer_id (String) (defaults to: ) —

    The identifier of the Account Transfer that led to this Pending Transaction.




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

Instance Attribute Details

#amount ⇒ Integer

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

Returns:

  • (Integer) 


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

required :amount, Integer

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

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

Returns:



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

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

#description ⇒ String

The description you chose to give the transfer.

Returns:

  • (String) 


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

required :description, String

#destination_account_id ⇒ String

The identifier of the Account to where the Account Transfer was sent.

Returns:

  • (String) 


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

required :destination_account_id, String

#source_account_id ⇒ String

The identifier of the Account from where the Account Transfer was sent.

Returns:

  • (String) 


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

required :source_account_id, String

#transfer_id ⇒ String

The identifier of the Account Transfer that led to this Pending Transaction.

Returns:

  • (String) 


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

required :transfer_id, String