Class: ModernTreasury::Models::ExternalAccount

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::ExternalAccount

Defined in:

lib/modern_treasury/models/external_account.rb

Overview

See Also:

• Resources::ExternalAccounts#create

Defined Under Namespace

Modules: PartyType, VerificationSource, VerificationStatus

Instance Attribute Summary

• #account_details ⇒ Array<ModernTreasury::Models::AccountDetail>
• #account_type ⇒ Symbol, ModernTreasury::Models::ExternalAccountType

  Can be ‘checking`, `savings` or `other`.

• #contact_details ⇒ Array<ModernTreasury::Models::ContactDetail>
• #counterparty_id ⇒ String^?
• #created_at ⇒ Time
• #discarded_at ⇒ Time^?
• #external_id ⇒ String^?

  An optional user-defined 180 character unique identifier.

• #id ⇒ String
• #ledger_account_id ⇒ String^?

  If the external account links to a ledger account in Modern Treasury, the id of the ledger account will be populated here.

• #live_mode ⇒ Boolean

  This field will be true if this object exists in the live environment or false if it exists in the test environment.

• #metadata ⇒ Hash{Symbol=>String}

  Additional data represented as key-value pairs.

• #name ⇒ String^?

  A nickname for the external account.

• #object ⇒ String
• #party_address ⇒ ModernTreasury::Models::Address^?

  The address associated with the owner or ‘null`.

• #party_name ⇒ String

  The legal name of the entity which owns the account.

• #party_type ⇒ Symbol, ...

  Either ‘individual` or `business`.

• #routing_details ⇒ Array<ModernTreasury::Models::RoutingDetail>
• #updated_at ⇒ Time
• #verification_source ⇒ Symbol, ...
• #verification_status ⇒ Symbol, ModernTreasury::Models::ExternalAccount::VerificationStatus

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id: , account_details: , account_type: , contact_details: , counterparty_id: , created_at: , discarded_at: , external_id: , ledger_account_id: , live_mode: , metadata: , name: , object: , party_address: , party_name: , party_type: , routing_details: , updated_at: , verification_source: , verification_status: ) ⇒ Object constructor

  Some parameter documentations has been truncated, see ExternalAccount for more details.

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(id: , account_details: , account_type: , contact_details: , counterparty_id: , created_at: , discarded_at: , external_id: , ledger_account_id: , live_mode: , metadata: , name: , object: , party_address: , party_name: , party_type: , routing_details: , updated_at: , verification_source: , verification_status: ) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::ExternalAccount for more details.

Parameters:

• id (String) (defaults to: )
• account_details (Array<ModernTreasury::Models::AccountDetail>) (defaults to: )
• account_type (Symbol, ModernTreasury::Models::ExternalAccountType) (defaults to: ) —

  Can be ‘checking`, `savings` or `other`.

• contact_details (Array<ModernTreasury::Models::ContactDetail>) (defaults to: )
• counterparty_id (String, nil) (defaults to: )
• created_at (Time) (defaults to: )
• discarded_at (Time, nil) (defaults to: )
• external_id (String, nil) (defaults to: ) —

  An optional user-defined 180 character unique identifier.

• ledger_account_id (String, nil) (defaults to: ) —

  If the external account links to a ledger account in Modern Treasury, the id of

• live_mode (Boolean) (defaults to: ) —

  This field will be true if this object exists in the live environment or false i

• metadata (Hash{Symbol=>String}) (defaults to: ) —

  Additional data represented as key-value pairs. Both the key and value must be s

• name (String, nil) (defaults to: ) —

  A nickname for the external account. This is only for internal usage and won’t a

• object (String) (defaults to: )
• party_address (ModernTreasury::Models::Address, nil) (defaults to: ) —

  The address associated with the owner or ‘null`.

• party_name (String) (defaults to: ) —

  The legal name of the entity which owns the account.

• party_type (Symbol, ModernTreasury::Models::ExternalAccount::PartyType, nil) (defaults to: ) —

  Either ‘individual` or `business`.

• routing_details (Array<ModernTreasury::Models::RoutingDetail>) (defaults to: )
• updated_at (Time) (defaults to: )
• verification_source (Symbol, ModernTreasury::Models::ExternalAccount::VerificationSource, nil) (defaults to: )
• verification_status (Symbol, ModernTreasury::Models::ExternalAccount::VerificationStatus) (defaults to: )

# File 'lib/modern_treasury/models/external_account.rb', line 122

Instance Attribute Details

#account_details ⇒ Array<ModernTreasury::Models::AccountDetail>

Returns:

• (Array<ModernTreasury::Models::AccountDetail>)

# File 'lib/modern_treasury/models/external_account.rb', line 15

required :account_details, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::AccountDetail] }

#account_type ⇒ Symbol, ModernTreasury::Models::ExternalAccountType

Can be ‘checking`, `savings` or `other`.

Returns:

• (Symbol, ModernTreasury::Models::ExternalAccountType)

# File 'lib/modern_treasury/models/external_account.rb', line 21

required :account_type, enum: -> { ModernTreasury::ExternalAccountType }

#contact_details ⇒ Array<ModernTreasury::Models::ContactDetail>

Returns:

• (Array<ModernTreasury::Models::ContactDetail>)

# File 'lib/modern_treasury/models/external_account.rb', line 26

required :contact_details, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetail] }

#counterparty_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/external_account.rb', line 31

required :counterparty_id, String, nil?: true

#created_at ⇒ Time

Returns:

• (Time)

# File 'lib/modern_treasury/models/external_account.rb', line 36

required :created_at, Time

#discarded_at ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/modern_treasury/models/external_account.rb', line 41

required :discarded_at, Time, nil?: true

#external_id ⇒ String^?

An optional user-defined 180 character unique identifier.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/external_account.rb', line 47

required :external_id, String, nil?: true

#id ⇒ String

Returns:

• (String)

# File 'lib/modern_treasury/models/external_account.rb', line 10

required :id, String

#ledger_account_id ⇒ String^?

If the external account links to a ledger account in Modern Treasury, the id of the ledger account will be populated here.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/external_account.rb', line 54

required :ledger_account_id, String, nil?: true

#live_mode ⇒ Boolean

This field will be true if this object exists in the live environment or false if it exists in the test environment.

Returns:

• (Boolean)

# File 'lib/modern_treasury/models/external_account.rb', line 61

required :live_mode, ModernTreasury::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>String}

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

• (Hash{Symbol=>String})

# File 'lib/modern_treasury/models/external_account.rb', line 68

required :metadata, ModernTreasury::Internal::Type::HashOf[String]

#name ⇒ String^?

A nickname for the external account. This is only for internal usage and won’t affect any payments

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/external_account.rb', line 75

required :name, String, nil?: true

#object ⇒ String

Returns:

• (String)

# File 'lib/modern_treasury/models/external_account.rb', line 80

required :object, String

#party_address ⇒ ModernTreasury::Models::Address^?

The address associated with the owner or ‘null`.

Returns:

• (ModernTreasury::Models::Address, nil)

# File 'lib/modern_treasury/models/external_account.rb', line 86

required :party_address, -> { ModernTreasury::Address }, nil?: true

#party_name ⇒ String

The legal name of the entity which owns the account.

Returns:

• (String)

# File 'lib/modern_treasury/models/external_account.rb', line 92

required :party_name, String

#party_type ⇒ Symbol, ...

Either ‘individual` or `business`.

Returns:

• (Symbol, ModernTreasury::Models::ExternalAccount::PartyType, nil)

# File 'lib/modern_treasury/models/external_account.rb', line 98

required :party_type, enum: -> { ModernTreasury::ExternalAccount::PartyType }, nil?: true

#routing_details ⇒ Array<ModernTreasury::Models::RoutingDetail>

Returns:

• (Array<ModernTreasury::Models::RoutingDetail>)

# File 'lib/modern_treasury/models/external_account.rb', line 103

required :routing_details, -> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::RoutingDetail] }

#updated_at ⇒ Time

Returns:

• (Time)

# File 'lib/modern_treasury/models/external_account.rb', line 108

required :updated_at, Time

#verification_source ⇒ Symbol, ...

Returns:

• (Symbol, ModernTreasury::Models::ExternalAccount::VerificationSource, nil)

# File 'lib/modern_treasury/models/external_account.rb', line 113

required :verification_source,
enum: -> { ModernTreasury::ExternalAccount::VerificationSource },
nil?: true

#verification_status ⇒ Symbol, ModernTreasury::Models::ExternalAccount::VerificationStatus

Returns:

• (Symbol, ModernTreasury::Models::ExternalAccount::VerificationStatus)

# File 'lib/modern_treasury/models/external_account.rb', line 120

required :verification_status, enum: -> { ModernTreasury::ExternalAccount::VerificationStatus }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/external_account.rb', line 175