---
title: "Read account details"
method: GET
path: "/v1/accounts/{account-id}"
tags: ["Account Information Service (AIS)"]
---

# Read account details

`GET /v1/accounts/{account-id}`

Reads details about an account, with balances where required. 
It is assumed that a consent of the PSU to 
this access is already given and stored on the ASPSP system. 
The addressed details of this account depends then on the stored consent addressed by consentId, 
respectively the OAuth2 access token.

**NOTE:** The account-id can represent a multicurrency account.
In this case the currency code is set to "XXX".

Give detailed information about the addressed account.

Give detailed information about the addressed account together with balance information

## Path parameters

- `account-id` string, required — This identification is denoting the addressed account, where the transaction has been performed.

## Query parameters

- `withBalance` boolean

## Headers

- `X-Request-ID` string, required
- `Digest` string
- `Signature` string
- `TPP-Signature-Certificate` string, byte
- `Consent-ID` string, required — ID of the corresponding consent object as returned by an account information consent request.
- `PSU-IP-Address` string, ipv4
- `PSU-IP-Port` string
- `PSU-Accept` string
- `PSU-Accept-Charset` string
- `PSU-Accept-Encoding` string
- `PSU-Accept-Language` string
- `PSU-User-Agent` string
- `PSU-Http-Method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'
- `PSU-Device-ID` string
- `PSU-Geo-Location` string

## Response `200`

OK

- object
  - `account` AccountDetails, required — The ASPSP shall give at least one of the account reference identifiers: - iban - bban - pan - maskedPan - msisdn If the account is a multicurrency account currency code in "currency" is set to "XXX".
    - `resourceId` string — This shall be filled, if addressable resource are created by the ASPSP on the /accounts or /card-accounts endpoint.
    - `iban` string — IBAN of an account.
    - `bban` string — Basic Bank Account Number (BBAN) Identifier. This data element can be used in the body of the consent request. Message for retrieving account access consent from this account. This data elements is used for payment accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN). Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer.
    - `msisdn` string — Mobile phone number.
    - `currency` string, required — ISO 4217 Alpha 3 currency code.
    - `name` string — Name of the account, as assigned by the ASPSP, in agreement with the account owner in order to provide an additional means of identification of the account.
    - `displayName` string — Name of the account as defined by the PSU within online channels.
    - `product` string — Product name of the bank for this account, proprietary definition.
    - `cashAccountType` string — ExternalCashAccountType1Code from ISO 20022.
    - `status` 'enabled' | 'deleted' | 'blocked' — Account status. The value is one of the following: - "enabled": account is available - "deleted": account is terminated - "blocked": account is blocked e.g. for legal reasons If this field is not used, than the account is available in the sense of this specification.
    - `bic` string — BICFI
    - `linkedAccounts` string — Case of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.
    - `usage` 'PRIV' | 'ORGA' — Specifies the usage of the account: * PRIV: private personal account * ORGA: professional account
    - `details` string — Specifications that might be provided by the ASPSP: - characteristics of the account - characteristics of the relevant card
    - `balances` Balance[] — A list of balances regarding this account, e.g. the current balance, the last booked balance. The list might be restricted to the current balance.
      - `balanceAmount` Amount, required
        - `currency` string, required — ISO 4217 Alpha 3 currency code.
        - `amount` string, required — The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot. **Example:** Valid representations for EUR with up to two decimals are: * 1056 * 5768.2 * -1.50 * 5877.78
      - `balanceType` 'closingBooked' | 'expected' | 'openingBooked' | 'interimAvailable' | 'interimBooked' | 'forwardAvailable' | 'nonInvoiced', required — The following balance types are defined: - "closingBooked": Balance of the account at the end of the pre-agreed account reporting period. It is the sum of the opening booked balance at the beginning of the period and all entries booked to the account during the pre-agreed account reporting period. For card-accounts, this is composed of - invoiced, but not yet paid entries - "expected": Balance composed of booked entries and pending items known at the time of calculation, which projects the end of day balance if everything is booked on the account and no other entry is posted. For card accounts, this is composed of: - invoiced, but not yet paid entries - not yet invoiced but already booked entries and - pending items (not yet booked) For card-accounts: "money to spend with the value of a pre-approved credit limit on the card account" - "openingBooked": Book balance of the account at the beginning of the account reporting period. It always equals the closing book balance from the previous report. - "interimAvailable": Available balance calculated in the course of the account ?servicer?s business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified. For card-accounts, this is composed of: - invoiced, but not yet paid entries - not yet invoiced but already booked entries - "interimBooked": Balance calculated in the course of the account servicer's business day, at the time specified, and subject to further changes during the business day. The interim balance is calculated on the basis of booked credit and debit items during the calculation time/period specified. - "forwardAvailable": Forward available balance of money that is at the disposal of the account owner on the date specified. - "nonInvoiced": Only for card accounts, to be checked yet.
      - `creditLimitIncluded` boolean — A flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable.
      - `lastChangeDateTime` string, date-time — This data element might be used to indicate e.g. with the expected or booked balance that no action is known on the account, which is not yet booked.
      - `referenceDate` string, date — Indicates the date of the balance.
      - `lastCommittedTransaction` string — "entryReference" of the last commited transaction to support the TPP in identifying whether all PSU transactions are already known.
    - `_links` LinksAccountDetails — Links to the account, which can be directly used for retrieving account information from this dedicated account. Links to "balances" and/or "transactions" These links are only supported, when the corresponding consent has been already granted.
      - `balances` HrefType — Link to a resource.
        - `href` string — Link to a resource.
      - `transactions` HrefType — Link to a resource.
        - `href` string — Link to a resource.
    - `ownerName` string — Name of the legal account owner. If there is more than one owner, then e.g. two names might be noted here. For a corporate account, the corporate name is used for this attribute. Even if supported by the ASPSP, the provision of this field might depend on the fact whether an explicit consent to this specific additional account information has been given by the PSU.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `405` — Method Not Allowed
- `406` — Not Acceptable
- `408` — Request Timeout
- `409` — Conflict
- `415` — Unsupported Media Type
- `429` — Too Many Requests
- `500` — Internal Server Error
- `503` — Service Unavailable

---

[API](https://skmtc.net/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework.md) · [All operations](https://skmtc.net/openbankingproject-ch/apis/swiss-nextgen-banking-api-framework/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openbankingproject-ch/swiss-nextgen-banking-api-framework/revisions/c32e86db40b4/schema)