Halobject

HalAccounts

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

Fields (2)

accountsarray<AccountResource>required
List of PSU account that are made available to the TPP
List of PSU account that are made available to the TPP
Item schema: AccountResource
_linksAccountListLinksrequired
Schema: AccountListLinks

Example

{
  "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"
    }
  }
}