POST /credit/bank_income/refresh
/credit/bank_income/refresh refreshes the most recent bank income report data for a specific user. If the most recent bank income report is no longer valid (i.e. deleted), the endpoint will refresh the most recent valid report instead.
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 |
|---|---|---|---|
user_token |
String | Yes |
The user token associated with the User data is being requested for. |
client_id |
String | No |
Your Plaid API |
options |
Object | No |
An optional object for |
options.days_requested |
Integer | No |
How many days of data to include in the refresh. If not specified, this will default to the days requested in the most recently generated bank income report for the user. |
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.