Skip to main content
GET
Get a refresh intent

Authorizations

Authorization
string
header
required

Path Parameters

id
string
required

The id of the refresh intent to retrieve.

Query Parameters

The link_token of the link that holds the refresh intent, obtained when you exchanged the link.

Example:

"link_Q0xVGPvijElLRMwE_token_FhsFVurz5q5FycHA5xxhTpzX"

Response

The refresh intent.

id
string
required

Unique identifier of the refresh intent.

Example:

"ri_2dXqkOKkS9mOvnaW"

object
any
required

Type of the object. Always refresh_intent.

created_at
string<date-time>
required

ISO 8601 timestamp of when the refresh intent was created.

Example:

"2021-08-23T18:22:46.792Z"

public_error
enum<string> | null
required

Reason the refresh did not complete. retryable_error means you can retry the refresh. support_required_error means you need to contact Fintoc support. invalid_credentials_error means the institution rejected the credentials, so the account holder needs to reconnect the link. credentials_locked_error means the institution reports the account as locked, so the account holder needs to unlock the account with the institution before the link can refresh again. null when status is neither failed nor rejected, and when the institution did not report a reason Fintoc can map.

Available options:
retryable_error,
support_required_error,
invalid_credentials_error,
credentials_locked_error,
null
Example:

null

refreshed_object
enum<string>
required

Type of the object being refreshed. The refresh intents API always returns link refresh intents.

Available options:
link,
account
Example:

"link"

refreshed_object_id
string
required

Identifier of the object being refreshed.

Example:

"link_nzwA3XWYiZkg4ojK"

requires_mfa
object | null
required

Present when the institution requires multi-factor authentication to complete the refresh; contains the widget_token needed to resume the flow in the widget. null otherwise. Only included when refreshed_object is link.

status
enum<string>
required

Status of the refresh intent. rejected means the institution rejected the stored credentials.

Available options:
created,
waiting_for_action,
requires_action,
processing_action,
rejected,
failed,
succeeded,
canceled
Example:

"succeeded"

type
enum<string>
required

Type of the refresh. only_last fetches the most recent movements, historical fetches the full history of movements.

Available options:
only_last,
historical
Example:

"only_last"

new_movements
integer

Number of new movements the refresh fetched. Only present when refreshed_object is account (for example, in webhook payloads).

Example:

12