plaid

Trigger an update for Cash Flow Updates

Use the /sandbox/cra/cashflow_updates/update endpoint to manually trigger an update for the legacy Cash Flow Updates product in the Sandbox environment. To simulate a report generation for a CRA Servicing subscription, use /sandbox/cra/servicing/simulate.

post/sandbox/cra/cashflow_updates/update

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/sandbox/cra/cashflow_updates/update
  • 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.

user_tokenstring

The user token associated with the user for which data is being requested. This field is used only by customers with pre-existing integrations that already use the user_token field. All other customers should use the user_id instead. For more details, see New User APIs.

webhook_codesCashFlowUpdatesEventWebhookCodes[] nullable

Webhook codes corresponding to the Cash Flow Updates events to be simulated.

user_idstring

A unique user identifier, created by /user/create. Integrations that began using /user/create after December 10, 2025 use this field to identify a user instead of the user_token. For more details, see New User APIs.

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