Class: ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount

Defined in:

lib/modern_treasury/models/payment_order_create_async_params.rb,
sig/modern_treasury/models/payment_order_create_async_params.rbs

Defined Under Namespace

Modules: PartyType Classes: AccountDetail, RoutingDetail

Constant Summary

ModernTreasury =

Returns:

• (:LedgerAccountCreateRequest)

Instance Attribute Summary

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

  Can be checking, savings or other.

• #contact_details ⇒ Array<ModernTreasury::Models::ContactDetailCreateRequest>^?
• #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::PaymentOrderCreateAsyncParams::ReceivingAccount::RoutingDetail>^?

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/modern_treasury/models/payment_order_create_async_params.rbs', line 492

def initialize: (

Instance Attribute Details

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

Returns:

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

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 616

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

#account_type ⇒ Symbol, ...

Can be checking, savings or other.

Returns:

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

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 623

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

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

Returns:

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

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 628

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

#external_id ⇒ String^?

An optional user-defined 180 character unique identifier.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 635

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 https://docs.moderntreasury.com/docs/linking-to-other-modern-treasury-objects for more details.

Returns:

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

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 645

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

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

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

Parameters:

• (::Hash[Symbol, String])

Returns:

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

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 652

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

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 659

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/payment_order_create_async_params.rb', line 665

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

#party_identifier ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 670

optional :party_identifier, String

#party_name ⇒ String^?

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

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 676

optional :party_name, String

#party_type ⇒ Symbol, ...

Either individual or business.

Parameters:

• value (ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::party_type, nil)

Returns:

• (Symbol, ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::PartyType, nil)

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 682

optional :party_type,
enum: -> { ModernTreasury::PaymentOrderCreateAsyncParams::ReceivingAccount::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.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 691

optional :plaid_processor_token, String

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

Returns:

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

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 696

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

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 770

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/modern_treasury/models/payment_order_create_async_params.rbs', line 508

def to_hash: -> {