AccountDetails Data Type

Details about an account

Properties
name data type constraints description
resourceId string   This is the data element to be used in the path when retrieving data from a dedicated account. This shall be filled, if addressable resource are created by the ASPSP on the /accounts endpoint.
name string max size: 35, min size: 0 Name of the account given by the bank or the PSU in online-banking.
product string max size: 35, min size: 0 Product Name of the Bank for this account, proprietary definition.
cashAccountType ExternalCashAccountType1Code   ExternalCashAccountType1Code from ISO 20022.
status AccountStatus   Account status.
bic string regex: [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} Corresponding bic of the account.
linkedAccounts string max size: 70, min size: 0 Case of a set of pending card transactions, the APSP will provide the relevant cash account the card is set up on.
usage Usage   Specifies the usage of the account
details string max size: 140, min size: 0

Specifications that might be provided by the ASPSP

  • characteristics of the account
  • characteristics of the relevant card
balances array of Balance   A list of balances regarding this account, e.g. the current balance, the last booked balance. The list might be restricted to the current balance.
_links array of LinksAccountDetails  

Links to the account, which can be directly used for retrieving account information from this dedicated account.

Links to "balances" and/or "transactions"

These links are only supported, when the corresponding consent has been already granted.

Properties inherited from AccountReference
iban string regex: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30} IBAN of the account. This data element can be used in the body of the Consent Request Message for retrieving account access consent from this payment account.
bban string regex: [a-zA-Z0-9]{1,30}

Basic Bank Account Number (BBAN) Identifier

This data element can be used in the body of the Consent Request Message for retrieving Account access Consent from this Account. This data elements is used for payment Accounts which have no IBAN. ISO20022: Basic Bank Account Number (BBAN).

Identifier used nationally by financial institutions, i.e., in individual countries, generally as part of a National Account Numbering Scheme(s), which uniquely identifies the account of a customer.

pan string max size: 35, min size: 0 Primary Account Number according to ISO/IEC 7812.
maskedPan string max size: 35, min size: 0 Masked Primary Account Number
msisdn string max size: 35, min size: 0 Mobile phone number.
currency string regex: [A-Z]{3,3} Account currency. ISO 4217 Alpha 3 currency code.

Example

{
  "resourceId" : "...",
  "name" : "...",
  "product" : "...",
  "cashAccountType" : "SACC",
  "status" : "blocked",
  "bic" : "...",
  "linkedAccounts" : "...",
  "usage" : "PRIV",
  "details" : "...",
  "balances" : [ {
    "balanceAmount" : {
      "amount" : 5877.78,
      "currency" : "EUR"
    },
    "balanceType" : "closingBooked",
    "creditLimitIncluded" : true,
    "lastChangeDateTime" : 12345,
    "referenceDate" : "...",
    "lastCommittedTransaction" : "..."
  }, {
    "balanceAmount" : {
      "amount" : 12345.0,
      "currency" : "..."
    },
    "balanceType" : "authorised",
    "creditLimitIncluded" : true,
    "lastChangeDateTime" : 12345,
    "referenceDate" : "...",
    "lastCommittedTransaction" : "..."
  } ],
  "_links" : [ {
    "balances" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "transactions" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  }, {
    "balances" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    },
    "transactions" : {
      "href" : "/v1/payments/sepa-credit-transfers/1234-wertiq-983"
    }
  } ],
  "iban" : "DE27100777770209299700",
  "bban" : "BARC12345612345678",
  "pan" : "5409050000000000",
  "maskedPan" : "123456xxxxxx1234",
  "msisdn" : "+49 170 1234567",
  "currency" : "EUR"
}