Sign in

v66

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-08-042174421.1 MB
External Bank Account

Pause external bank account

Pause an external bank account

post/v1/external_bank_accounts/{external_bank_account_token}/pause

Path parameters

external_bank_account_tokenstring uuid required

Response

OK

tokenstring uuid required

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

ownerstring required

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

routing_numberstring required

Routing Number

last_fourstring required

The last 4 digits of the bank account. Derived by Lithic from the account number passed

namestring nullable

The nickname for this External Bank Account

currencystring required

currency of the external account 3-character alphabetic ISO 4217 code

countrystring required

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

account_tokenstring uuid nullable

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

createdstring date-time required

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

company_idstring nullable

Optional field that helps identify bank accounts in receipts

dobstring date nullable

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

doing_business_asstring nullable

Doing Business As

user_defined_idstring nullable

User Defined ID

verification_failed_reasonstring 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

verification_attemptsinteger required

The number of attempts at verification

financial_account_tokenstring uuid nullable

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

type'CHECKING' | 'SAVINGS' required
verification_method'MANUAL' | 'MICRO_DEPOSIT' | 'PRENOTE' | 'EXTERNALLY_VERIFIED' | 'UNVERIFIED' required
owner_type'INDIVIDUAL' | 'BUSINESS' required
state'ENABLED' | 'CLOSED' | 'PAUSED' required
verification_state'PENDING' | 'ENABLED' | 'FAILED_VERIFICATION' | 'INSUFFICIENT_FUNDS' required

Example response

{
  "address": {
    "postal_code": "11201",
    "country": "USD"
  }
}