The ASPSP shall give at least one of the account reference identifiers: - iban - bban - pan - maskedPan - msisdn If the account is a multicurrency account currency code in \"currency\" is set to \"XXX\".
name | data type | constraints | description |
---|---|---|---|
resourceId | string | This shall be filled, if addressable resource are created by the ASPSP on the /accounts or /card-accounts endpoint. | |
iban | string | regex: [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30} | IBAN of an 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. |
msisdn | string | max size: 35, min size: 0 | Mobile phone number. |
currency | string | required, regex: [A-Z]{3} | ISO 4217 Alpha 3 currency code. |
name | string | max size: 70, min size: 0 | Name of the account, as assigned by the ASPSP, in agreement with the account owner in order to provide an additional means of identification of the account. |
displayName | string | max size: 70, min size: 0 | Name of the account as defined by the PSU within online channels. |
product | string | max size: 35, min size: 0 | Product name of the bank for this account, proprietary definition. |
cashAccountType | string | ExternalCashAccountType1Code from ISO 20022. | |
status | AccountStatus | Get status | |
bic | string | regex: [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1} | BICFI |
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 | string | max size: 4, min size: 0 | Specifies the usage of the account: * PRIV: private personal account * ORGA: professional account |
details | string | max size: 500, 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 | map of object | Get links | |
ownerName | string | max size: 140, min size: 0 | Name of the legal account owner. If there is more than one owner, then e.g. two names might be noted here. For a corporate account, the corporate name is used for this attribute. Even if supported by the ASPSP, the provision of this field might depend on the fact whether an explicit consent to this specific additional account information has been given by the PSU. |
Example
{ "resourceId" : "...", "iban" : "...", "bban" : "...", "msisdn" : "...", "currency" : "...", "name" : "...", "displayName" : "...", "product" : "...", "cashAccountType" : "...", "status" : "DELETED", "bic" : "...", "linkedAccounts" : "...", "usage" : "...", "details" : "...", "balances" : [ { "balanceAmount" : { "currency" : "...", "amount" : "..." }, "balanceType" : "INTERIMAVAILABLE", "creditLimitIncluded" : true, "lastChangeDateTime" : 12345, "referenceDate" : "...", "lastCommittedTransaction" : "..." }, { "balanceAmount" : { "currency" : "...", "amount" : "..." }, "balanceType" : "INTERIMAVAILABLE", "creditLimitIncluded" : true, "lastChangeDateTime" : 12345, "referenceDate" : "...", "lastCommittedTransaction" : "..." } ], "_links" : { "property1" : { }, "property2" : { } }, "ownerName" : "..." }