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:



201
202
203
204
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 201

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(body:, request_options: {}) ⇒ Lithic::Models::ExternalBankAccountCreateResponse

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

Parameters:

Returns:

See Also:



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 19

def create(params)
  parsed, options = Lithic::ExternalBankAccountCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/external_bank_accounts",
    body: parsed[:body],
    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:



122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 122

def list(params = {})
  parsed, options = Lithic::ExternalBankAccountListParams.dump_request(params)
  query = Lithic::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "v1/external_bank_accounts",
    query: query,
    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:



40
41
42
43
44
45
46
47
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 40

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:



146
147
148
149
150
151
152
153
154
155
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 146

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:



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 168

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:



189
190
191
192
193
194
195
196
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 189

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:



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/lithic/resources/external_bank_accounts.rb', line 81

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