Class: Increase::Models::AccountTransfer

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

Overview

See Also:

Defined Under Namespace

Modules: Currency, Status, Type Classes: Approval, Cancellation, CreatedBy

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(email: ) ⇒ Object

If present, details about the User that created the transfer.

Parameters:

  • email (String) (defaults to: ) —

    The email address of the User.




# File 'lib/increase/models/account_transfer.rb', line 117

Instance Attribute Details

#account_id ⇒ String

The Account from which the transfer originated.

Returns:

  • (String) 


17
 
# File 'lib/increase/models/account_transfer.rb', line 17

required :account_id, String

#amount ⇒ Integer

The transfer amount in cents. This will always be positive and indicates the amount of money leaving the originating account.

Returns:

  • (Integer) 


24
 
# File 'lib/increase/models/account_transfer.rb', line 24

required :amount, Integer

#approval ⇒ Increase::Models::AccountTransfer::Approval?

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

Returns:



31
 
# File 'lib/increase/models/account_transfer.rb', line 31

required :approval, -> { Increase::AccountTransfer::Approval }, nil?: true

#cancellation ⇒ Increase::Models::AccountTransfer::Cancellation?

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

Returns:



38
 
# File 'lib/increase/models/account_transfer.rb', line 38

required :cancellation, -> { Increase::AccountTransfer::Cancellation }, nil?: true

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.

Returns:

  • (Time) 


45
 
# File 'lib/increase/models/account_transfer.rb', line 45

required :created_at, Time

#created_by ⇒ Increase::Models::AccountTransfer::CreatedBy?

What object created the transfer, either via the API or the dashboard.

Returns:



51
 
# File 'lib/increase/models/account_transfer.rb', line 51

required :created_by, -> { Increase::AccountTransfer::CreatedBy }, nil?: true

#currency ⇒ Symbol, Increase::Models::AccountTransfer::Currency

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

Returns:



58
 
# File 'lib/increase/models/account_transfer.rb', line 58

required :currency, enum: -> { Increase::AccountTransfer::Currency }

#description ⇒ String

An internal-facing description for the transfer for display in the API and dashboard. This will also show in the description of the created Transactions.

Returns:

  • (String) 


65
 
# File 'lib/increase/models/account_transfer.rb', line 65

required :description, String

#destination_account_id ⇒ String

The destination Account’s identifier.

Returns:

  • (String) 


71
 
# File 'lib/increase/models/account_transfer.rb', line 71

required :destination_account_id, String

#destination_transaction_id ⇒ String?

The identifier of the Transaction on the destination Account representing the received funds.

Returns:

  • (String, nil) 


78
 
# File 'lib/increase/models/account_transfer.rb', line 78

required :destination_transaction_id, String, nil?: true

#id ⇒ String

The Account Transfer’s identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/account_transfer.rb', line 11

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


86
 
# File 'lib/increase/models/account_transfer.rb', line 86

required :idempotency_key, String, nil?: true

#pending_transaction_id ⇒ String?

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization.

Returns:

  • (String, nil) 


95
 
# File 'lib/increase/models/account_transfer.rb', line 95

required :pending_transaction_id, String, nil?: true

#status ⇒ Symbol, Increase::Models::AccountTransfer::Status

The lifecycle status of the transfer.

Returns:



101
 
# File 'lib/increase/models/account_transfer.rb', line 101

required :status, enum: -> { Increase::AccountTransfer::Status }

#transaction_id ⇒ String?

The identifier of the Transaction on the originating account representing the transferred funds.

Returns:

  • (String, nil) 


108
 
# File 'lib/increase/models/account_transfer.rb', line 108

required :transaction_id, String, nil?: true

#type ⇒ Symbol, Increase::Models::AccountTransfer::Type

A constant representing the object’s type. For this resource it will always be ‘account_transfer`.

Returns:



115
 
# File 'lib/increase/models/account_transfer.rb', line 115

required :type, enum: -> { Increase::AccountTransfer::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/account_transfer.rb', line 325