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

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/modern_treasury/models/payment_order_create_async_params.rb

Defined Under Namespace

Modules: PartyType Classes: AccountDetail, RoutingDetail

Instance Attribute Summary collapse

Class Method Summary collapse

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_detailsArray<ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::AccountDetail>?



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

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

#account_typeSymbol, ...

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



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

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

#contact_detailsArray<ModernTreasury::Models::ContactDetailCreateRequest>?



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

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

#external_idString?

An optional user-defined 180 character unique identifier.

Returns:

  • (String, nil)


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

optional :external_id, String, nil?: true

#ledger_accountModernTreasury::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.



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

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

#metadataHash{Symbol=>String}?

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

Returns:

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


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

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

#nameString?

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

Returns:

  • (String, nil)


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

optional :name, String, nil?: true

#party_addressModernTreasury::Models::AddressRequest?

Required if receiving wire payments.



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

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

#party_identifierString?

Returns:

  • (String, nil)


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

optional :party_identifier, String

#party_nameString?

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

Returns:

  • (String, nil)


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

optional :party_name, String

#party_typeSymbol, ...

Either ‘individual` or `business`.



575
576
577
# File 'lib/modern_treasury/models/payment_order_create_async_params.rb', line 575

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

#plaid_processor_tokenString?

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)


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

optional :plaid_processor_token, String

#routing_detailsArray<ModernTreasury::Models::PaymentOrderCreateAsyncParams::ReceivingAccount::RoutingDetail>?



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

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

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


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