QWqwist
Synchronizations

Start provider synchronization

Changed on

In order for the finX API to have up-to-date transaction and account information, it needs to query the bank servers, a process which is called synchronization. With this call you can create a new synchronization to fetch updated data from the provider. If the confidential parts of the provider credentials have not been given when creating the access they have to be send with this request. If the save_secrets flag is set to true the credentials are stored in the finX backend, so that subsequent synchronizations can be triggered without providing the credentials again.

post/rest/accesses/{access-id}/syncs

Request

Parameters

#/paths/~1rest~1accesses~1{access-id}/get/parameters/0 (unresolved $ref)

Request body

credentialsCredentials (unresolved $ref)
save_secretsboolean

Indicates whether the confidential parts of the credentials should be saved for future access synchronization operations. If set to false previously saved secrets are discarded at the end of the synchronization.

disable_notificationsboolean

Indicates whether the configured notification events are triggered at the end of the synchronization process.

redirect_uristring url

The URI to which the user is redirected at the end of a redirect based authentication flow. The state that has been specified in the request will be attached as a query parameter to the URI.

stateState (unresolved $ref)
scopestring[]

Defines the scope of the synchronization.

  • "ACCOUNTS": Only fetch basic account data (e.g. holder name, IBAN etc.). Add new provider accounts to previously synced accesses.
  • "TRANSACTIONS": Fetch transaction and account data.
reuse_auth_methodboolean

Indicates whether the last selected authentication method should be re-used for this synchronization. This minimizes the amount of challenges that have to be solved in the course of the synchronization operation.

reuse_auth_mediumboolean

Indicates whether the last selected authentication medium should be re-used for this synchronization. This minimizes the amount of challenges that have to be solved in the course of the synchronization operation.

psu_ipstring IP

The IP address of the end-user for whom the synchronization is triggered. This might be required by the provider. It is advised to provide this value whenever possible.

periodinteger

Defines the number of days of transaction history that is requested from the financial provider.

Response

Synchronization status.

idSchema required(unresolved $ref)
statusStatus required(unresolved $ref)
statestring

The state that was being provided in the request when creating the synchronization.

challengeSchema (unresolved $ref)
created_atEndedAt required(unresolved $ref)
started_atEndedAt (unresolved $ref)
ended_atEndedAt (unresolved $ref)
redirect_uristring url

The URL where users will be redirected after completing their interaction with the Widget.

Changes

  • 398592d93b1fRevision changes
    • breaking

      added the new path request parameter access-id

    • breaking

      the request property's minLength was increased from 0 to 1

    • breaking

      the request property type changed from no type to string

    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response property oneOf list for the response status

    • warning

      the request property's maxLength was set to 1024