Lithic API Documentation | External Bank Accounts

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.

query Parameters

account_token: string

Optional

(format: uuid)

account_types: Array<

Optional

"CHECKING"

"SAVINGS"

countries: Array<string>

Optional

ending_before: string

Optional

A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

owner_types: Array<

OwnerType

Optional

"INDIVIDUAL"

"BUSINESS"

OwnerType

page_size: number

Optional

(maximum: 100, minimum: 1, default: 50)

Page size (for pagination).

starting_after: string

Optional

A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

states: Array<

Optional

"ENABLED"

"CLOSED"

"PAUSED"

verification_states: Array<

Optional

"PENDING"

"ENABLED"

"FAILED_VERIFICATION"

"INSUFFICIENT_FUNDS"

Response fields

data: Array<{ token, country, created, 19 more... }>

has_more: boolean

Request example

curl https://api.lithic.com/v1/external_bank_accounts \
    -H "Authorization: $LITHIC_API_KEY"

200Example

{
  "data": [
    {
      "token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "country": "country",
      "created": "2019-12-27T18:11:19.117Z",
      "currency": "currency",
      "last_four": "last_four",
      "owner": "owner",
      "owner_type": "BUSINESS",
      "routing_number": "routing_number",
      "state": "ENABLED",
      "type": "CHECKING",
      "verification_attempts": 0,
      "verification_method": "MANUAL",
      "verification_state": "PENDING",
      "account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "address": {
        "address1": "x",
        "city": "x",
        "country": "USD",
        "postal_code": "11201",
        "state": "xx",
        "address2": "x"
      },
      "company_id": "company_id",
      "dob": "2019-12-27",
      "doing_business_as": "doing_business_as",
      "financial_account_token": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "name": "name",
      "user_defined_id": "user_defined_id",
      "verification_failed_reason": "verification_failed_reason"
    }
  ],
  "has_more": true
}

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.

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.