Sign in
OpenBanking

Retrieves list of accounts from financial institution.

<b>Authorization</b>: End user or Merchant token is required.

<b>User permissions required</b>: CanConnectAccounts

get/api/v1/openbanking/accounts/{id}

Request

  • Base URL: https://api.nofrixion.com
  • URL: https://api.nofrixion.com/api/v1/openbanking/accounts/{id}
  • Auth: API key in header Authorization

Path parameters

idstring uuid required

The ConsentTokenID is the reference id to the token.

Response

OK

usageType'PERSONAL' | 'BUSINESS' | 'OTHER' | 'UNKNOWN' nullable
accountType'CASH_TRADING' | 'CASH_INCOME' | 'CASH_PAYMENT' | 'CHARGE_CARD' | 'CHARGES' | 'COMMISSION' | 'CREDIT_CARD' | 'CURRENT' | 'E_MONEY' | 'LIMITED_LIQUIDITY_SAVINGS_ACCOUNT' | 'LOAN' | 'MARGINAL_LENDING' | 'MONEY_MARKET' | 'MORTGAGE' | 'NON_RESIDENT_EXTERNAL' | 'OTHER' | 'OVERDRAFT' | 'OVERNIGHT_DEPOSIT' | 'PREPAID_CARD' | 'SALARY' | 'SAVINGS' | 'SETTLEMENT' | 'TAX' | 'UNKNOWN' nullable

The type of account e.g. (Credit Card, Savings).

idstring nullable

Unique identifier of the account.

typestring nullable

Specifies the type of account e.g. (BUSINESS_CURRENT).

descriptionstring nullable

Product name as defined by the financial institution for this account.

balancenumber double

Main or headline balance for the account. Use of this field is recommended as fallback only. Instead, use of the typed balances (accountBalances) is recommended.

currencystring nullable

Currency the bank account balance is denoted in. Specified as a 3-letter ISO 4217 currency code.

nicknamestring nullable

Nickname of the account that was provided by the account owner. May be used to aid identification of the account.

detailsstring nullable

Supplementary specifications that might be provided by the Bank. These provide further characteristics about the account.

Changes

No recorded changes to this endpoint across all 2 revisions of this API.