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

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 14 of the 53 revisions of this API.3237

Jul 22, 2026a1bbca01816013See the full diff
- ●
  added the new ASSETS_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new CRA_MONITORING_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new CREDIT_PROFILE_REPORT_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new ENCOMPASS_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new ENRICH_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new FRAUD_INSIGHTS_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new FREDDIE_MAC_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new LINK_DELIVERY_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PROFILE_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new RECURRING_TRANSACTIONS_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new STATEMENTS_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new TRANSFER_RECURRING_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new TRANSFER_REFUND_ERROR enum value to the response property for the response status
  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
Jun 25, 202680d23bfdc2e51See the full diff
- ●
  added the new IDEMPOTENCY_ERROR enum value to the response property for the response status
  response-property-enum-value-added
Jun 10, 2026fb8c3f188d8b1See the full diff
- ●
  added the new BASE_REPORT_ERROR enum value to the response property for the response status
  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
Dec 11, 2025465584b48c99112See the full diff
- ▲
  the request property type changed from no type to string
  request-property-type-changed
- ●
  removed from the request property allOf list
  request-property-all-of-removed
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the 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
Dec 1, 2025992b331d4a081See the full diff
- ○
  the request property became optional
  request-property-became-optional
Nov 19, 20254abee1c5692911See the full diff
- ●
  removed subschema #2 from the request property allOf list
  request-property-all-of-removed
- ○
  removed the IDENTITY_ERROR enum value from the response property for the response status
  response-property-enum-value-removed
Nov 12, 2025f8b9f1a857672See the full diff
- ●
  added the new IDENTITY_ERROR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new USER_ERROR enum value to the response property for the response status
  response-property-enum-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Oct 22, 2025af4b6e71d87f1See the full diff
- ●
  added the new SIGNAL_ERROR enum value to the response property for the response status
  response-property-enum-value-added
Oct 2, 202583dc2757b74e11See the full diff
- ▲
  added subschema #2 to the request property allOf list
  request-property-all-of-added
- ●
  removed subschema #2 subschema #3 from the request property allOf list
  request-property-all-of-removed
This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 2, 2025af95b7b9aa931See the full diff
- ○
  added the new optional request property
  new-optional-request-property

Full history (14 revisions)