Skip to main content

Read account details.

GET 
/api/v1/accounts/:account-id

Reads details about an account, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system.

NOTE: The account-id can represent a multicurrency account. In this case the currency code is set to "XXX".

Give detailed information about the addressed account.

Give detailed information about the addressed account together with balance information

Request​

Path Parameters

    account-id stringrequired

    This identification is denoting the addressed account. The account-id is retrieved by using a "Read Account List" call.

Query Parameters

    WithBalance boolean

    If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.

    Example: false

Header Parameters

    X-Request-ID uuidrequired

    ID of the request, unique to the call, as determined by the initiating party.

    Example: c66d0ad3-4089-4996-bd48-523ae3e484f7
    Consent-ID string

    This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.

    Example: 354c3126-be8c-4bcb-8cc6-0c317b8efb30
    Digest string

    Is contained if and only if the OpenBankingGateway.Models.Accounts.AISRequestHeaders.Signature element is contained in the header of the request.

    Example: SHA-256=hl1/Eps8BEQW58FJhDApwJXjGY4nr1ArGDHIT25vq6A=
    Signature string

    A signature of the request by the TPP on application level. This might be mandated by ASPSP.

    TPP-Signature-Certificate int32

    A signature of the request by the TPP on application level. This might be mandated by ASPSP.

    PSU-IP-Address string

    Possible values: Value must match regular expression \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

    The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.

    Example: 192.168.8.78
    PSU-IP-Port string

    TThe forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

    Example: 1234
    PSU-Accept string

    The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

    PSU-Accept-Charset string

    The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

    PSU-Accept-Encoding string

    The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

    PSU-Accept-Language string

    The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

    PSU-User-Agent string

    The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

    PSU-Http-Method PSUHttpMethod

    Possible values: [GET, POST, PUT, PATCH, DELETE]

    HTTP method used at the PSU ? TPP interface, if available. Valid values are:

    • GET
    • POST
    • PUT
    • PATCH
    • DELETE
    PSU-Device-ID string

    UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device.

    Example: 99435c7e-ad88-49ec-a2ad-99ddcb1f5555
    PSU-Geo-Location string

    The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

    Example: GEO:52.506931;13.144558

Responses​

Success

Response Headers

  • X-Request-ID

    string

    ID of the request, unique to the call, as determined by the initiating party.

Schema

    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.

Loading...