ofOpen Finance Guide
GlossarySTETBlogContact
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: AccountResource

    PSU account that is made available to the TPP. The ASPSP is able to set up specific accounts in order to provide card transactions with a delayed debit. This account must be specific to a given card. Consequently, when the card is renewed, a new account will be set up. ASPSP might also set-up different accounts for one given card but with different imputation dates. The remanence of these accounts is up to the ASPSP but must be equal or greater than the one which is provided through the Web-Banking interface. Case a payment card is blocked, any relevant information (balances, transactions...) that is available through the ASPSP PSU-interfaces must also be available through the API till the end of remanence period.

    • workspaceWorkspace

      Some ASPSP may provide different user workspaces that can be accessed by the same authenticated PSU. In this case, the AISP is able to retrieve the different pieces of account information by specifying the relevant workspace as a QUERY parameter. Identification of the workspace to be used when processing the request. If not present, the default workspace to be used is the one that is linked to the authentication processed during the OAuth2 access token request.

      Schema: Workspace

      Some ASPSP may provide different user workspaces that can be accessed by the same authenticated PSU. In this case, the AISP is able to retrieve the different pieces of account information by specifying the relevant workspace as a QUERY parameter. Identification of the workspace to be used when processing the request. If not present, the default workspace to be used is the one that is linked to the authentication processed during the OAuth2 access token request.

      • identificationstringrequired

        identification of the workspace to be used as an optional query parameter for some AISP queries

        Constraints: maxLength: 32

      • labelstringrequired

        textual description of the workspace as specified by the ASPSP in relationship wth the PSU

        Constraints: maxLength: 128

    • resourceIdResourceId

      API: Identifier assigned by the ASPSP for further use of the created resource through API calls.

      Schema: ResourceId

      API: Identifier assigned by the ASPSP for further use of the created resource through API calls. The API client cannot set or modify the value of this field. Since this value can be exchanged between the server and the client as an URL element or for support information, it must not contain sensitive value such as personal or business data. However it is the duty of each ASPSP to perform its own risk analysis on this topic.

      Type: string

      Constraints: pattern: `^([a-zA-Z0-9_ /\-?:\()\.,']{1,100})$`

    • bicFistring

      ISO20022: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)".

      ISO20022: Code allocated to a financial institution by the ISO 9362 Registration Authority as described in ISO 9362 "Banking - Banking telecommunication messages - Business identification code (BIC)".

      Constraints: pattern: `^[A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}$`

    • accountIdAccountIdentification

      Unique and unambiguous identification for the account between the account owner and the account servicer.

      Schema: AccountIdentification

      Unique and unambiguous identification for the account between the account owner and the account servicer. Card accounts must provide the identification of the card through the "other" substructure by giving, for instance, the masked PAN (MPAN). The currency used for the account, when needed, can be specified through the [currency] field.

      • workspacestring

        Workspace to which the account is linked.

        Workspace to which the account is linked. This workspace might be specified by the AISP when forwarding the consent on accounts. If not provided, the default workspace is computed from the authentication that was used for getting the OAuth2 Access Token.

        Constraints: maxLength: 32

      • ibanstring

        ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.

        ISO20022: International Bank Account Number (IBAN) - identification used internationally by financial institutions to uniquely identify the account of a customer.

        Further specifications of the format and content of the IBAN can be found in the standard ISO 13616 "Banking and related financial services - International Bank Account Number (IBAN)" version 1997-10-01, or later revisions.

        Constraints: pattern: `^[A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}$`

      • otherGenericIdentification

        ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer.

        Schema: GenericIdentification

        ISO20022: Unique identification of an account, a person or an organisation, as assigned by an issuer. API: The ASPSP will document which account reference type it will support.

        • identificationstringrequired

          API: Identifier

          API: Identifier

          Constraints: maxLength: 70

        • schemeNamestringrequired

          Name of the identification scheme.

          Name of the identification scheme. Possible values for the scheme name, partially based on ISO20022 external code list, are the following:

          CodeNameDescription
          BANKBankPartyIdentificationUnique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
          BBANBBANIdentifierBasic Bank Account Number (BBAN) - identifier used nationally by financial institutions, ie, in individual countries, generally as part of a National Account Numbering Scheme(s), to uniquely identify the account of a customer.
          COIDCountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)
          SRENSIRENThe SIREN number is a 9 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation in France.
          SRETSIRETThe SIRET number is a 14 digit code assigned by INSEE, the French National Institute for Statistics and Economic Studies, to identify an organisation unit in France. It consists of the SIREN number, followed by a five digit classification number, to identify the local geographical unit of that entity.
          NIDNNationalIdentityNumberNumber assigned by an authority to identify the national identity number of a person.
          Other values are also permitted, for instance:
          CodeNameDescription
          -------------------
          OAUTOAUTH2OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
          CPANCardPanCard PAN
          MPANMaskedPanCard PAN where some digits were replaced for security reason
          TPANTokenizedPanToken which was provided by a Token Service Provider (TSP) in order to obfuscate a real card PAN. The TSP must be identified in the issuer field
          TBANTokenizedIBANToken which was provided by a Token Service Provider (TSP) in order to obfuscate an IBAN. The TSP must be identified in the issuer field
          Each implementation of the STET PSD2 API must specify in its own documentation which schemes can actually been used

          Constraints: maxLength: 70

        • issuerstring

          ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

          ISO20022: Entity that assigns the identification. this could a country code or any organisation name or identifier that can be recognized by both parties

          Constraints: maxLength: 35

      • currencyCurrencyCodeISO 4217

        Specifies the currency of the amount or of the account.

        Schema: CurrencyCode

        Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

        Type: string

        Constraints: pattern: `^[A-Z]{3,3}$`

    • namestringrequired

      Label of the PSU account

      Label of the PSU account In case of a delayed debit card transaction set, the name shall specify the holder name and can also provide the imputation date

      Constraints: maxLength: 70

    • detailsstring

      Specifications that might be provided by the ASPSP

      Specifications that might be provided by the ASPSP

      • characteristics of the account
      • characteristics of the relevant card

      Constraints: maxLength: 140

    • linkedAccountstring

      Case of a set of pending card transactions, the ASPSP will provide the relevant cash account the card is set up on.

      Case of a set of pending card transactions, the ASPSP will provide the relevant cash account the card is set up on. When used, this field must be valued with the resourceId of the relevant cash account.

      Constraints: maxLength: 70

    • usagestringenum · 2

      Specifies the usage of the account

      Specifies the usage of the account Case of a set of pending card transactions, this field does not have to be set since the usage is inherited from the linked account.

      CodeDescription
      PRIV
      		Private personal account
      ORGA
      		Professional account
    • cashAccountTypestringrequiredenum · 2

      Specifies the type of the account

      CodeDescription
      CACC
      		Cash account
      CARD
      		List of card based transactions
    • productstring

      Product Name of the Bank for this account, proprietary definition

      Product Name of the Bank for this account, proprietary definition

      Constraints: maxLength: 35

    • balancesarray<BalanceResource>

      list of balances provided by the ASPSP

      Item: BalanceResource

      Structure of an account balance

      • namestringrequired

        Label of the balance

        Constraints: maxLength: 70

      • balanceAmountAmountTyperequired

        Structure aiming to embed the amount and the currency to be used.

        Schema: AmountType

        Structure aiming to embed the amount and the currency to be used.

        • amountnumber (float)required

          ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

          ISO20022: Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party.

          Constraints: pattern: `^\-{0,1}[0-9]{1,13}(\.[0-9]{0,5}){0,1}$`

        • currencyCurrencyCodeISO 4217required

          Specifies the currency of the amount or of the account.

          Schema: CurrencyCode

          Specifies the currency of the amount or of the account. A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds".

          Type: string

          Constraints: pattern: `^[A-Z]{3,3}$`

      • balanceTypeBalanceStatusrequired

        Type of balance

        Schema: BalanceStatus

        CodeNameDescription
        CLBD
        		ISO20022 ClosingBookedBalance 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.
        PRCD
        		ISO20022 PreviouslyClosedBookedBalance of the account at the previously closed account reporting period. The opening booked balance for the new period has to be equal to this balance. Usage: the previously booked closing balance should equal (inclusive date) the booked closing balance of the date it references and equal the actual booked opening balance of the current date.
        ITAV
        		ISO20022 InterimAvailableAvailable 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.
        XPCD
        		ISO20022 ExpectedBalance, 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.
        VALU
        		(None)Value-date balance
        OTHR
        		(None)Other Balance
      • lastChangeDateTimestring (date-time)ISO 8601

        Timestamp of the last change of the balance amount

      • referenceDatestring (date-time)ISO 8601

        Reference date for the balance

      • lastCommittedTransactionstring

        Identification of the last committed transaction. This is actually useful for instant balance.

        Identification of the last committed transaction. This is actually useful for instant balance.

        Constraints: maxLength: 40

    • psuStatusPsuStatusType

      ISO20022: Specifies the type of account ownership.

      Schema: PsuStatusType

      ISO20022: Specifies the type of account ownership.

      NameDescription
      Account HolderPerson which is the sole holder of the account.
      Account Co-HolderPerson which shares with others the holding of the account.
      AttorneyGeneric case of a person having a mandate to access the account data.
      Custodian For MinorEntity that holds shares/units on behalf of a legal minor. Although the account is registered under the name of the minor, the custodian retains control of the account.
      Legal GuardianEntity that was appointed by a legal authority to act on behalf of a person judged to be incapacitated.
      NomineeEntity named by the beneficial owner to act on its behalf, often to facilitate dealing, or to conceal the identity of the beneficiary.
      Successor On DeathDeceased's estate, or successor, to whom the respective percentage of ownership will be transferred upon the death of one of the owners.
      TrusteeLegal owners of the property. However, the beneficiary has the equitable or beneficial ownership.

      Type: string

      Constraints: maxLength: 35