Class: Lithic::Models::ExternalBankAccount

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Lithic::Models::ExternalBankAccount

Defined in:

lib/lithic/models/external_bank_account.rb

Overview

See Also:

• Resources::ExternalBankAccounts#retry_prenote

Direct Known Subclasses

ExternalBankAccountCreatedWebhookEvent, ExternalBankAccountUpdatedWebhookEvent

Defined Under Namespace

Modules: State, Type, VerificationState

Instance Attribute Summary

• #account_token ⇒ String^?

  Indicates which Lithic account the external account is associated with.

• #address ⇒ Lithic::Models::ExternalBankAccountAddress^?

  Address.

• #company_id ⇒ String^?

  Optional field that helps identify bank accounts in receipts.

• #country ⇒ String

  The country that the bank account is located in using ISO 3166-1.

• #created ⇒ Time

  An ISO 8601 string representing when this funding source was added to the Lithic account.

• #currency ⇒ String

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

• #dob ⇒ Date^?

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

• #doing_business_as ⇒ String^?

  Doing Business As.

• #financial_account_token ⇒ String^?

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

• #last_four ⇒ String

  The last 4 digits of the bank account.

• #name ⇒ String^?

  The nickname for this External Bank Account.

• #owner ⇒ String

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

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

  Owner Type.

• #routing_number ⇒ String

  Routing Number.

• #state ⇒ Symbol, Lithic::Models::ExternalBankAccount::State

  Account State.

• #token ⇒ String

  A globally unique identifier for this record of an external bank account association.

• #type ⇒ Symbol, Lithic::Models::ExternalBankAccount::Type

  Account Type.

• #user_defined_id ⇒ String^?

  User Defined ID.

• #verification_attempts ⇒ Integer

  The number of attempts at verification.

• #verification_failed_reason ⇒ String^?

  Optional free text description of the reason for the failed verification.

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

  Verification Method.

• #verification_state ⇒ Symbol, Lithic::Models::ExternalBankAccount::VerificationState

  Verification State.

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil) ⇒ Object constructor

  Some parameter documentations has been truncated, see ExternalBankAccount for more details.

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(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil) ⇒ Object

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

Parameters:

• token (String) —

  A globally unique identifier for this record of an external bank account associa

• country (String) —

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

• created (Time) —

  An ISO 8601 string representing when this funding source was added to the Lithic

• currency (String) —

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

• last_four (String) —

  The last 4 digits of the bank account. Derived by Lithic from the account number

• 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

• state (Symbol, Lithic::Models::ExternalBankAccount::State) —

  Account State

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

  Account Type

• verification_attempts (Integer) —

  The number of attempts at verification

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

  Verification Method

• verification_state (Symbol, Lithic::Models::ExternalBankAccount::VerificationState) —

  Verification State

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

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

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

  Address

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

  Optional field that helps identify bank accounts in receipts

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

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

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

  Doing Business As

• financial_account_token (String, nil) (defaults to: nil) —

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

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

  The nickname for this External Bank Account

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

  User Defined ID

• verification_failed_reason (String, nil) (defaults to: nil) —

  Optional free text description of the reason for the failed verification. For AC

# File 'lib/lithic/models/external_bank_account.rb', line 150

Instance Attribute Details

#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)

# File 'lib/lithic/models/external_bank_account.rb', line 98

optional :account_token, String, nil?: true

#address ⇒ Lithic::Models::ExternalBankAccountAddress^?

Address

Returns:

• (Lithic::Models::ExternalBankAccountAddress, nil)

# File 'lib/lithic/models/external_bank_account.rb', line 104

optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true

#company_id ⇒ String^?

Optional field that helps identify bank accounts in receipts

Returns:

• (String, nil)

# File 'lib/lithic/models/external_bank_account.rb', line 110

optional :company_id, String, nil?: true

#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)

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

required :country, String

#created ⇒ Time

An ISO 8601 string representing when this funding source was added to the Lithic account.

Returns:

• (Time)

# File 'lib/lithic/models/external_bank_account.rb', line 28

required :created, Time

#currency ⇒ String

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

Returns:

• (String)

# File 'lib/lithic/models/external_bank_account.rb', line 34

required :currency, String

#dob ⇒ Date^?

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

Returns:

• (Date, nil)

# File 'lib/lithic/models/external_bank_account.rb', line 116

optional :dob, Date, nil?: true

#doing_business_as ⇒ String^?

Doing Business As

Returns:

• (String, nil)

# File 'lib/lithic/models/external_bank_account.rb', line 122

optional :doing_business_as, String, nil?: true

#financial_account_token ⇒ String^?

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

Returns:

• (String, nil)

# File 'lib/lithic/models/external_bank_account.rb', line 128

optional :financial_account_token, String, nil?: true

#last_four ⇒ String

The last 4 digits of the bank account. Derived by Lithic from the account number passed

Returns:

• (String)

# File 'lib/lithic/models/external_bank_account.rb', line 41

required :last_four, String

#name ⇒ String^?

The nickname for this External Bank Account

Returns:

• (String, nil)

# File 'lib/lithic/models/external_bank_account.rb', line 134

optional :name, String, nil?: true

#owner ⇒ String

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

Returns:

• (String)

# File 'lib/lithic/models/external_bank_account.rb', line 48

required :owner, String

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

Owner Type

Returns:

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

# File 'lib/lithic/models/external_bank_account.rb', line 54

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

#routing_number ⇒ String

Routing Number

Returns:

• (String)

# File 'lib/lithic/models/external_bank_account.rb', line 60

required :routing_number, String

#state ⇒ Symbol, Lithic::Models::ExternalBankAccount::State

Account State

Returns:

• (Symbol, Lithic::Models::ExternalBankAccount::State)

# File 'lib/lithic/models/external_bank_account.rb', line 66

required :state, enum: -> { Lithic::ExternalBankAccount::State }

#token ⇒ String

A globally unique identifier for this record of an external bank account association. If a program links an external bank account to more than one end-user or to both the program and the end-user, then Lithic will return each record of the association

Returns:

• (String)

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

required :token, String

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

Account Type

Returns:

• (Symbol, Lithic::Models::ExternalBankAccount::Type)

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

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

#user_defined_id ⇒ String^?

User Defined ID

Returns:

• (String, nil)

# File 'lib/lithic/models/external_bank_account.rb', line 140

optional :user_defined_id, String, nil?: true

#verification_attempts ⇒ Integer

The number of attempts at verification

Returns:

• (Integer)

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

required :verification_attempts, Integer

#verification_failed_reason ⇒ String^?

Optional free text description of the reason for the failed verification. For ACH micro-deposits returned, this field will display the reason return code sent by the ACH network

Returns:

• (String, nil)

# File 'lib/lithic/models/external_bank_account.rb', line 148

optional :verification_failed_reason, String, nil?: true

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

Verification Method

Returns:

• (Symbol, Lithic::Models::VerificationMethod)

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

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

#verification_state ⇒ Symbol, Lithic::Models::ExternalBankAccount::VerificationState

Verification State

Returns:

• (Symbol, Lithic::Models::ExternalBankAccount::VerificationState)

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

required :verification_state, enum: -> { Lithic::ExternalBankAccount::VerificationState }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/lithic/models/external_bank_account.rb', line 208