Accounts
API reference for retrieving account information and seeing all possible account types and subtypes
/accounts/get
Retrieve accounts
The /accounts/get
endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance.
For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the NEW_ACCOUNTS_AVAILABLE
webhook and then use Link's update mode to request that the user share this new account with you.
This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use /accounts/balance/get
instead. Note that some information is nullable.
Request fields and example
client_id string Your Plaid API client_id . The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body. | |
secret string Your Plaid API secret . The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body. | |
access_token requiredstring The access token associated with the Item data is being requested for. | |
options object An optional object to filter /accounts/get results.
|
1const request: AccountsGetRequest = {2 access_token: ACCESS_TOKEN,3};4try {5 const response = await plaidClient.accountsGet(request);6 const accounts = response.data.accounts;7} catch (error) {8 // handle error9}
Response fields and example
accounts [object] An array of financial institution accounts associated with the Item.
If /accounts/balance/get was called, each account will include real-time balance information.
| |||||||||||||||||||
item object Metadata about the Item.
| |||||||||||||||||||
request_id string A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive. |
1{2 "accounts": [3 {4 "account_id": "blgvvBlXw3cq5GMPwqB6s6q4dLKB9WcVqGDGo",5 "balances": {6 "available": 100,7 "current": 110,8 "iso_currency_code": "USD",9 "limit": null,10 "unofficial_currency_code": null11 },12 "mask": "0000",13 "name": "Plaid Checking",14 "official_name": "Plaid Gold Standard 0% Interest Checking",15 "subtype": "checking",16 "type": "depository"17 },18 {19 "account_id": "6PdjjRP6LmugpBy5NgQvUqpRXMWxzktg3rwrk",20 "balances": {21 "available": null,22 "current": 23631.9805,23 "iso_currency_code": "USD",24 "limit": null,25 "unofficial_currency_code": null26 },27 "mask": "6666",28 "name": "Plaid 401k",29 "official_name": null,30 "subtype": "401k",31 "type": "investment"32 },33 {34 "account_id": "XMBvvyMGQ1UoLbKByoMqH3nXMj84ALSdE5B58",35 "balances": {36 "available": null,37 "current": 65262,38 "iso_currency_code": "USD",39 "limit": null,40 "unofficial_currency_code": null41 },42 "mask": "7777",43 "name": "Plaid Student Loan",44 "official_name": null,45 "subtype": "student",46 "type": "loan"47 }48 ],49 "item": {50 "available_products": [51 "balance",52 "identity",53 "payment_initiation",54 "transactions"55 ],56 "billed_products": [57 "assets",58 "auth"59 ],60 "consent_expiration_time": null,61 "error": null,62 "institution_id": "ins_117650",63 "item_id": "DWVAAPWq4RHGlEaNyGKRTAnPLaEmo8Cvq7na6",64 "update_type": "background",65 "webhook": "https://www.genericwebhookurl.com/webhook"66 },67 "request_id": "bkVE1BHWMAZ9Rnr"68}
Was this helpful?
Account type schema
The schema below describes the various types
and corresponding subtypes
that Plaid recognizes and reports for financial institution accounts.
depository string An account type holding cash, in which funds are deposited. Supported products for depository accounts are: Auth (checking and savings types only), Balance, Transactions, Identity, Payment Initiation, and Assets.
| |||||||||||||||||||||||||||||||||||||||||||||||
credit string A credit card type account. Supported products for credit accounts are: Balance, Transactions, Identity, and Liabilities.
| |||||||||||||||||||||||||||||||||||||||||||||||
loan string A loan type account. Supported products for loan accounts are: Balance, Liabilities, and Transactions.
| |||||||||||||||||||||||||||||||||||||||||||||||
investment string An investment account. Supported products for investment accounts are: Balance and Investments. In API versions 2018-05-22 and earlier, this type is called brokerage .
| |||||||||||||||||||||||||||||||||||||||||||||||
other string Other or unknown account type. Supported products for other accounts are: Balance, Transactions, Identity, and Assets. |
Was this helpful?
Account type / product support matrix
The chart below indicates which products can be used with which account types. Note that some products can only be used with certain subtypes: Auth requires a debitable checking
or savings
depository account, and Liabilities does not support loan
types other than student
or mortgage
. Also note that not all institutions support all products; for details on which products a given institution supports, use /institutions/get_by_id
or look up the institution on the Plaid dashboard status page.
Product | Depository | Credit | Investments | Loan | Other |
---|---|---|---|---|---|
Auth | |||||
Balance | * | ||||
Transactions | |||||
Identity | |||||
Assets | |||||
Investments | |||||
Liabilities | |||||
Payment Initiation (UK and Europe) | |||||
Transfer (beta) | |||||
Income (Bank Income flow) |
* Investments holdings data is not priced intra-day.
Currency code schema
The following currency codes are supported by Plaid.
iso_currency_code string Plaid supports all ISO 4217 currency codes. | |||||||||||||||||||||||
unofficial_currency_code string List of unofficial currency codes
|
Was this helpful?
Investment transaction types schema
Valid values for investment transaction types and subtypes. Note that transactions representing inflow of cash will appear as negative amounts, outflow of cash will appear as positive amounts.
buy string Buying an investment
| ||||||||||||||||||||||
sell string Selling an investment
| ||||||||||||||||||||||
cancel string A cancellation of a pending transaction | ||||||||||||||||||||||
cash string Activity that modifies a cash position
| ||||||||||||||||||||||
fee string Fees on the account, e.g. commission, bookkeeping, options-related.
| ||||||||||||||||||||||
transfer string Activity that modifies a position, but not through buy/sell activity e.g. options exercise, portfolio transfer
|