Class: ModernTreasury::Models::ExternalAccountCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/external_account_create_params.rb

Overview

See Also:

• Resources::ExternalAccounts#create

Defined Under Namespace

Modules: PartyType Classes: AccountDetail, RoutingDetail

Instance Attribute Summary

• #account_details ⇒ Array<ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail>^?
• #account_type ⇒ Symbol, ...

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

• #contact_details ⇒ Array<ModernTreasury::Models::ContactDetailCreateRequest>^?
• #counterparty_id ⇒ String^?
• #external_id ⇒ String^?

  An optional user-defined 180 character unique identifier.

• #ledger_account ⇒ ModernTreasury::Models::LedgerAccountCreateRequest^?

  Specifies a ledger account object that will be created with the external account.

• #metadata ⇒ Hash{Symbol=>String}^?

  Additional data represented as key-value pairs.

• #name ⇒ String^?

  A nickname for the external account.

• #party_address ⇒ ModernTreasury::Models::AddressRequest^?

  Required if receiving wire payments.

• #party_identifier ⇒ String^?
• #party_name ⇒ String^?

  If this value isn’t provided, it will be inherited from the counterparty’s name.

• #party_type ⇒ Symbol, ...

  Either ‘individual` or `business`.

• #plaid_processor_token ⇒ String^?

  If you’ve enabled the Modern Treasury + Plaid integration in your Plaid account, you can pass the processor token in this field.

• #routing_details ⇒ Array<ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail>^?

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

#==, ==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from ModernTreasury::Internal::Type::BaseModel

Instance Attribute Details

#account_details ⇒ Array<ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail>^?

Returns:

• (Array<ModernTreasury::Models::ExternalAccountCreateParams::AccountDetail>, nil)

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 18

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

#account_type ⇒ Symbol, ...

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

Returns:

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

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 25

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

#contact_details ⇒ Array<ModernTreasury::Models::ContactDetailCreateRequest>^?

Returns:

• (Array<ModernTreasury::Models::ContactDetailCreateRequest>, nil)

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 30

optional :contact_details,
-> { ModernTreasury::Internal::Type::ArrayOf[ModernTreasury::ContactDetailCreateRequest] }

#counterparty_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 13

required :counterparty_id, String, nil?: true

#external_id ⇒ String^?

An optional user-defined 180 character unique identifier.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 37

optional :external_id, String, nil?: true

#ledger_account ⇒ ModernTreasury::Models::LedgerAccountCreateRequest^?

Specifies a ledger account object that will be created with the external account. The resulting ledger account is linked to the external account for auto-ledgering Payment objects. See docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects for more details.

Returns:

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

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

optional :ledger_account, -> { ModernTreasury::LedgerAccountCreateRequest }

#metadata ⇒ Hash{Symbol=>String}^?

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

Returns:

• (Hash{Symbol=>String}, nil)

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

optional :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_create_params.rb', line 61

optional :name, String, nil?: true

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

Required if receiving wire payments.

Returns:

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

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 67

optional :party_address, -> { ModernTreasury::AddressRequest }

#party_identifier ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 72

optional :party_identifier, String

#party_name ⇒ String^?

If this value isn’t provided, it will be inherited from the counterparty’s name.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 78

optional :party_name, String

#party_type ⇒ Symbol, ...

Either ‘individual` or `business`.

Returns:

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

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 84

optional :party_type, enum: -> { ModernTreasury::ExternalAccountCreateParams::PartyType }, nil?: true

#plaid_processor_token ⇒ String^?

If you’ve enabled the Modern Treasury + Plaid integration in your Plaid account, you can pass the processor token in this field.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 91

optional :plaid_processor_token, String

#routing_details ⇒ Array<ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail>^?

Returns:

• (Array<ModernTreasury::Models::ExternalAccountCreateParams::RoutingDetail>, nil)

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 96

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/external_account_create_params.rb', line 168