Refresh intent object

The Refresh Intent object

The RefreshIntent object represents a request to update a Link or an Account with the latest institution data, including movements. You create one to trigger a refresh. It reports whether the operation succeeded, failed, or requires multi-factor authentication (MFA).

{
  "id": "ri_ml4K3O4RSvALRjnV",
  "object": "refresh_intent",
  "created_at": "2021-12-07T20:40:53.513Z",
  "new_movements": 0,
  "refreshed_object": "link",
  "refreshed_object_id": "link_aBcDeFgHiJkLmNoPqRsTuVwXyZ",
  "requires_mfa": null,
  "status": "succeeded",
  "type": "only_last"
}
AttributeTypeDescription
idstringUnique identifier for the Refresh Intent
objectstringIdentifier for the type of object. Its value for Refresh Intent will always correspond to refresh_intent
created_atstringRefresh Intent's creation date, using ISO 8601
new_movementsintegerAmount of new movements (since the last refresh). It is only present when refreshed_object is account
refreshed_objectstringIndicates the type of refreshed object. It can correspond to link or account
refreshed_object_idstringUnique identifier for the refreshed object
requires_mfaobjectCorresponds to an object with a widget_token key. If present, the account requires mfa to refresh, so you need to open the widget with the widget_token given. If null, you don't need to open the widget to request a refresh
statusstringIndicates the status of the Refresh Intent. Possible values are succeeded, failed and rejected.
typestringRefresh scope. One of historical, which looks further back in time using the institution's historical statements, or only_last, which fetches the most recent movements, including ones Fintoc has not seen yet.