Class: Lithic::Models::ExternalBankAccountCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/lithic/models/external_bank_account_create_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Type, VerificationMethod

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary collapse

Instance Method Summary collapse

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, 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(account_number:, country:, currency:, financial_account_token:, owner:, owner_type:, routing_number:, type:, verification_method:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, name: nil, user_defined_id: nil, verification_enforcement: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::ExternalBankAccountCreateParams for more details.

Parameters:

  • account_number (String) —

    Account Number

  • country (String) —

    The country that the bank account is located in using ISO 3166-1. We will only a

  • currency (String) —

    currency of the external account 3-character alphabetic ISO 4217 code

  • financial_account_token (String) —

    The financial account token of the operating account to fund the micro deposits

  • owner (String) —

    Legal Name of the business or individual who owns the external account. This wil

  • owner_type (Symbol, Lithic::Models::OwnerType) —

    Owner Type

  • routing_number (String) —

    Routing Number

  • type (Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type) —

    Account Type

  • verification_method (Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod) —

    Verification Method

  • account_token (String) (defaults to: nil) —

    Indicates which Lithic account the external account is associated with. For exte

  • address (Lithic::Models::ExternalBankAccountAddress) (defaults to: nil) —

    Address

  • company_id (String) (defaults to: nil) —

    Optional field that helps identify bank accounts in receipts

  • dob (Date) (defaults to: nil) —

    Date of Birth of the Individual that owns the external bank account

  • doing_business_as (String) (defaults to: nil) —

    Doing Business As

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

    The nickname for this External Bank Account

  • user_defined_id (String) (defaults to: nil) —

    User Defined ID

  • verification_enforcement (Boolean) (defaults to: nil)
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/lithic/models/external_bank_account_create_params.rb', line 115

Instance Attribute Details

#account_number ⇒ String

Account Number

Returns:

  • (String) 


14
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 14

required :account_number, String

#account_token ⇒ String?

Indicates which Lithic account the external account is associated with. For external accounts that are associated with the program, account_token field returned will be null

Returns:

  • (String, nil) 


72
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 72

optional :account_token, String

#address ⇒ Lithic::Models::ExternalBankAccountAddress?

Address

Returns:



78
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 78

optional :address, -> { Lithic::ExternalBankAccountAddress }

#company_id ⇒ String?

Optional field that helps identify bank accounts in receipts

Returns:

  • (String, nil) 


84
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 84

optional :company_id, String

#country ⇒ String

The country that the bank account is located in using ISO 3166-1. We will only accept USA bank accounts e.g., USA

Returns:

  • (String) 


21
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 21

required :country, String

#currency ⇒ String

currency of the external account 3-character alphabetic ISO 4217 code

Returns:

  • (String) 


27
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 27

required :currency, String

#dob ⇒ Date?

Date of Birth of the Individual that owns the external bank account

Returns:

  • (Date, nil) 


90
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 90

optional :dob, Date

#doing_business_as ⇒ String?

Doing Business As

Returns:

  • (String, nil) 


96
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 96

optional :doing_business_as, String

#financial_account_token ⇒ String

The financial account token of the operating account to fund the micro deposits

Returns:

  • (String) 


33
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 33

required :financial_account_token, String

#name ⇒ String?

The nickname for this External Bank Account

Returns:

  • (String, nil) 


102
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 102

optional :name, String

#owner ⇒ String

Legal Name of the business or individual who owns the external account. This will appear in statements

Returns:

  • (String) 


40
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 40

required :owner, String

#owner_type ⇒ Symbol, Lithic::Models::OwnerType

Owner Type

Returns:



46
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 46

required :owner_type, enum: -> { Lithic::OwnerType }

#routing_number ⇒ String

Routing Number

Returns:

  • (String) 


52
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 52

required :routing_number, String

#type ⇒ Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type

Account Type

Returns:



58
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 58

required :type, enum: -> { Lithic::ExternalBankAccountCreateParams::Type }

#user_defined_id ⇒ String?

User Defined ID

Returns:

  • (String, nil) 


108
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 108

optional :user_defined_id, String

#verification_enforcement ⇒ Boolean?

Returns:

  • (Boolean, nil) 


113
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 113

optional :verification_enforcement, Lithic::Internal::Type::Boolean

#verification_method ⇒ Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod

Verification Method

Returns:



64
 
# File 'lib/lithic/models/external_bank_account_create_params.rb', line 64

required :verification_method, enum: -> { Lithic::ExternalBankAccountCreateParams::VerificationMethod }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/lithic/models/external_bank_account_create_params.rb', line 162