Skip to main content

Fetch accounts list

GET 
/v1/accounts

Description​

Retrieve a list of accounts associated with a specific user or entity.

tip

Access detailed information about each account, including account numbers, currency, balance details and more.

Request​

Query Parameters

    withBalance boolean

    If included, this function reads the list of accessible payment accounts, including the booking balance. This is only granted if the PSU has given consent in the related consent and if it is available from the ASPSP.

Header Parameters

    X-Request-ID uuidrequired

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

    Certificate stringrequired

    The certificate used for signature verification.

    ClientId stringrequired

    The client ID associated with the request.

    consentID stringrequired

    The consent ID of the related consent, which was performed prior to this payment initiation.

    Ocp-Apim-Subscription-Key stringrequired

    A unique identifier related to the registered merchant in the corresponding API environment, available within the application's details.

Responses​

OK
Schema
    accounts object[]requiredA list of all the accounts associated.
  • Array [
    • iban string

    The International Bank Account Number (IBAN) associated with the account.

    bban string

    The Basic Bank Account Number (BBAN) associated with the account.

    pan string

    The Primary Account Number (PAN) associated with the account.

    maskedPan string

    The masked PAN of the account.

    msisdn string

    The MSISDN of the account.

    currency string

    The currency of the account.

    resourceId string

    The resource identifier of the account.

    name string

    The name of the account.

    product string

    The type of product that the account is associated with.

    cashAccountType string

    The type of cash account.

    status int32

    The status of the account, indicating whether the account is active or not.
    Available options:
    0 = "enabled"
    1 = "deleted"
    2 = "blocked"

    bic string

    The Bank Identifier Code (BIC) object that identifies the bank that the account is held with.

    linkedAccounts string

    A list of all the linked accounts associated with the account.

    usage int32

    The usage of the account.
    Available options:
    0 = "PRIV"(private)
    1 = "ORGA"(organization)

    details stringA list of all the details associated with the account.
    balances object[]
  • Array [
    • balanceAmount objectrequiredThe amount of funds available for the given balance type,including:
    currency string

    The currency of the balance amount.

    Amount string

    The amount of funds available for the given balance type.

    balanceType int32

    The type of the balance.
    Available options:
    0 = "closingBooked"
    1 = "expected"
    2 = "authorised"
    3 = "openingBooked"
    4 = "interimAvailable"
    5 = "interimBooked"
    6 = "forwardAvailable"
    7 = "nonInvoiced"

    creditLimitIncluded boolean

    Indicates whether the credit limit is included in the balance.

    lastChangeDateTime date-time

    The The date and time of the last change made to the account details.

    referenceDate date-time

    The date for which the account information is retrieved. If null or empty, consider that reference datetime is equivalent with the datetime that the API call has been made.

    lastCommittedTransaction string

    Information about the last committed transaction on the account.

  • ]
    • links objectLinks to related resources or endpoints that are associated with the account. These links can be used to navigate to additional information or perform specific actions related to the account.
    property name object
    href string
  • ]
Loading...