Skip to main content

Consent Refresh

Once a consent is created and active it has fetched its initial set of transactions as explained in previous chapter. After this moment, there are two possibilities to refresh the transactions.

This option, which is available in our Customer Portal for every app, allows you to define an interval to automatically refresh the consent and its transactions. As shown in the image below, select the desired interval to refresh transactions. By default, option None is selected. The choice of this value cannot be done without taking into account the number of days to inactivate a consent (see Data Removal for more information).

In the example shown, configuration values chosen for both options are very close to each other and that triggers a warning message explaining why a certain combination of values might lead to problems, such as removing the consent before it can be refreshed.

Consent Auto-Synchronize

Another option to have your consents synchronized and retrieve new transactions from the provider is to initiate the process manually through a call to one of our APIs. This can be done at any time and independently of the Auto-Synchronize above but has a limit of 6 requests per day per consent. Please refer to our Refresh Consent API for more information.

Using the access token requested in the authentication chapter, request a refresh consent using endpoint:

https://api.enablenow.nl/cfa/consent/{consentId}/refresh

Use any of the following request parameters:

Parameter
Required
Description
ConsentId
Yes
The ConsentId for which we want to refresh transactions.

The response, in case of success, is empty and should come with a 202 Accepted HTTP code, which means that the refresh was correctly saved for execution.

Daily Limit​

In the event that the API for a given consent is called more that 6 times on the same day, the expected response is as shown below.

{
    "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
    "title": "Too Many Requests",
    "status": 429,
    "detail": "Daily limit of 6 requests/consent reached. Try again in 14h07."
}

As part of this process, we store the history of requests made for each consent during 7 days.

Property
Type
Availability
Description
ConsentId
UUID
Required
The unique EnableNow ID for this consent.
DateRequested
string
Required
The UTC date of the consent refresh.
RequestedBy
string
Required
An indication of who requested the refresh (e.g. API).
Status
string
Required
The current status of the consent (e.g., UPDATED).

The two last properties can have one of the following values:

RequestedBy
Description
APP
The consent has been refreshed during normal usage of the app by the customer's end-user.
API
The consent has been refreshed on-demand by the customer using the API.
PORTAL
The consent has been refreshed on-demand by the customer using the Customer Portal.
ADMIN
The consent has been refreshed on-demand by EnableNow using the Admin Portal.
AUTOSYNC
The consent has been refreshed automatically (depends on each App autosync configuration).
Status
Description
INITIALIZED
The consent refresh has been created.
UPDATED
The consent refresh finished and balance/transactions were updated.
ERROR
The consent refresh had an error.