Refresh a user's bank income information

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.

Request Body

Required

CreditBankIncomeRefreshRequest defines the request schema for /credit/bank_income/refresh.

Parameters

client_id
string
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.
secret
string
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_token
required, string
The user token associated with the User data is being requested for.
options
object
An optional object for /credit/bank_income/refresh request options.
days_requested
integer
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.

Response

CreditBankIncomeRefreshResponse defines the response schema for /credit/bank_income/refresh.

Response Properties

request_id
required, string
A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.