accounts

Get all accounts

[Protected by one of the following scopes : accounts_manage or accounts_read or transactions_read] This endpoint allows you to retrieve the list of all accounts. The structure of an account can change depending on the type of account (LOAN, CHECKING, etc.). When no account is found, an empty array is returned. Accounts are attached to a "connection" resource that allows you to connect to a provider's website to retrieve and update account information. Accounts can be filtered with several criterias described in the description of body's request. Accounts can be sorted by name and/or creation_date. Just pass the sort parameter in the query. The parameter value is the name of field(s) separated by a comma. By default, sorting is ascending. A field can be prefixed with the sign "-" so that the sorting is descending. example sort=name,-creation_date

get/accounts

Request

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

Query parameters

typestring

Filters accounts by type. Separated by a comma (eg: LOAN,CHECKINGS), many of : CHECKINGS,SAVINGS,LOAN,CREDIT_CARD

qstring

Filters by queried value in all text fields

pagenumber

Page number in the pagination

limitnumber

Max number of accounts to retrieve

statusstring

Filters accounts by status. Read more about status description. One of : MANUAL,ACTIVE,ERROR,NOT_FOUND,CLOSED,SUSPENDED,PENDING_CONSENT

connection_idstring

Filters accounts by connection id

usagestring

Filters accounts by usage. One of : PERSONAL, PROFESSIONAL

sortstring

Sort results. Results can be sorted by name or creation_date. eg: name,-creation_date

Headers

Authorizationstring

Provided Bearer token following the format: 'Bearer xxxxxxxxx'

Response

Accounts successfully retrieved

connection_idstring required

Unique identifier of the connection providing data for this account

namestring required

Account name, built using various information (account owner, account type ... )

account_numberstring

Account number

ibanstring

IBAN when available. Some accounts do not have an IBAN. Even if an account has an IBAN, it may not be available through the API

balancenumber required

Account balance as reported during the last synchronization represented by a floating number. Balance is a signed float with the dot as separator. Example: 1000000.45

currencystring required

Currency of the account in the ISO4217 format. (3 letters. Examples : "EUR", "USD")

balance_datenumber

Date of the last balance update as UTC timestamp in seconds. This corresponds to the time when the value was read from the provider's service.

type'CHECKINGS' | 'SAVINGS' | 'LOAN' | 'CREDIT_CARD' required

Type of the account.

status'MANUAL' | 'ACTIVE' | 'ERROR' | 'NOT_FOUND' | 'CLOSED' | 'SUSPENDED' | 'PENDING_CONSENT' required

The status of the bank account during its last synchronization. The bank account status depends on the connection status

  • MANUAL - Manual bank account, belonging to a manual connection. Manual connections have status NONE. They have no channel.
  • ACTIVE - The account was synchronized successfully or we never synchronized it yet. It is linked to a SUCCESS, PARTIAL_SUCCESS or NEVER channel. In case of PARTIAL_SUCCESS, an ACTIVE account is one of the accounts synchronized successfully.
  • ERROR - Bank account is currently linked to a channel whose last synchronization ended with status FAILED, AUTH_FAILED, TOO_MANY_ATTEMPTS, TOKEN_EXPIRED, SERVICE_UNAIVALABLE, PASSWORD_CHANGE_REQUIRED, USER_ACTION_REQUIRED, CHALLENGE_REQUIRED, CHALLENGE_TIMED_OUT, CHALLENGE_FAILED, CHALLENGE_CANCELLED, or it is linked to a PARTIAL_SUCCESS channel and is one of the accounts which could not be synchronized.
  • NOT_FOUND - Bank account is currently linked to a PARTIAL_SUCCESS channel. This account could not be synchronized as it could not be found during the last synchronization.
  • CLOSED - When an account is closed, all existing data are preserved (transactions, etc), but its balance is set to 0 and no more synchronization will occur for this account. An account can be closed independently using the PUT /accounts/{id} endpoint. It can also be part of a CLOSED connection. A CLOSED connection has only CLOSED channels and CLOSED accounts. A connection can be closed using the POST /connections/{id}/close endpoint, and reopened using the POST /connections/{id}/reopen endpoint).
  • SUSPENDED - Bank account synchronization has been suspended because our system detected that it is a professional account. The account needs to be verified. For more information, read about the professional account process.
  • PENDING_CONSENT - Bank account cannot be synchronized because the PSD2 consent has not been granted. Read more about PSD2 consents.
classification'PERSONAL' | 'BUSINESS' | 'CORPORATE' | 'OTHER'

Account classification

creation_datenumber required

Date when this account first appeared as UTC timestamp in seconds.

usagestring

Owner's type: PERSONAL, PROFESSIONAL.

groupstring

Name of the user's workspace on bank website.

last_channel_definition_idstring

The unique identifier of the last channel definition associated with this account

idstring required

The unique account identifier.

Changes

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