Gets Bank Synchronization Statuses
Retrieves all bank synchronization statuses for all consumers of your program:
- UNKNOWN: The status is unknown, most of the time because the consumer hasn’t synced his/her account yet.
- DISABLED: The synchronization has been disabled for this connection.
- ERROR: Synchronization error (bad credentials and/or consumer has an action to make on his/her bank website side).
- CHALLENGE_REQUIRED: Consumer has to input a special code sent by his/her bank to acknowledge the synchronization.
- SCRAPPING: The consumer’s bank account is being synchronized.
- SUCCESS: The consumer’s bank account synchronization succeeded.
- SCA_REQUIRED: A complete SCA process must be performed by updating the connection.
- SCA_REQUIRED_AND_OTP: A complete SCA process must be performed by updating the connection.
- WEBAUTH_REQUIRED: A complete authentication process is required by updating the connection via redirect.
- WRONG_PASS: The consumer has to input their credentials because they are invalid or obsolete.
- ACTION_NEEDED: The consumer has to perform a special action in their bank website. More details are available in “error_message”.
GET
Gets Bank Synchronization Statuses
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter by last_successful_sync
the page number
Required range:
x >= 1the number of elements per page
Required range:
1 <= x <= 100Sort by given attribute
Available options:
status, last_successful_sync, -status, -last_successful_sync Filter by status
Available options:
UNKNOWN, DISABLED, ERROR, CHALLENGE_REQUIRED, SCRAPPING, SUCCESS, SCA_REQUIRED, WEBAUTH_REQUIRED, WRONG_PASS, ACTION_NEEDED, WAITING_FOR_VALIDATION Previous
Generates Bank Synchronization WebviewThis route returns a dedicated Budget Insight webview for the
specified consumer to add and synchronize a bank account.
Next
Gets Bank Synchronization Statuses