---
title: "HalAccounts"
canonical: "https://openfinanceguide.com/en/stet/1.6.3/resources/hal-accounts"
edition: "STET PSD2 API 1.6.3.1"
source: "https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.2-openapi.yaml"
pdf: "https://openfinanceguide.com/docs/stet/1.6.3/pdf/api-dsp2-stet-v1.6.3.1-part-2-functional-model.pdf"
language: "en"
normative: "The normative text is the English PDF and OpenAPI file published by STET. This Markdown reproduces it for reading; where they differ, the PDF prevails."
license: "CC BY 3.0 FR (https://creativecommons.org/licenses/by/3.0/fr/), STET. Converted to Markdown by Open Finance Guide."
---

# HalAccounts

Type: `object` · Kind: Hal

HYPERMEDIA structure used for returning the list of the available accounts to the AISP

Fields:

- `accounts`, array of [`AccountResource`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/account-resource.md), required — List of PSU account that are made available to the TPP
- `_links`, [`AccountListLinks`](https://openfinanceguide.com/raw/stet/1.6.3/en/resources/account-list-links.md), required

## Example

```json
{
  "accounts": [
    {
      "workspace": {
        "identification": "PERSO",
        "label": "comptes personnels"
      },
      "resourceId": "Alias1",
      "bicFi": "BNKAFRPPXXX",
      "accountId": {
        "iban": "YY64COJH41059545330222956960771321",
        "currency": "EUR"
      },
      "name": "Compte de Mr et Mme Dupont",
      "usage": "PRIV",
      "cashAccountType": "CACC",
      "psuStatus": "Co-account Holder",
      "_links": {
        "balances": {
          "href": "/v1/accounts/Alias1/balances"
        },
        "transactions": {
          "href": "/v1/accounts/Alias1/transactions"
        },
        "overdrafts": {
          "href": "/v1/accounts/Alias1/overdrafts"
        }
      }
    },
    {
      "workspace": {
        "identification": "PERSO",
        "label": "comptes personnels"
      },
      "resourceId": "Alias2",
      "bicFi": "BNKAFRPPXXX",
      "accountId": {
        "iban": "YY64COJH41059545330222956960771321",
        "currency": "EUR"
      },
      "name": "Compte de Mme Dupont",
      "usage": "PRIV",
      "cashAccountType": "CACC",
      "psuStatus": "Account Holder",
      "_links": {
        "balances": {
          "href": "/v1/accounts/Alias2/balances"
        },
        "transactions": {
          "href": "/v1/accounts/Alias2/transactions"
        },
        "overdrafts": {
          "href": "/v1/accounts/Alias2/overdrafts"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "/v1/accounts"
    },
    "consents": {
      "href": "/v1/consents"
    },
    "endUserIdentity": {
      "href": "v1/end-user-identity"
    },
    "trustedBeneficiaries": {
      "href": "/v1/trusted-beneficiaries"
    }
  }
}
```

## Used by

- `GET /accounts` (accountsGet)