plaid

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.

post/accounts/balance/get

Request body

access_tokenstring required

The access token associated with the Item for which data is being requested.

secretstring

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.

client_idstring

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.

Response

OK

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

Changed in 27 of the 52 revisions of this API.3157152

  • e536704a333f91See the full diff
    • added the new charge card enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new commercial line of credit enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the item/available_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the item/billed_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the item/consented_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_home_lending enum value to the item/products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new home equity loan enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new installment enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new prediction market enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the optional property accounts/items/apy to the response with the 200 status

      response-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_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new ASSETS_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new CRA_MONITORING_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new CREDIT_PROFILE_REPORT_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new ENCOMPASS_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new ENRICH_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new FRAUD_INSIGHTS_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new FREDDIE_MAC_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new LINK_DELIVERY_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new PROFILE_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new RECURRING_TRANSACTIONS_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new STATEMENTS_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSFER_RECURRING_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new TRANSFER_REFUND_ERROR enum value to the item/error/error_type response property for the response status 200

      response-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_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new IDEMPOTENCY_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new cra_qualify enum value to the item/available_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_qualify enum value to the item/billed_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_qualify enum value to the item/consented_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_qualify enum value to the item/products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the error_type response property for the response status default

      response-property-enum-value-added

    • added the new BASE_REPORT_ERROR enum value to the item/error/error_type response property for the response status 200

      response-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 checking enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new fhsa enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new protect_transactions enum value to the item/available_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new protect_transactions enum value to the item/billed_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new protect_transactions enum value to the item/consented_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new protect_transactions enum value to the item/products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new qshr enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new roth 403B enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new roth 457b enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new roth pension enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new roth profit sharing plan enum value to the accounts/items/subtype response property for the response status 200

      response-property-enum-value-added

    • added the new roth thrift savings plan enum value to the accounts/items/subtype response property for the response status 200

      response-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_score enum value to the item/available_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the item/billed_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the item/consented_products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the new cra_plaid_credit_score enum value to the item/products/items/ response property for the response status 200

      response-property-enum-value-added

    • added the optional property item/error/provided_account_subtypes to the response with the 200 status

      response-optional-property-added

    • added the optional property item/error/required_account_subtypes to the response with the 200 status

      response-optional-property-added

    • added the optional property provided_account_subtypes to the response with the default status

      response-optional-property-added

    • added the optional property required_account_subtypes to the response with the default status

      response-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_ERROR enum value from the error_type response property for the response status default

      response-property-enum-value-removed

    • removed the IDENTITY_ERROR enum value from the item/error/error_type response property for the response status 200

      response-property-enum-value-removed

  • f8b9f1a8576724See the full diff
    • added the new IDENTITY_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • added the new USER_ERROR enum value to the item/error/error_type response property for the response status 200

      response-property-enum-value-added

    • removed the cra_plaid_credit_score enum value from the item/available_products/items/ response property for the response status 200

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the item/billed_products/items/ response property for the response status 200

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the item/consented_products/items/ response property for the response status 200

      response-property-enum-value-removed

    • removed the cra_plaid_credit_score enum value from the item/products/items/ response property for the response status 200

      response-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