LogoLithic API Documentation

External Bank Accounts

external_bank_accounts

Methods

List External Bank Accounts -> CursorPage<{ token, country, created, 19 more... }>
get/v1/external_bank_accounts

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

Create External Bank Account -> { token, country, created, 19 more... }
post/v1/external_bank_accounts

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

Get External Bank Account By Token -> { token, country, created, 19 more... }
get/v1/external_bank_accounts/{external_bank_account_token}

Get the external bank account by token.

path Parameters
external_bank_account_token: string
(format: uuid)
Response fields
token: string
(format: uuid)

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

country: string

The country that the bank account is located in using ISO 3166-1. We will only accept USA bank accounts e.g., USA

created: string
(format: date-time)

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

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 passed

owner: string

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

owner_type: "BUSINESS" | "INDIVIDUAL"

Owner Type

routing_number: string

Routing Number

state: "ENABLED" | "CLOSED" | "PAUSED"

Account State

type: "CHECKING" | "SAVINGS"

Account Type

verification_attempts: number

The number of attempts at verification

verification_method: "MANUAL" | "MICRO_DEPOSIT" | "PLAID" | 1 more...

Verification Method

verification_state: "PENDING" | "ENABLED" | "FAILED_VERIFICATION" | 1 more...

Verification State

account_token: string
Optional
Nullable
(format: uuid)

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

address:
ExternalBankAccountAddress
Optional
Nullable

Address

company_id: string
Optional
Nullable

Optional field that helps identify bank accounts in receipts

dob: string
Optional
Nullable
(format: date)

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

doing_business_as: string
Optional
Nullable

Doing Business As

financial_account_token: string
Optional
Nullable
(format: uuid)

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

name: string
Optional
Nullable

The nickname for this External Bank Account

user_defined_id: string
Optional
Nullable

User Defined ID

verification_failed_reason: string
Optional
Nullable

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

Request example
200Example
Update External Bank Account -> { token, country, created, 19 more... }
patch/v1/external_bank_accounts/{external_bank_account_token}

Update the external bank account by token.

Retry External Bank Account Via Micro Deposit -> { token, country, created, 19 more... }
post/v1/external_bank_accounts/{external_bank_account_token}/retry_micro_deposits

Retry external bank account micro deposit verification.

Retry External Bank Account Via Prenote ->
ExternalBankAccount
post/v1/external_bank_accounts/{external_bank_account_token}/retry_prenote

Retry external bank account prenote verification.

Unpause External Bank Account ->
ExternalBankAccount
post/v1/external_bank_accounts/{external_bank_account_token}/unpause

Unpause an external bank account

Domain types

ExternalBankAccount = { token, country, created, 19 more... }
ExternalBankAccountAddress = { address1, city, country, 3 more... }
OwnerType = "INDIVIDUAL" | "BUSINESS"
VerificationMethod = "MANUAL" | "MICRO_DEPOSIT" | "PRENOTE" | 2 more...
External Bank Accounts

Micro Deposits

external_bank_accounts.micro_deposits

Methods

Verify External Bank Account Via Micro Deposit Amounts -> { token, country, created, 19 more... }
post/v1/external_bank_accounts/{external_bank_account_token}/micro_deposits

Verify the external bank account by providing the micro deposit amounts.