With the Refresh endpoints you can refresh the data from an existing LinkLink - A connection to a payroll provider used to retrieve payroll data. without requiring the user to enter their payroll credentials a second time.
To successfully perform a Refresh you need to follow these steps:
- [Optional] Subscribe to Webhooks so when a TaskTask - A process where a Link is used to pull/write data from/to a payroll provider. is completed (with a status of
done) you can pull payroll data.
- Make a POST request to the
/refresh/tasksendpoint passing in the access_tokenaccess_token - A private token unique to a single Link. Used to access Link data and initiate any actions using the same Link from the original connection.
- Use webhooks or poll backend GET endpoint to check the status of the refresh
It's important to note that each Refresh TaskTask - A process where a Link is used to pull/write data from/to a payroll provider. is billed.