Use this to retrieve the latest financial data. Similar to when a connection is first created, the refresh resource will initiate the following series of steps to retrieve the latest financial data from the target institution:
You can check the status of each step by querying the job resource (returned when the connection is created).
Arguments | |
---|---|
id | The identifier of the connection to be refreshed. |
Returns
Returns a created job resource, if the operation succeeded. Returns an error if the post failed.
POST /users/{user.id}/connections/{connection.id}/refresh
POST /users/ea3a81/connections/8fce3b/refresh HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN
HTTP/1.1 202 Accepted
Content-Type: application/json
{
"type": "job",
"id": "61724",
"links": {
"self": "https://au-api.basiq.io/jobs/61724"
}
}