Balance
API reference for Balance endpoints and webhooks
Verify real-time account balances.
Endpoints | |
---|---|
/accounts/balance/get | Fetch real-time account balances |
Endpoints
/accounts/balance/get
Retrieve real-time balance data
The /accounts/balance/get
endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as /accounts/get
, return a balance object, only /accounts/balance/get
forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, balance
itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
access_token
secret
secret
. The secret
is required and may be provided either in the PLAID-SECRET
header or as part of a request body.client_id
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.options
/accounts/balance/get
.account_ids
account_ids
to retrieve for the Item. The default value is null
.Note: An error will be returned if a provided
account_id
is not associated with the Item.min_last_updated _datetime
YYYY-MM-DDTHH:mm:ssZ
) indicating the oldest acceptable balance when making a request to /accounts/balance/get
.This field is only necessary when the institution is
ins_128026
(Capital One), and one or more account types being requested is a non-depository account (such as a credit card) as Capital One does not provide real-time balance for non-depository accounts. In this case, a value must be provided or an INVALID_REQUEST
error with the code of INVALID_FIELD
will be returned. For all other institutions, as well as for depository accounts at Capital One (including all checking and savings accounts) this field is ignored and real-time balance information will be fetched.If this field is not ignored, and no acceptable balance is available, an
INVALID_RESULT
error with the code LAST_UPDATED_DATETIME_OUT_OF_RANGE
will be returned.date-time
1// Pull real-time balance information for each account associated2// with the Item3const request: AccountsGetRequest = {4 access_token: accessToken,5};6try {7 const response = await plaidClient.accountsBalanceGet(request);8 const accounts = response.data.accounts;9} catch (error) {10 // handle error11}
Response fields and example
accounts
/accounts/balance/get
was called, each account will include real-time balance information.account_id
account_id
will be assigned to the account.The
account_id
can also change if the access_token
is deleted and the same credentials that were used to generate that access_token
are used to generate a new access_token
on a later date. In that case, the new account_id
will be different from the old account_id
.If an account with a specific
account_id
disappears instead of changing, the account is likely closed. Closed accounts are not returned by the Plaid API.Like all Plaid identifiers, the
account_id
is case sensitive.balances
/accounts/balance/get
.available
For
credit
-type accounts, the available
balance typically equals the limit
less the current
balance, less any pending outflows plus any pending inflows.For
depository
-type accounts, the available
balance typically equals the current
balance less any pending outflows plus any pending inflows. For depository
-type accounts, the available
balance does not include the overdraft limit.For
investment
-type accounts (or brokerage
-type accounts for API versions 2018-05-22 and earlier), the available
balance is the total cash available to withdraw as presented by the institution.Note that not all institutions calculate the
available
balance. In the event that available
balance is unavailable, Plaid will return an available
balance value of null
.Available balance may be cached and is not guaranteed to be up-to-date in realtime unless the value was returned by
/accounts/balance/get
.If
current
is null
this field is guaranteed not to be null
.double
current
For
credit
-type accounts, a positive balance indicates the amount owed; a negative amount indicates the lender owing the account holder.For
loan
-type accounts, the current balance is the principal remaining on the loan, except in the case of student loan accounts at Sallie Mae (ins_116944
). For Sallie Mae student loans, the account's balance includes both principal and any outstanding interest.For
investment
-type accounts (or brokerage
-type accounts for API versions 2018-05-22 and earlier), the current balance is the total value of assets as presented by the institution.Note that balance information may be cached unless the value was returned by
/accounts/balance/get
; if the Item is enabled for Transactions, the balance will be at least as recent as the most recent Transaction update. If you require realtime balance information, use the available
balance as provided by /accounts/balance/get
.When returned by
/accounts/balance/get
, this field may be null
. When this happens, available
is guaranteed not to be null
.double
limit
credit
-type accounts, this represents the credit limit.For
depository
-type accounts, this represents the pre-arranged overdraft limit, which is common for current (checking) accounts in Europe.In North America, this field is typically only available for
credit
-type accounts.double
iso_currency_code
unofficial_currency_code
is non-null.unofficial_currency _code
iso_currency_code
is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.See the currency code schema for a full listing of supported
unofficial_currency_code
s.last_updated_datetime
YYYY-MM-DDTHH:mm:ssZ
) indicating the oldest acceptable balance when making a request to /accounts/balance/get
.This field is only used and expected when the institution is
ins_128026
(Capital One) and the Item contains one or more accounts with a non-depository account type, in which case a value must be provided or an INVALID_REQUEST
error with the code of INVALID_FIELD
will be returned. For Capital One depository accounts as well as all other account types on all other institutions, this field is ignored. See account type schema for a full list of account types.If the balance that is pulled is older than the given timestamp for Items with this field required, an
INVALID_REQUEST
error with the code of LAST_UPDATED_DATETIME_OUT_OF_RANGE
will be returned with the most recent timestamp for the requested account contained in the response.date-time
mask
name
official_name
type
investment:
Investment account. In API versions 2018-05-22 and earlier, this type is called brokerage
instead.credit:
Credit carddepository:
Depository accountloan:
Loan accountother:
Non-specified account typeSee the Account type schema for a full listing of account types and corresponding subtypes.
investment
, credit
, depository
, loan
, brokerage
, other
subtype
401a
, 401k
, 403B
, 457b
, 529
, auto
, brokerage
, business
, cash isa
, cash management
, cd
, checking
, commercial
, construction
, consumer
, credit card
, crypto exchange
, ebt
, education savings account
, fixed annuity
, gic
, health reimbursement arrangement
, home equity
, hsa
, isa
, ira
, keogh
, lif
, life insurance
, line of credit
, lira
, loan
, lrif
, lrsp
, money market
, mortgage
, mutual fund
, non-custodial wallet
, non-taxable brokerage account
, other
, other insurance
, other annuity
, overdraft
, paypal
, payroll
, pension
, prepaid
, prif
, profit sharing plan
, rdsp
, resp
, retirement
, rlif
, roth
, roth 401k
, rrif
, rrsp
, sarsep
, savings
, sep ira
, simple ira
, sipp
, stock plan
, student
, thrift savings plan
, tfsa
, trust
, ugma
, utma
, variable annuity
verification_status
pending_automatic_verification
: The Item is pending automatic verificationpending_manual_verification
: The Item is pending manual micro-deposit verification. Items remain in this state until the user successfully verifies the micro-deposit.automatically_verified
: The Item has successfully been automatically verified manually_verified
: The Item has successfully been manually verifiedverification_expired
: Plaid was unable to automatically verify the deposit within 7 calendar days and will no longer attempt to validate the Item. Users may retry by submitting their information again through Link.verification_failed
: The Item failed manual micro-deposit verification because the user exhausted all 3 verification attempts. Users may retry by submitting their information again through Link.database_matched
: The Item has successfully been verified using Plaid's data sources.database_insights_pass
: The Item's ACH numbers have been verified using Plaid's data sources and have strong signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_pass_with_caution
: The Item's ACH numbers have been verified using Plaid's data sources and have some signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.database_insights_fail
: The Item's ACH numbers have been verified using Plaid's data sources and have signal for being invalid and/or have no signal for being valid. Note: Database Insights is currently a beta feature, please contact your account manager for more information.automatically_verified
, pending_automatic_verification
, pending_manual_verification
, manually_verified
, verification_expired
, verification_failed
, database_matched
, database_insights_pass
, database_insights_pass_with_caution
, database_insights_fail
verification_insights
network_status
has_numbers_match
is_numbers_match _verified
previous_returns
has_previous _administrative_return
account_number_format
valid
: indicates that the account number has a correct format for the institution.invalid
: indicates that the account number has an incorrect format for the institution.unknown
: indicates that there was not enough information to determine whether the format is correct for the institution.valid
, invalid
, unknown
persistent_account_id
holder_category
business
, personal
, unrecognized
item
item_id
item_id
is always unique; linking the same account at the same institution twice will result in two Items with different item_id
values. Like all Plaid identifiers, the item_id
is case-sensitive.institution_id
null
for Items created via Same Day Micro-deposits.created_at
webhook
error
error_code
and categorized by error_type
. Use these in preference to HTTP status codes to identify and handle specific errors. HTTP status codes are set and provide the broadest categorization of errors: 4xx codes are for developer- or user-related errors, and 5xx codes are for Plaid-related errors, and the status will be 2xx in non-error cases. An Item with a non-null
error object will only be part of an API response when calling /item/get
to view Item status. Otherwise, error fields will be null
if no error has occurred; if an error has occurred, an error code will be returned instead.error_type
INVALID_REQUEST
, INVALID_RESULT
, INVALID_INPUT
, INSTITUTION_ERROR
, RATE_LIMIT_EXCEEDED
, API_ERROR
, ITEM_ERROR
, ASSET_REPORT_ERROR
, RECAPTCHA_ERROR
, OAUTH_ERROR
, PAYMENT_ERROR
, BANK_TRANSFER_ERROR
, INCOME_VERIFICATION_ERROR
, MICRODEPOSITS_ERROR
, SANDBOX_ERROR
, PARTNER_ERROR
, TRANSACTIONS_ERROR
, TRANSACTION_ERROR
, TRANSFER_ERROR
error_code
error_code_reason
null
will be returned otherwise. Safe for programmatic use.Possible values:
OAUTH_INVALID_TOKEN
: The user’s OAuth connection to this institution has been invalidated.OAUTH_CONSENT_EXPIRED
: The user's access consent for this OAuth connection to this institution has expired.OAUTH_REVOKED_TOKEN
: The user’s OAuth connection to this institution is invalid because the user revoked their connection.error_message
display_message
null
if the error is not related to user action.This may change over time and is not safe for programmatic use.
request_id
causes
causes
will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified.causes
will only be provided for the error_type
ASSET_REPORT_ERROR
. causes
will also not be populated inside an error nested within a warning
object.status
documentation_url
suggested_action
available_products
billed_products
.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
billed_products
available_products
. Note - billed_products
is populated in all environments but only requests in Production are billed. Also note that products that are billed on a pay-per-call basis rather than a pay-per-Item basis, such as balance
, will not appear here.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
products
billed_products
field. For some products, it is possible for the product to be added to an Item but not yet billed (e.g. Assets, before /asset_report/create
has been called, or Auth or Identity when added as Optional Products but before their endpoints have been called), in which case the product may appear in products
but not in billed_products
.assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, payment_initiation
, identity_verification
, transactions
, credit_details
, income
, income_verification
, standing_orders
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, profile
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_network_insights
, cra_cashflow_insights
, layer
, pay_by_bank
consented_products
assets
, auth
, balance
, balance_plus
, beacon
, identity
, identity_match
, investments
, investments_auth
, liabilities
, transactions
, income
, income_verification
, transfer
, employment
, recurring_transactions
, signal
, statements
, processor_payments
, processor_identity
, cra_base_report
, cra_income_insights
, cra_partner_insights
, cra_cashflow_insights
, layer
consented_use_cases
You can see the full list of use cases or update the list of use cases to request at any time via the Link Customization section of the Plaid Dashboard.
consented_data_scopes
consented_products
; see the full mapping of data scopes and products.account_and_balance_info
, contact_info
, account_and_routing_numbers
, transactions
, credit_and_loans
, investments
, bank_statements
, risk_info
consent_expiration _time
date-time
update_type
background
- Item can be updated in the backgrounduser_present_required
- Item requires user interaction to be updatedbackground
, user_present_required
request_id
1{2 "accounts": [3 {4 "account_id": "BxBXxLj1m4HMXBm9WZZmCWVbPjX16EHwv99vp",5 "balances": {6 "available": 100,7 "current": 110,8 "iso_currency_code": "USD",9 "limit": null,10 "unofficial_currency_code": null11 },12 "holder_category": "personal",13 "mask": "0000",14 "name": "Plaid Checking",15 "official_name": "Plaid Gold Standard 0% Interest Checking",16 "persistent_account_id": "8cfb8beb89b774ee43b090625f0d61d0814322b43bff984eaf60386e",17 "subtype": "checking",18 "type": "depository"19 },20 {21 "account_id": "dVzbVMLjrxTnLjX4G66XUp5GLklm4oiZy88yK",22 "balances": {23 "available": null,24 "current": 410,25 "iso_currency_code": "USD",26 "limit": 2000,27 "unofficial_currency_code": null28 },29 "mask": "3333",30 "name": "Plaid Credit Card",31 "official_name": "Plaid Diamond 12.5% APR Interest Credit Card",32 "subtype": "credit card",33 "type": "credit"34 },35 {36 "account_id": "Pp1Vpkl9w8sajvK6oEEKtr7vZxBnGpf7LxxLE",37 "balances": {38 "available": null,39 "current": 65262,40 "iso_currency_code": "USD",41 "limit": null,42 "unofficial_currency_code": null43 },44 "mask": "7777",45 "name": "Plaid Student Loan",46 "official_name": null,47 "subtype": "student",48 "type": "loan"49 }50 ],51 "item": {52 "available_products": [53 "balance",54 "identity",55 "investments"56 ],57 "billed_products": [58 "assets",59 "auth",60 "liabilities",61 "transactions"62 ],63 "consent_expiration_time": null,64 "error": null,65 "institution_id": "ins_3",66 "item_id": "eVBnVMp7zdTJLkRNr33Rs6zr7KNJqBFL9DrE6",67 "update_type": "background",68 "webhook": "https://www.genericwebhookurl.com/webhook"69 },70 "request_id": "qk5Bxes3gDfv4F2"71}