get/accounts

Item: AccountResource

• 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.

  Type: string

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

• 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.

  • 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:

      • BANK (BankPartyIdentification): Unique and unambiguous assignment made by a specific bank or similar financial institution to identify a relationship as defined between the bank and its client.
      • COID (CountryIdentificationCode) : Country authority given organisation identification (e.g., corporate registration number)
      • SREN (SIREN): The 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.
      • SRET (SIRET): The 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.
      • NIDN (NationalIdentityNumber): Number assigned by an authority to identify the national identity number of a person. Other values are also permitted, for instance:
      • OAUT (OAUTH2): OAUTH2 access token that is owned by the PISP being also an AISP and that can be used in order to identify the PSU
      • CPAN (CardPan): Card PAN 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

    Currency used for 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 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.

  Constraints: maxLength: 70

• usagestringenum · 2

  Specifies the usage of the account

  Specifies the usage of the account

  • PRIV: private personal account
  • ORGA: professional account

  Code
  PRIV
  ORGA

• cashAccountTypestringrequiredenum · 2

  Specifies the type of the account

  Specifies the type of the account

  • CACC: Cash account
  • CARD: List of card based transactions

  Code
  CACC
  CARD

• 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.

    • 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}$`

    • amountstringrequired

      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}$`

  • balanceTypeBalanceStatusrequired

    Type of balance

    Schema: BalanceStatus

    Code
    CLBD
    XPCD
    VALU
    OTHR

  • lastChangeDateTimestring (date-time)ISO 8601

    Timestamp of the last change of the balance amount

  • referenceDatestring (date)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

• psuStatusstring

  Relationship between the PSU and the account - Account Holder - Co-account Holder - Attorney

  Constraints: maxLength: 35

• _linksAccountLinksrequired

  links that can be used for further navigation when browsing Account Information at one account level

  Schema: AccountLinks

  links that can be used for further navigation when browsing Account Information at one account level

  • balances: link to the balances of a given account
  • transactions: link to the transactions of a given account

  • balancesGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used

      Constraints: maxLength: 140

    • templatedboolean

      specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

  • transactionsGenericLink

    hypertext reference

    Schema: GenericLink

    hypertext reference

    • hrefstringrequired

      URI to be used

      Constraints: maxLength: 140

    • templatedboolean

      specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

Schema: PsuContextLinks

• selfGenericLinkrequired

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• endUserIdentityGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• beneficiariesGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• firstGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• lastGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• nextGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false

• prevGenericLink

  hypertext reference

  Schema: GenericLink

  hypertext reference

  • hrefstringrequired

    URI to be used

    Constraints: maxLength: 140

  • templatedboolean

    specifies "true" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false