AccountAccess Data Type

Requested access services for a consent.

Properties
name data type description
accounts array of AccountReference Is asking for detailed account information. If the array is empty in a request, the TPP is asking for an accessible account list. This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for balances, additionalInformation sub attributes or transactions shall be empty, if used.
balances array of AccountReference Is asking for balances of the addressed accounts. If the array is empty in the request, the TPP is asking for the balances of all accessible account lists. This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for accounts, additionalInformation sub attributes or transactions shall be empty, if used.
transactions array of AccountReference Is asking for transactions of the addressed accounts. If the array is empty in the request, the TPP is asking for the transactions of all accessible account lists. This may be restricted in a PSU/ASPSP authorization dialogue. If the array is empty, also the arrays for accounts, additionalInformation sub attributes or balances shall be empty, if used.
additionalInformation AdditionalInformationAccess Get additionalInformation
availableAccounts string Optional if supported by API provider. The values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. The support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.
availableAccountsWithBalance string Optional if supported by API provider. The values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. The support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.
allPsd2 string Optional if supported by API provider. The values \"allAccounts\" and \"allAccountsWithOwnerName\" are admitted. The support of the \"allAccountsWithOwnerName\" value by the ASPSP is optional.

Example

{
  "accounts" : [ {
    "iban" : "...",
    "bban" : "...",
    "pan" : "...",
    "maskedPan" : "...",
    "msisdn" : "...",
    "currency" : "..."
  }, {
    "iban" : "...",
    "bban" : "...",
    "pan" : "...",
    "maskedPan" : "...",
    "msisdn" : "...",
    "currency" : "..."
  } ],
  "balances" : [ {
    "iban" : "...",
    "bban" : "...",
    "pan" : "...",
    "maskedPan" : "...",
    "msisdn" : "...",
    "currency" : "..."
  }, {
    "iban" : "...",
    "bban" : "...",
    "pan" : "...",
    "maskedPan" : "...",
    "msisdn" : "...",
    "currency" : "..."
  } ],
  "transactions" : [ {
    "iban" : "...",
    "bban" : "...",
    "pan" : "...",
    "maskedPan" : "...",
    "msisdn" : "...",
    "currency" : "..."
  }, {
    "iban" : "...",
    "bban" : "...",
    "pan" : "...",
    "maskedPan" : "...",
    "msisdn" : "...",
    "currency" : "..."
  } ],
  "additionalInformation" : {
    "ownerName" : [ {
      "iban" : "...",
      "bban" : "...",
      "pan" : "...",
      "maskedPan" : "...",
      "msisdn" : "...",
      "currency" : "..."
    }, {
      "iban" : "...",
      "bban" : "...",
      "pan" : "...",
      "maskedPan" : "...",
      "msisdn" : "...",
      "currency" : "..."
    } ]
  },
  "availableAccounts" : "...",
  "availableAccountsWithBalance" : "...",
  "allPsd2" : "..."
}