Refresh intent object

The Refresh Intent object

The RefreshIntent object represents a request to update a Link or an Account with the institution’s latest data. The update includes movements. You create a RefreshIntent to trigger a refresh. The object reports whether the operation succeeded, failed, or requires multifactor authentication.

Refresh Intent Object

{
  "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"
}

The RefreshIntent object has the following attributes:

Attribute	Type	Description
`id`	`string`	Unique identifier for the `RefreshIntent`.
`object`	`string`	Identifier for the object type. Always `refresh_intent`.
`created_at`	`string`	ISO 8601 datetime in UTC when the `RefreshIntent` was created.
`new_movements`	`integer`	Number of new movements fetched by the refresh. Included only when `refreshed_object` is `account`, such as in webhook payloads.
`refreshed_object`	`string`	Type of object refreshed. One of `link` or `account`.
`refreshed_object_id`	`string`	Unique identifier for the refreshed object.
`requires_mfa`	`object`	Multifactor authentication details with the `widget_token` needed to resume the refresh in the widget. `null` when the institution does not require multifactor authentication. Included only when `refreshed_object` is `link`.
`status`	`string`	Status of the `RefreshIntent`. One of `created`, `waiting_for_action`, `requires_action`, `processing_action`, `rejected`, `failed`, `succeeded`, or `canceled`. `rejected` means the institution rejected the stored credentials.
`type`	`string`	Refresh scope. One of `historical` or `only_last`. `historical` fetches the full movement history. `only_last` fetches the most recent movements.

Fintoc API

Main Resources

Payments API

Transfers API

Movements API

Direct Debit (Legacy)

Fiscal API

Refresh intent object

The Refresh Intent object

​The Refresh Intent object

The Refresh Intent object