Class: ModernTreasury::Models::CounterpartyCollectAccountParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/counterparty_collect_account_params.rb

Overview

See Also:

• Resources::Counterparties#collect_account

Defined Under Namespace

Modules: Field

Instance Attribute Summary

• #custom_redirect ⇒ String^?

  The URL you want your customer to visit upon filling out the form.

• #direction ⇒ Symbol, ModernTreasury::Models::TransactionDirection

  One of ‘credit` or `debit`.

• #fields ⇒ Array<Symbol, ModernTreasury::Models::CounterpartyCollectAccountParams::Field>^?

  The list of fields you want on the form.

• #send_email ⇒ Boolean^?

  By default, Modern Treasury will send an email to your counterparty that includes a link to the form they must fill out.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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

#custom_redirect ⇒ String^?

The URL you want your customer to visit upon filling out the form. By default, they will be sent to a Modern Treasury landing page. This must be a valid HTTPS URL if set.

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/counterparty_collect_account_params.rb', line 24

optional :custom_redirect, String

#direction ⇒ Symbol, ModernTreasury::Models::TransactionDirection

One of ‘credit` or `debit`. Use `credit` when you want to pay a counterparty. Use `debit` when you need to charge a counterparty. This field helps us send a more tailored email to your counterparties.“

Returns:

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

# File 'lib/modern_treasury/models/counterparty_collect_account_params.rb', line 16

required :direction, enum: -> { ModernTreasury::TransactionDirection }

#fields ⇒ Array<Symbol, ModernTreasury::Models::CounterpartyCollectAccountParams::Field>^?

The list of fields you want on the form. This field is optional and if it is not set, will default to ["nameOnAccount", "accountType", "accountNumber", "routingNumber", "address"]. The full list of options is ["name", "nameOnAccount", "taxpayerIdentifier", "accountType", "accountNumber", "routingNumber", "address", "ibanNumber", "swiftCode"].

Returns:

• (Array<Symbol, ModernTreasury::Models::CounterpartyCollectAccountParams::Field>, nil)

# File 'lib/modern_treasury/models/counterparty_collect_account_params.rb', line 34

optional :fields,
-> { ModernTreasury::Internal::Type::ArrayOf[enum: ModernTreasury::CounterpartyCollectAccountParams::Field] }

#send_email ⇒ Boolean^?

By default, Modern Treasury will send an email to your counterparty that includes a link to the form they must fill out. However, if you would like to send the counterparty the link, you can set this parameter to ‘false`. The JSON body will include the link to the secure Modern Treasury form.

Returns:

• (Boolean, nil)

# File 'lib/modern_treasury/models/counterparty_collect_account_params.rb', line 44

optional :send_email, ModernTreasury::Internal::Type::Boolean