Class: Lithic::Resources::ExternalBankAccounts

Inherits:
Object
  • Object
show all
Defined in:
lib/lithic/resources/external_bank_accounts.rb,
lib/lithic/resources/external_bank_accounts/micro_deposits.rb

Defined Under Namespace

Classes: MicroDeposits

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ ExternalBankAccounts

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of ExternalBankAccounts.

Parameters:



236
237
238
239
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 236

def initialize(client:)
  @client = client
  @micro_deposits = Lithic::Resources::ExternalBankAccounts::MicroDeposits.new(client: client)
end

Instance Attribute Details

#micro_deposits ⇒ Lithic::Resources::ExternalBankAccounts::MicroDeposits (readonly)

Returns:



7
8
9
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 7

def micro_deposits
  @micro_deposits
end

Instance Method Details

#create(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: {}) ⇒ Lithic::Models::ExternalBankAccountCreateResponse

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

Creates an external bank account within a program or Lithic account.

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

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

  • address (Lithic::Models::ExternalBankAccountAddress) —

    Address

  • company_id (String) —

    Optional field that helps identify bank accounts in receipts

  • dob (Date) —

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

  • doing_business_as (String) —

    Doing Business As

  • name (String) —

    The nickname for this External Bank Account

  • user_defined_id (String) —

    User Defined ID

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

Returns:

See Also:



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 55

def create(params)
  parsed, options = Lithic::ExternalBankAccountCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/external_bank_accounts",
    body: parsed,
    model: Lithic::Models::ExternalBankAccountCreateResponse,
    options: options
  )
end

#list(account_token: nil, account_types: nil, countries: nil, ending_before: nil, owner_types: nil, page_size: nil, starting_after: nil, states: nil, verification_states: nil, request_options: {}) ⇒ Lithic::Internal::CursorPage<Lithic::Models::ExternalBankAccountListResponse>

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

List all the external bank accounts for the provided search criteria.

Parameters:

Returns:

See Also:



158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 158

def list(params = {})
  parsed, options = Lithic::ExternalBankAccountListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "v1/external_bank_accounts",
    query: parsed,
    page: Lithic::Internal::CursorPage,
    model: Lithic::Models::ExternalBankAccountListResponse,
    options: options
  )
end

#retrieve(external_bank_account_token, request_options: {}) ⇒ Lithic::Models::ExternalBankAccountRetrieveResponse

Get the external bank account by token.

Parameters:

Returns:

See Also:



76
77
78
79
80
81
82
83
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 76

def retrieve(, params = {})
  @client.request(
    method: :get,
    path: ["v1/external_bank_accounts/%1$s", ],
    model: Lithic::Models::ExternalBankAccountRetrieveResponse,
    options: params[:request_options]
  )
end

#retry_micro_deposits(external_bank_account_token, financial_account_token: nil, request_options: {}) ⇒ Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse

Retry external bank account micro deposit verification.

Parameters:

  • external_bank_account_token (String)
  • financial_account_token (String)
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 181

def retry_micro_deposits(, params = {})
  parsed, options = Lithic::ExternalBankAccountRetryMicroDepositsParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/external_bank_accounts/%1$s/retry_micro_deposits", ],
    body: parsed,
    model: Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse,
    options: options
  )
end

#retry_prenote(external_bank_account_token, financial_account_token: nil, request_options: {}) ⇒ Lithic::Models::ExternalBankAccount

Retry external bank account prenote verification.

Parameters:

  • external_bank_account_token (String)
  • financial_account_token (String)
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 203

def retry_prenote(, params = {})
  parsed, options = Lithic::ExternalBankAccountRetryPrenoteParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/external_bank_accounts/%1$s/retry_prenote", ],
    body: parsed,
    model: Lithic::ExternalBankAccount,
    options: options
  )
end

#unpause(external_bank_account_token, request_options: {}) ⇒ Lithic::Models::ExternalBankAccount

Unpause an external bank account

Parameters:

Returns:

See Also:



224
225
226
227
228
229
230
231
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 224

def unpause(, params = {})
  @client.request(
    method: :post,
    path: ["v1/external_bank_accounts/%1$s/unpause", ],
    model: Lithic::ExternalBankAccount,
    options: params[:request_options]
  )
end

#update(external_bank_account_token, address: nil, company_id: nil, dob: nil, doing_business_as: nil, name: nil, owner: nil, owner_type: nil, type: nil, user_defined_id: nil, request_options: {}) ⇒ Lithic::Models::ExternalBankAccountUpdateResponse

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

Update the external bank account by token.

Parameters:

  • external_bank_account_token (String)
  • address (Lithic::Models::ExternalBankAccountAddress) —

    Address

  • company_id (String) —

    Optional field that helps identify bank accounts in receipts

  • dob (Date) —

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

  • doing_business_as (String) —

    Doing Business As

  • name (String) —

    The nickname for this External Bank Account

  • owner (String) —

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

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

    Owner Type

  • type (Symbol, Lithic::Models::ExternalBankAccountUpdateParams::Type)
  • user_defined_id (String) —

    User Defined ID

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

Returns:

See Also:



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 117

def update(, params = {})
  parsed, options = Lithic::ExternalBankAccountUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["v1/external_bank_accounts/%1$s", ],
    body: parsed,
    model: Lithic::Models::ExternalBankAccountUpdateResponse,
    options: options
  )
end