Class: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb

Overview

Defined Under Namespace

Modules: OwnerType, State, Type, VerificationMethod, VerificationState

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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::ExternalBankAccounts::MicroDepositCreateResponse 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::ExternalBankAccounts::MicroDepositCreateResponse::OwnerType)

    Owner Type

  • routing_number (String)

    Routing Number

  • state (Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::State)

    Account State

  • type (Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::Type)

    Account Type

  • verification_attempts (Integer)

    The number of attempts at verification

  • verification_method (Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationMethod)

    Verification Method

  • verification_state (Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::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_accounts/micro_deposit_create_response.rb', line 154


Instance Attribute Details

#account_tokenString?

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)


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

optional :account_token, String, nil?: true

#addressLithic::Models::ExternalBankAccountAddress?

Address



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

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

#company_idString?

Optional field that helps identify bank accounts in receipts

Returns:

  • (String, nil)


114
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 114

optional :company_id, String, nil?: true

#countryString

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)


22
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 22

required :country, String

#createdTime

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

Returns:

  • (Time)


29
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 29

required :created, Time

#currencyString

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

Returns:

  • (String)


35
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 35

required :currency, String

#dobDate?

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

Returns:

  • (Date, nil)


120
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 120

optional :dob, Date, nil?: true

#doing_business_asString?

Doing Business As

Returns:

  • (String, nil)


126
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 126

optional :doing_business_as, String, nil?: true

#financial_account_tokenString?

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

Returns:

  • (String, nil)


132
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 132

optional :financial_account_token, String, nil?: true

#last_fourString

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

Returns:

  • (String)


42
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 42

required :last_four, String

#nameString?

The nickname for this External Bank Account

Returns:

  • (String, nil)


138
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 138

optional :name, String, nil?: true

#ownerString

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

Returns:

  • (String)


49
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 49

required :owner, String

#owner_typeSymbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::OwnerType

Owner Type



55
56
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 55

required :owner_type,
enum: -> { Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::OwnerType }

#routing_numberString

Routing Number

Returns:

  • (String)


62
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 62

required :routing_number, String

#stateSymbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::State

Account State



68
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 68

required :state, enum: -> { Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::State }

#tokenString

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)


15
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 15

required :token, String

#typeSymbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::Type

Account Type



74
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 74

required :type, enum: -> { Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::Type }

#user_defined_idString?

User Defined ID

Returns:

  • (String, nil)


144
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 144

optional :user_defined_id, String, nil?: true

#verification_attemptsInteger

The number of attempts at verification

Returns:

  • (Integer)


80
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 80

required :verification_attempts, Integer

#verification_failed_reasonString?

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)


152
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 152

optional :verification_failed_reason, String, nil?: true

#verification_methodSymbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationMethod

Verification Method



86
87
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 86

required :verification_method,
enum: -> { Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationMethod }

#verification_stateSymbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationState

Verification State



93
94
# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 93

required :verification_state,
enum: -> { Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationState }

Class Method Details

.valuesArray<Symbol>

Returns:

  • (Array<Symbol>)


# File 'lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb', line 212