POST /cashflow_report/get
The /cashflow_report/get endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions.
Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in /transactions/get. For more details, see Pending and posted transactions.
Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the count and cursor parameters in conjunction with the has_more response body field to fetch all available transactions.
Note that data isn't likely to be immediately available to /cashflow_report/get. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with cashflow_report, or if it wasn't, upon the first call to /cashflow_report/refresh. To be alerted when transaction data is ready to be fetched, listen for the CASHFLOW_REPORT_READY webhook.
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) |
count |
Integer | No |
Number of transactions to fetch per call Default value: 100 |
client_id |
String | No |
Your Plaid API |
access_token |
String | Yes |
The access token associated with the Item data is being requested for. |
cursor |
String | No |
The cursor value represents the last update requested. Pass in the empty string "" in the first call. |
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.