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, /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.
Note: If you are getting real-time balance for the purpose of assessing the return risk of a proposed ACH transaction, it is recommended to use /signal/evaluate instead of /accounts/balance/get. /signal/evaluate returns the same real-time balance information and also provides access to Signal Rules, which provides no-code transaction business logic configuration, backtesting and recommendations for tuning your transaction acceptance logic, and the ability to easily switch between Balance and Signal Transaction Scores as needed for ultra-low-latency, ML-powered risk assessments. For more details, see the Balance documentation.
Request body
Response
OK
Changes
Changed in 27 of the 52 revisions of this API.3157152
- ●
added the new
charge cardenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
commercial line of creditenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
cra_home_lendingenum value to theitem/available_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
cra_home_lendingenum value to theitem/billed_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
cra_home_lendingenum value to theitem/consented_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
cra_home_lendingenum value to theitem/products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
home equity loanenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
installmentenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
prediction marketenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ○
added the optional property
accounts/items/apyto the response with the200statusresponse-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
ASSETS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
ASSETS_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
CRA_MONITORING_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
CRA_MONITORING_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
CREDIT_PROFILE_REPORT_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
CREDIT_PROFILE_REPORT_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
ENCOMPASS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
ENCOMPASS_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
ENRICH_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
ENRICH_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
FRAUD_INSIGHTS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
FRAUD_INSIGHTS_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
FREDDIE_MAC_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
FREDDIE_MAC_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
LINK_DELIVERY_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
LINK_DELIVERY_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
PROFILE_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
PROFILE_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
RECURRING_TRANSACTIONS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
RECURRING_TRANSACTIONS_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
STATEMENTS_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
STATEMENTS_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
TRANSFER_RECURRING_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
TRANSFER_RECURRING_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
TRANSFER_REFUND_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
TRANSFER_REFUND_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
IDEMPOTENCY_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
IDEMPOTENCY_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
cra_qualifyenum value to theitem/available_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
cra_qualifyenum value to theitem/billed_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
cra_qualifyenum value to theitem/consented_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
cra_qualifyenum value to theitem/products/items/response property for the response status200response-property-enum-value-added
- ●
- ●
added the new
BASE_REPORT_ERRORenum value to theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-added
- ●
added the new
BASE_REPORT_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
limited purpose checkingenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
- ●
added the new
fhsaenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
protect_transactionsenum value to theitem/available_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
protect_transactionsenum value to theitem/billed_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
protect_transactionsenum value to theitem/consented_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
protect_transactionsenum value to theitem/products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
qshrenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
roth 403Benum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
roth 457benum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
roth pensionenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
roth profit sharing planenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
- ●
added the new
roth thrift savings planenum value to theaccounts/items/subtyperesponse property for the response status200response-property-enum-value-added
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ●
added the new
cra_plaid_credit_scoreenum value to theitem/available_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
cra_plaid_credit_scoreenum value to theitem/billed_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
cra_plaid_credit_scoreenum value to theitem/consented_products/items/response property for the response status200response-property-enum-value-added
- ●
added the new
cra_plaid_credit_scoreenum value to theitem/products/items/response property for the response status200response-property-enum-value-added
- ●
- ○
added the optional property
item/error/provided_account_subtypesto the response with the200statusresponse-optional-property-added
- ○
added the optional property
item/error/required_account_subtypesto the response with the200statusresponse-optional-property-added
- ○
added the optional property
provided_account_subtypesto the response with thedefaultstatusresponse-optional-property-added
- ○
added the optional property
required_account_subtypesto the response with thedefaultstatusresponse-optional-property-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ○
removed the
IDENTITY_ERRORenum value from theerror_typeresponse property for the response statusdefaultresponse-property-enum-value-removed
- ○
removed the
IDENTITY_ERRORenum value from theitem/error/error_typeresponse property for the response status200response-property-enum-value-removed
- ○
- ●
added the new
IDENTITY_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ●
added the new
USER_ERRORenum value to theitem/error/error_typeresponse property for the response status200response-property-enum-value-added
- ○
removed the
cra_plaid_credit_scoreenum value from theitem/available_products/items/response property for the response status200response-property-enum-value-removed
- ○
removed the
cra_plaid_credit_scoreenum value from theitem/billed_products/items/response property for the response status200response-property-enum-value-removed
- ○
removed the
cra_plaid_credit_scoreenum value from theitem/consented_products/items/response property for the response status200response-property-enum-value-removed
- ○
removed the
cra_plaid_credit_scoreenum value from theitem/products/items/response property for the response status200response-property-enum-value-removed
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●