Skip to main content

Read account list

GET 
/api/v1/accounts

Read the identifiers of the available payment account together with booking balance information, depending on the consent granted.

It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed list of accounts depends then on the PSU ID and the stored consent addressed by consentId, respectively the OAuth2 access token.

Returns all identifiers of the accounts, to which an account access has been granted to through the /consents endpoint by the PSU. In addition, relevant information about the accounts and hyperlinks to corresponding account information resources are provided if a related consent has been already granted.

Remark: Note that the /consents endpoint optionally offers to grant an access on all available payment accounts of a PSU. In this case, this endpoint will deliver the information about all available payment accounts of the PSU at this ASPSP.

Request​

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 stringrequired

    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

    Possible values: Value must match regular expression [\d]

    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​

OK. In case, no account is accessible, the ASPSP shall return an empty array. As this is also considered a positive response, the Response code must still be 200.

Response Headers
  • X-Request-ID string

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

Schema
    accounts object[]required

    List of accounts with details.

  • Array [
    • resourceId stringnullablerequired

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

    iban stringnullablerequired

    IBAN of the account.

    bban stringnullablerequired

    Basic Bank Account Number (BBAN) Identifier.

    currency stringrequired

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

    Account Currency Code.

    name stringnullablerequired

    Account name.

    product stringnullablerequired

    Product Name of the Bank for this account, proprietary definition.

    cashAccountType stringnullablerequired
    bic stringnullablerequired

    The BIC associated to the account.

    ownerName stringnullablerequired

    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.

    balances object[]nullable

    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.

  • Array [
    • balanceType BalanceTyperequired

    Possible values: [closingBooked, expected, openingBooked, interimAvailable, interimBooked, forwardAvailable, nonInvoiced]

    balanceAmount object

    A single balance element. For showing in transalist will only be used for Booked transactions.

    currency stringrequired

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

    Currency Code.

    amount stringrequired

    Possible values: non-empty

    The amount given with fractional digits, where fractions must be compliant to the currency definition. Up to 14 significant figures. Negative amounts are signed by minus. The decimal separator is a dot.

    creditLimitIncluded booleannullablerequired

    A flag indicating if the credit limit of the corresponding account is included in the calculation of the balance, where applicable.

  • ]
    • _links object
    balances object

    Link to a resource.

    href stringnullablerequired

    href Entry.

    transactions object

    Link to a resource.

    href stringnullablerequired

    href Entry.

  • ]
Loading...