---
title: "List of accounts"
method: GET
path: "/accounts"
tags: ["Accounts"]
---

# List of accounts

`GET /accounts`

You can see the list of accounts of a connection.

## Query parameters

- `customer_id` string — the `id` of the customer containing the accounts, required unless `connection_id` parameter is sent. It will be ignored if `connection_id` is present
- `from_id` string — the `id` of the account which the list starts with
- `connection_id` string, required — the `id` of the connection whose attempts are to be fetched

## Response `200`

OK

- AccountsResponse
  - `data` Account[]
    - `id` string, required — the `id` of the account
    - `name` string, required — the unique name of the account <strong>Note:</strong> The name directly identifies the account. In case the account’s name has changed (in the bank’s WEB/API interface, through code changes, etc.) a new account will be created.
    - `nature` 'account' | 'bonus' | 'card' | 'checking' | 'credit' | 'credit_card' | 'debit_card' | 'ewallet' | 'insurance' | 'investment' | 'loan' | 'mortgage' | 'savings', required — the type of the account <strong>Note:</strong> for `credit_card` nature, the balance represents the sum of all negative transactions, the positive ones do not count.
    - `balance` number, required — the account's current balance
    - `currency_code` string, required — one of the possible values for [currency codes](#currencies). Maximum 3 letters. <strong>Note:</strong> The currency directly identifies the account. In case the account’s currency code has changed (in the bank’s WEB/API interface, through code changes, etc.) a new account will be created.
    - `extra` AccountExtra, required
      - `account_name` string — changeable name of the account.
      - `account_number` string — internal bank account number.
      - `assets` string[] — array of crypto codes and their amounts assigned to investment account.
      - `available_amount` number — available amount in the account's currency.
      - `balance_type` string — __Examples:__ `interimAvailable`, `closingBooked`, `interimBooked`, `authorised`, `expected`, `BOOKED`, `CLAV`, `CLBD`, `XPCD`, `OTHR`, etc. __Note:__ The value is specific to the financial institution and can vary depending on the API standard, the bank's implementation, the account's type, country/region peculiarities, etc. This field holds an informative meaning. Usually, it is used to verify the balance consistency between customers of the same bank or between banks within the same country.
      - `blocked_amount` number — the amount currently blocked in account's currency.
      - `card_type` 'american_express' | 'china_unionpay' | 'diners_club' | 'jcb' | 'maestro' | 'master_card' | 'uatp' | 'visa' | 'mir' — type of the `card` account.
      - `cards` string[] — list of masked card numbers linked to the account.
      - `client_name` string — account client owner.
      - `closing_balance` number — account balance at the end of an accounting period.
      - `credit_limit` number — maximum amount of money that is allowed to be spent in account's currency.
      - `current_date` string, date — date of provider statement generation (applicable to banks).
      - `current_time` string, date-time — time of provider statement generation (applicable to banks).
      - `expiry_date` string, date — card expiry date.
      - `iban` string — account's IBAN.
      - `bban` string — Basic Bank Account Number.
      - `interest_rate` number — interest rate of the account as percentage value.
      - `interest_type` string — type of account interest used with interest_rate.
      - `floating_interest_rate` object — minimum and maximum value of the interest rate.
        - `min_value` number
        - `max_value` number
      - `remaining_payments` number — the number of remaining payments to pay off the loan.
      - `penalty_amount` number — the amount of the penalty.
      - `next_payment_amount` number — next payment amount for loans or credits.
      - `next_payment_date` string, date — next payment date for loans or credits.
      - `open_date` string, date — the date when any type of account/card was opened.
      - `opening_balance` number — account balance that is brought forward from the end of one accounting period to the beginning of a new accounting period.
      - `partial` boolean — account transactions were not imported or imported partially because of some internal error on the provider's side.
      - `provider_account_id` string — a unique ID assigned by the Provider to identify an account within its system.
      - `raw_balance` string — - The original account balance response returned by the bank. - It is added only for `regulated: true` providers. - It is returned only if the separate `balances` parameter is present in the bank's original response.
      - `sort_code` string — routing number(US)/BSB code(Australia)/sort code(UK).
      - `statement_cut_date` string, date — date when current statement becomes previous one.
      - `status` string — shows whether the account is `active`, `inactive` or `unauthorized`.
      - `swift` string — account SWIFT code.
      - `total_payment_amount` number — total payment amount for loans or credits.
      - `transactions_count` object — number of transactions, separated by posted and pending.
        - `posted` integer
        - `pending` integer
      - `payment_type` string — account payment method.
      - `cashback_amount` number — accumulated CashBack / Cash Benefit.
      - `monthly_total_payment` number — the amount a borrower was paid for a month.
      - `minimum_payment` number — the lowest amount you can pay on your credit card to avoid penalties.
      - `premium_frequency` string — frequency of premium payments.
      - `policy_status` string — current policy status.
      - `life_assured_name` string — name of the person who is assured.
      - `premium_amount` number — premium amount to be paid.
      - `single_premium_amount` number — single premium amount to be paid.
      - `financial_consultant` string — financial consultant name.
      - `total_reversionary_bonus` number — reversionary bonus accumulated amount.
      - `gross_surrender` number — current Gross Surrender value.
      - `guaranteed_gross_surrender` number — guaranteed Gross Surrender value.
      - `reversionary_bonus_cash_value` number — cash value of reversionary bonus.
      - `owned_policy_amount` number — amount currently own on policy.
      - `policy_loan_limit` number — maximum amount of additional Policy Loan.
      - `policy_converted_to_paid_up` number — new assured sum if Policy is converted to paid up.
      - `paid_up_conversion_reversionary_bonus` number — reversionary bonus amount after `Policy to paid up` conversion.
      - `policy_components` object — policy components with own values such as `status`, `amount_assured`, `amount_premium`, `start_date`, `expiry_date`, `premium_expiry_date`, `assured_name`.
      - `investment_amount` number — total invested amount.
      - `unit_price` number — price per unit (used with units).
      - `units` number — amount of units owned (used with unit_price).
      - `indicative_unit_price` number — indicative price per unit (used with units).
      - `interest_income` number — amount of interest income/profit.
      - `interest_amount` number — interest amount in currency.
      - `profit_amount` number — amount of profit/loss of investment account.
      - `profit_rate` number — investment account rate of profit/loss as percentage value.
      - `asset_class` string — class of investment asset.
      - `product_type` string — investment product type.
      - `total_unit_value` number — total units value of fund holding.
      - `fund_holdings` object — fund holdings list with own values such as `investment_percentage`, `balance`, `bid_price`, `value`, `value_date`, `total_quantity`, `available_quantity`, `actual_price`, `actual_value`.
    - `connection_id` string, required — the `id` of the connection the account belongs to
    - `created_at` string, date-time, required — time and date when the account was imported
    - `updated_at` string, date-time, required — the last time when the account's balance was changed or new transactions were imported
  - `meta` MetaObject — Metaobject that contains information about pagination.
    - `next_id` string
    - `next_page` string

## Other responses

- `404` — We could not find a connection with the requested `connection_id`

---

[API](https://skmtc.net/saltedge/apis/salt-edge-account-information-api.md) · [All operations](https://skmtc.net/saltedge/apis/salt-edge-account-information-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/saltedge/salt-edge-account-information-api/versions/f18f4f36d0b3/schema)