Retrieve real-time balance data
Changed onThe /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
- Base URLhttps://production.plaid.com
- URLhttps://production.plaid.com/accounts/balance/get
- Auth
- API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version
- or OAuth 2Client credentialsToken URL: https://api.plaid.com/oauth2/apiv2/token scopes: accounts:read
Request body
Response
OK
Changes
- warning
added the new
CRA_PARTNER_INSIGHTS_ERRORenum value to theresponse property for the response status - warning
added the new
CRA_PARTNER_INSIGHTS_ERRORenum value to the//response property for the response status - warning
added the new
CRA_REPORT_ERRORenum value to theresponse property for the response status - warning
added the new
CRA_REPORT_ERRORenum value to the//response property for the response status - info
added the optional property
//to the response with the status
- warning
- info
the endpoint scheme security
clientId AND secret AND plaidVersionwas added to the API - info
the endpoint scheme security
oauth2was added to the API - info
added the optional property
/to the response with the status - info
removed the
charge cardenum value from the//response property for the response status - info
removed the
installmentenum value from the//response property for the response status
- info