plaid

Retrieve Balance data

Changed on

The /processor/balance/get endpoint returns the real-time balance for the account associated with the processor token. While other endpoints may return a balance object, only /processor/balance/get forces the available and current balance fields to be refreshed rather than cached.

post/processor/balance/get

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/processor/balance/get
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

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.

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.

processor_tokenstring required

The processor token obtained from the Plaid integration partner. Processor tokens are in the format: processor-<environment>-<identifier>

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

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

    • info

      added the optional property / to the response with the status

  • e07a869352e8Revision changes
    • info

      removed the charge card enum value from the / response property for the response status

    • info

      removed the installment enum value from the / response property for the response status