Sign in

v1

latestOpenAPI 3.1.02026-07-228956435.8 KB
Refresh intents

Create a refresh intent

Creates a refresh intent for a link, using the link's link_token to authenticate the request. Unless the institution requires multi-factor authentication, the refresh starts asynchronously and Fintoc notifies the result through webhooks. Your organization needs the on demand refresh policy, and Fintoc rate limits consecutive refreshes (5 minutes between only_last refreshes, 60 minutes between historical ones).

post/refresh_intents

Query parameters

link_tokenstring required
Example:link_Q0xVGPvijElLRMwE_token_FhsFVurz5q5FycHA5xxhTpzX

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

refresh_type'only_last' | 'historical'

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

result_status'succeeded' | 'failed' | 'rejected'

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

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.

idstring required

Unique identifier of the refresh intent.

object'refresh_intent' required

Type of the object. Always refresh_intent.

created_atstring date-time required

ISO 8601 timestamp of when the refresh intent was created.

new_movementsinteger

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

public_error'retryable_error' | 'support_required_error' | 'null' nullable 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.

refreshed_object'link' | 'account' required

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

refreshed_object_idstring required

Identifier of the object being refreshed.

status'created' | 'waiting_for_action' | 'requires_action' | 'processing_action' | 'rejected' | 'failed' | 'succeeded' | 'canceled' required

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

type'only_last' | 'historical' required

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

Example response

{
  "id": "ri_2dXqkOKkS9mOvnaW",
  "created_at": "2021-08-23T18:22:46.792Z",
  "new_movements": 12,
  "refreshed_object": "link",
  "refreshed_object_id": "link_nzwA3XWYiZkg4ojK",
  "requires_mfa": {
    "widget_token": "ri_2dXqkOKkS9mOvnaW_sec_Q802GD8ZLmMuK0Atl4ucJuLp"
  },
  "status": "succeeded",
  "type": "only_last"
}