Lithic.Resources.ExternalBankAccounts (Lithic v1.0.0)

Copy Markdown View Source

External bank accounts — link, verify, and manage counterparty accounts for ACH.

Micro-deposit verification

{:ok, eba} = Lithic.ExternalBankAccounts.create(%{
  routing_number: "021000021",
  account_number: "1234567890",
  account_type: "CHECKING",
  owner: "Jane Doe",
  owner_type: "INDIVIDUAL",
  verification_method: "MICRO_DEPOSIT"
})

# After deposits arrive (1–3 business days):
{:ok, _} = Lithic.ExternalBankAccounts.verify(eba["token"], %{
  micro_deposits: [12, 34]
})

Plaid token linking

{:ok, eba} = Lithic.ExternalBankAccounts.create(%{
  plaid_processor_token: "processor-token",
  verification_method: "PLAID"
})

Summary

Functions

create(params, opts \\ [])
get(external_bank_account_token, opts \\ [])
list(opts \\ [])
pause(external_bank_account_token, opts \\ [])

Pause an external bank account (prevents payment usage).

retry_micro_deposit(external_bank_account_token, opts \\ [])

Retry micro-deposit verification.

retry_prenote(external_bank_account_token, opts \\ [])

Retry via prenote.

set_verification_method(external_bank_account_token, params, opts \\ [])

Set the verification method for an external bank account.

unpause(external_bank_account_token, opts \\ [])

Unpause an external bank account.

update(external_bank_account_token, params, opts \\ [])
verify(external_bank_account_token, params, opts \\ [])

Verify via micro-deposit amounts.

Functions

create(params, opts \\ [])

@spec create(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Lithic.Error.t()}

get(external_bank_account_token, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Lithic.Error.t()}

list(opts \\ [])

@spec list(keyword()) :: {:ok, Lithic.Page.t(map())} | {:error, Lithic.Error.t()}

pause(external_bank_account_token, opts \\ [])

@spec pause(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Lithic.Error.t()}

Pause an external bank account (prevents payment usage).

retry_micro_deposit(external_bank_account_token, opts \\ [])

@spec retry_micro_deposit(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Lithic.Error.t()}

Retry micro-deposit verification.

retry_prenote(external_bank_account_token, opts \\ [])

@spec retry_prenote(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Lithic.Error.t()}

Retry via prenote.

set_verification_method(external_bank_account_token, params, opts \\ [])

@spec set_verification_method(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Lithic.Error.t()}

Set the verification method for an external bank account.

unpause(external_bank_account_token, opts \\ [])

@spec unpause(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Lithic.Error.t()}

Unpause an external bank account.

update(external_bank_account_token, params, opts \\ [])

@spec update(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Lithic.Error.t()}

verify(external_bank_account_token, params, opts \\ [])

@spec verify(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Lithic.Error.t()}

Verify via micro-deposit amounts.