Skip to main content

​
Eligibility Criteria

A card must comply with certain eligibility criteria before being refreshed. For a card to be refreshed, it must satisfy the following conditions:
  • The Schedule Refresh parameter must be set to true, you can do this in Flinks Connect using scheduleRefresh and through the API endpoint setScheduleRefresh. For more information, follow the link to learn How to enable or disable the Nightly Refresh or contact your Flinks Representative.
  • The card must have had a successful refresh in the last seven days.
  • (Not applicable for Webhooks integrations) The card must have received a cached call in the past seven days.
  • The card should not have any errors during Authorization. However, if an error has occurred, the card will still be eligible for refresh if the error is one of the following:
    • RETRY_LATER
    • AGGREGATION_ERROR
    • SESSION_EXPIRED
    • DISABLED_INSTITUTION
    • UNAUTHORIZED
    • SESSION_NONEXISTENT
    • BANK MAINTENANCE_RETRY_LATER

​
Enabling Nightly Refreshes

You can enable automatic account refreshes using Nightly Refresh and Enhanced MFA.

​
Nightly Refresh

If your use case requires automatic account refresh to keep track of transactional history changes, you can enable Nightly Refresh for new accounts. For this, you need to set the scheduleRefresh parameter to true in the iframe URL.

​
Enhanced MFA

If your use case requires automatic account refresh, you can enable the Enhanced Multi-Factor Authentication (MFA) flow. To enable Nightly Refresh for new accounts, set the scheduleRefresh parameter to true in the iframe URL.

Supported only in Canada for Simple Security Questions

Enhanced MFA is only supported for Canadian institutions, and only for Simple Security Questions. This feature does not handle advanced MFA types such as 2-step verification and push notifications — those are fully supported through Flinks’ standard authentication flow via the /Authorize endpoint and Flinks Connect.For Simple Security Questions, Nightly Refresh will only succeed if the MFA answers have been stored using the /AnswerMFAQuestions endpoint.Enabling Enhanced MFA can help increase the odds that your Nightly Refresh does not fail, but it’s not a guarantee that your Nightly Refreshes will be successful 100% of the time. There may be some instances where it fails for unrelated reasons.
With Enhanced MFA enabled, an additional step will be included when a user authenticates with Flinks. First, Flinks will attempt to extract all additional MFA questions and answers, excluding the one that is commonly prompted upon first time connection. Flinks will then prompt the user to preemptively answer these additional questions. If you want to give the end user the option to skip this step, add the parameter skipEnhancedMFA into the iframe URL and set the value to true.

​
Useful Endpoints

/GetNightlyRefreshStatus: This endpoint returns a list with all of the loginIds that are set to Nightly Refresh ("isScheduledRefresh"=true), yet are no longer refreshing due to errors. The endpoint’s JSON response will clarify what error was encountered on the refresh attempt. /Authorize: This endpoint will also return the error message from the previous refresh attempt when running the batched cached calls. In cases where the JSON response doesn’t return any errors, please make sure you check the date of the latest refresh. An example can be seen in the image below: If the date of your last refresh is too long ago for your use case, please perform a manual refresh. This can be done by changing the body parameters in /Authorize and by subsequently calling our aggregation endpoints with the provided requestId. You must change the following body parameters to:
  • "MostRecentCached": false
  • "Save": true

​
Suggested daily routine

Complete the following steps in our suggested daily routine for refreshes:

​
Step 1: Check which loginIds are no longer eligible

Call the /GetNightlyRefreshStatus endpoint to identify accounts that are set to refresh but no longer meet the eligibility criteria:

​
Step 2: Handle loginIds not on the list

If any loginIds are not on the list, follow this flowchart to manually refresh them:

​
Nightly Refresh routine

The Nightly Refresh job has a daily routine. The job is scheduled to run from 4 a.m. to 8 a.m. (UTC). It will only impact all cards that meet the Eligibility Criteria.

​
Coverage

For more information about which financial institutions we support Nightly Refreshes for, contact your Flinks Representative.