connections

Get all the connections of the current user

[Protected by one of the following scopes : accounts_read or transactions_read or connections_manage] Connections contain the list of information required to connect to a provider's website. This endpoint allows you to retrieve the list of all connections. You can filter them and paginate them according to different criteria

get/connections

Request

  • Base URL: https://api.linxo.com/v2
  • URL: https://api.linxo.com/v2/connections
  • Auth: OAuth (defined in the document in a form this page cannot read)

Query parameters

pagenumber

Page number in the pagination

limitnumber

Max number of connections to retrieve

statusstring

Filter connections by status. Read more about status description. One of : NONE, NEVER, RUNNING, PARTIAL_SUCCESS, SUCCESS, FAILED, AUTH_FAILED, TOO_MANY_ATTEMPTS, SERVICE_UNAVAILABLE, PASSWORD_CHANGE_REQUIRED, USER_ACTION_REQUIRED, CHALLENGE_REQUIRED, CHALLENGE_TIMED_OUT, CHALLENGE_FAILED, CHALLENGE_CANCELLED, NEEDS_SECRET, CLOSED

provider_idstring

Filter connections by provider id

Headers

Authorizationstring

Provided Bearer token following the format: 'Bearer xxxxxxxxx'

Response

Connections successfully retrieved or empty array if no connections

provider_idstring

The unique provider identifier

namestring required

Connection name, based on provider's name.

status'NONE' | 'NEVER' | 'RUNNING' | 'PARTIAL_SUCCESS' | 'SUCCESS' | 'FAILED' | 'AUTH_FAILED' | 'TOO_MANY_ATTEMPTS' | 'SERVICE_UNAVAILABLE' | 'PASSWORD_CHANGE_REQUIRED' | 'USER_ACTION_REQUIRED' | 'CHALLENGE_REQUIRED' | 'CHALLENGE_TIMED_OUT' | 'CHALLENGE_FAILED' | 'CHALLENGE_CANCELLED' | 'NEEDS_SECRET' | 'CLOSED' required

The status of the connection during its last synchronization :

  • NONE - Manual connection
  • NEVER - The connection has never been synchronized
  • RUNNING - Synchronization is in progress
  • SUCCESS - Synchronization successfully completed
  • PARTIAL_SUCCESS - Synchronization has been partially completed
  • FAILED - Synchronization failed
  • NEEDS_SECRET - Synchronization failed because no secrets have been provided during the synchronisation (only for manual accounts, not supported actually)
  • AUTH_FAILED - Authentication failed during synchronization
  • TOO_MANY_ATTEMPTS - Too many connection attempts during the authentication
  • TOKEN_EXPIRED - Authentication failed during synchronization because the user needs to renew its authorization. Read more about PSD2 renew authentication
  • SERVICE_UNAIVALABLE - The service of the provider to which the connection is trying to connect is unavailable
  • PASSWORD_CHANGE_REQUIRED - The synchronization has failed because a password change is required by the provider
  • USER_ACTION_REQUIRED - The synchronization has failed because an action is required on the provider's service (acceptance of terms and conditions, closing a popup, etc.).
  • CHALLENGE_REQUIRED - The synchronization has failed because the provider has sent a challenge (by SMS, mail, etc.) and the user was not assisting the process
  • CHALLENGE_TIMED_OUT - The synchronization has failed because the user did not answer in the allowed time
  • CHALLENGE_FAILED - The synchronization failed because the user responded incorrectly to the challenge
  • CHALLENGE_CANCELLED - The synchronization failed because the user cancelled the challenge
  • CLOSED - When a connection is closed, all existing data for this connection are preserved (accounts, transactions) but all account balances are set to 0 and no more synchronization will occur on this connection, on any of its channels.
creation_datestring date required

Creation date as UTC timestamp in seconds

last_success_datestring date

Date of the last successful synchronization as UTC timestamp in seconds

last_end_datestring date

Date of the last synchronization attempt as UTC timestamp in seconds. Only filled if the connection has been synchronized once. last_success_date and last_end_date are equal after a successful synchronization.

idstring required

The unique connection identifier.

Changes

No recorded changes to this operation across all 1 revision of this API.