class Lithic::Resources::ExternalBankAccounts

def create(params)

Other tags:
    See: Lithic::Models::ExternalBankAccountCreateParams -

Returns:
  • (Lithic::Models::ExternalBankAccountCreateResponse) -

Parameters:
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • verification_enforcement (Boolean) --
  • user_defined_id (String) --
  • name (String) --
  • doing_business_as (String) --
  • dob (Date) --
  • company_id (String) --
  • address (Lithic::Models::ExternalBankAccountAddress) --
  • account_token (String) --
  • processor_token (String) --
  • verification_method (Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod) --
  • type (Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type) --
  • routing_number (String) --
  • owner_type (Symbol, Lithic::Models::OwnerType) --
  • owner (String) --
  • financial_account_token (String) --
  • currency (String) --
  • country (String) --
  • account_number (String) --

Overloads:
  • create(account_number:, country:, currency:, financial_account_token:, owner:, owner_type:, routing_number:, type:, verification_method:, processor_token:, 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: {}) 
def create(params)
  parsed, options = Lithic::Models::ExternalBankAccountCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/external_bank_accounts",
    body: parsed,
    model: Lithic::Models::ExternalBankAccountCreateResponse,
    options: options
  )
end

def initialize(client:)

Parameters:
  • client (Lithic::Client) --

Other tags:
    Api: - private 
def initialize(client:)
  @client = client
  @micro_deposits = Lithic::Resources::ExternalBankAccounts::MicroDeposits.new(client: client)
end

def list(params = {})

Other tags:
    See: Lithic::Models::ExternalBankAccountListParams -

Returns:
  • (Lithic::Internal::CursorPage) -

Parameters:
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • verification_states (Array) --
  • states (Array) --
  • starting_after (String) --
  • page_size (Integer) --
  • owner_types (Array) --
  • ending_before (String) --
  • countries (Array) --
  • account_types (Array) --
  • account_token (String) --

Overloads:
  • 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: {}) 
def list(params = {})
  parsed, options = Lithic::Models::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

def retrieve(external_bank_account_token, params = {})

Other tags:
    See: Lithic::Models::ExternalBankAccountRetrieveParams -

Returns:
  • (Lithic::Models::ExternalBankAccountRetrieveResponse) -

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

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

def retry_micro_deposits(external_bank_account_token, params = {})

Other tags:
    See: Lithic::Models::ExternalBankAccountRetryMicroDepositsParams -

Returns:
  • (Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse) -

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

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

def retry_prenote(external_bank_account_token, params = {})

Other tags:
    See: Lithic::Models::ExternalBankAccountRetryPrenoteParams -

Returns:
  • (Lithic::Models::ExternalBankAccountRetryPrenoteResponse) -

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

Overloads:
  • retry_prenote(external_bank_account_token, financial_account_token: nil, request_options: {}) 
def retry_prenote(external_bank_account_token, params = {})
  parsed, options = Lithic::Models::ExternalBankAccountRetryPrenoteParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/external_bank_accounts/%1$s/retry_prenote", external_bank_account_token],
    body: parsed,
    model: Lithic::Models::ExternalBankAccountRetryPrenoteResponse,
    options: options
  )
end

def update(external_bank_account_token, params = {})

Other tags:
    See: Lithic::Models::ExternalBankAccountUpdateParams -

Returns:
  • (Lithic::Models::ExternalBankAccountUpdateResponse) -

Parameters:
  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}, nil) --
  • user_defined_id (String) --
  • type (Symbol, Lithic::Models::ExternalBankAccountUpdateParams::Type) --
  • owner_type (Symbol, Lithic::Models::OwnerType) --
  • owner (String) --
  • name (String) --
  • doing_business_as (String) --
  • dob (Date) --
  • company_id (String) --
  • address (Lithic::Models::ExternalBankAccountAddress) --
  • external_bank_account_token (String) --

Overloads:
  • 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: {}) 
def update(external_bank_account_token, params = {})
  parsed, options = Lithic::Models::ExternalBankAccountUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["v1/external_bank_accounts/%1$s", external_bank_account_token],
    body: parsed,
    model: Lithic::Models::ExternalBankAccountUpdateResponse,
    options: options
  )
end