POST /cashflow_report/refresh
/cashflow_report/refresh is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an item_id). The item must already have Cashflow Report added as a product in order to call /cashflow_report/refresh.
After calling /cashflow_report/refresh, Plaid will fire a webhook CASHFLOW_REPORT_READY alerting clients that new transactions data can then be ingested via /cashflow_report/get or the webhook will contain an error code informing there was an error in refreshing transactions data.
Note that the /cashflow_report/refresh endpoint is not supported for Capital One (ins_128026) non-depository accounts and will result in a PRODUCTS_NOT_SUPPORTED error if called on an Item that contains only non-depository accounts from that institution.
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 up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
days_requested |
Integer | Yes |
Number of days to retrieve transactions data for (1 to 730) Default value: 365 |
client_id |
String | No |
Your Plaid API |
access_token |
String | Yes |
The access token associated with the Item data is being requested for. |
secret |
String | No |
Your Plaid API |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.