Skip to main content
POST
Create a refresh intent
v1 · Base URL https://api.fintoc.com/v1 Fintoc will update your accounts and notify you with the results through the webhook system.
When the update is completed successfully, you will receive the event account.refresh_intent.succeeded. After that, you can immediately request the Fintoc API for the newest bank movements.
When the update fails or the bank indicates that the credentials are invalid, you will receive the events account.refresh_intent.failed and account.refresh_intent.rejected respectively.
Some restrictions exist to request an on-demand update. For example, you can’t create a Refresh Intent if there is another one in progress. Also, if the refresh_type is of type only_last you must wait five minutes between Refresh Intents. If the refresh_type is of type historical you must wait sixty minutes between Refresh Intents.

Authorizations

Authorization
string
header
required

Query Parameters

The link_token of the link to refresh, obtained when you exchanged the link.

Example:

"link_Q0xVGPvijElLRMwE_token_FhsFVurz5q5FycHA5xxhTpzX"

refresh_type
enum<string>

The statement to refresh. only_last retrieves the provisional statement, historical retrieves the historical statement. Defaults to only_last.

Available options:
only_last,
historical
result_status
enum<string>

Result to force on the refresh intent in test mode. Has no effect in live mode.

Available options:
succeeded,
failed,
rejected

Response

Refresh intent created. If requires_mfa is null the refresh starts immediately; otherwise complete the multi-factor authentication in the widget with requires_mfa.widget_token.

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 for the failure. retryable_error means you can retry the refresh, support_required_error means you need to contact Fintoc support. null unless status is failed.

Available options:
retryable_error,
support_required_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