Skip to main content

GetAccountByIdResponse

Response model of get account by id request.

    account

    object

    Account details object.

    resourceId stringnullable

    This shall be filled, if addressable resource are created by the ASPSP on the /accounts endpoint.

    iban stringnullable

    Possible values: Value must match regular expression [A-Z]{2,2}[0-9]{2,2}[a-zA-Z0-9]{1,30}

    IBAN of the account.

    bban stringnullable

    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

    currency stringrequired

    Possible values: non-empty, Value must match regular expression [A-Z]{3}

    Account Currency Code.

    name stringnullable

    Account name.

    ownerName stringnullable

    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.

    ownerNames

    object[]

    nullable

    List of owner names.

  • Array [

  • name stringnullable

    Account owner name.

    role AccountOwnerRole (string)

    Possible values: [owner, legalRepresentative, authorisedUser]

    The role of account owner

  • ]

  • product stringnullable

    Product name of the bank for this account, proprietary definition.

    cashAccountType stringnullable

    ExternalCashAccountType1Code from ISO 20022.

    status AccountStatus (string)

    Possible values: [enabled, deleted, blocked]

    Account Status.

    bic stringnullable

    The BIC associated to the account.

    _links

    object

    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.

    balances

    object

    Link to a resource.

    href stringnullable

    href Entry.

    transactions

    object

    Link to a resource.

    href stringnullable

    href Entry.