POST /credit/payroll_income/refresh

/credit/payroll_income/refresh refreshes a given digital payroll income verification.

Servers

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

options Object No

An optional object for /credit/payroll_income/refresh request options.

options.item_ids[] Array No

An array of item_ids to be refreshed. Each item_id should uniquely identify a payroll income item. If this field is not provided, all item_ids associated with the user_token will be refreshed.

options.webhook String No

The URL where Plaid will send the payroll income refresh webhook.

secret String No

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.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.