Read Account List

Retrieve all payment accounts accessible under a given consent, including optional balance information.

Endpoint

GET /v1/accounts

Description

Returns identifiers and details of all payment accounts available based on the user's consent. The response includes account information such as IBAN, currency, status, and optionally balance data.

This endpoint requires an existing consent that has been authorized by the Payment Service User (PSU). The accounts returned depend on the consent scope and the OAuth2 access token used.

Request

Query Parameters

Parameter	Type	Required	Description
`withBalance`	Boolean	Optional	Include booking balance in the response (if granted in consent and available). May be ignored by the server.

Example:

GET /v1/accounts?withBalance=true

Headers

Header	Type	Required	Description
`X-Request-ID`	UUID	Mandatory	Unique identifier for this request, generated by the TPP.
`Consent-ID`	UUID	Mandatory	The consent ID from the related AIS consent authorization.
`Authorization`	String	Mandatory	OAuth2 Bearer token obtained from the SCA process. Format: `Bearer {token}`
`API-Key`	String	Mandatory	Your consumer key from the Developer Portal.
`PSU-IP-Address`	String	Optional	The IP address of the user's device (forwarded from PSU to TPP).
`PSU-IP-Port`	String	Optional	The IP port of the user's device connection (if available).
`PSU-Device-ID`	UUID	Optional	Unique identifier for the user's device or device-specific app installation.
`PSU-Geo-Location`	String	Optional	Geographic location of the user's device (if available).

Request Body

No request body is required for this endpoint.

Response

Success Response

Status Code: 200 OK

Response Headers

Header	Type	Description
`X-Request-ID`	UUID	Echo of the request ID from the original request.

Response Body

Field	Type	Description
`accounts`	Array of Account objects	List of accessible payment accounts with their details.
`pagination`	Pagination object	Information about the paginated results (page size, current page, total count).

Account Object Structure:

accountNumber - Internal account number
status - Account status (e.g., "Active")
iban - International Bank Account Number
currency - Account currency code (ISO 4217)
name - Account display name
product - Product type (e.g., "myPOS")
cashAccountType - Account classification (e.g., "E-Money")

Code Examples

curl -X GET \
https://mp-psd2-api.mypos.com/v1/accounts \
-H 'API-Key: aGDmxHAmpMWUL1txqCsjEcOS' \
-H 'Authorization: Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X' \
-H 'X-Request-ID: a552babc-7081-44e7-9361-61eb17e0bfd9' \
-H 'Consent-ID: 3c7816ee-3d51-4bf5-8ced-ece2af35d431'

Response Example

{
    "accounts": [
        {
            "accountNumber": "50044620073",
            "status": "Active",
            "iban": "BG57INTF40015004462007",
            "currency": "PLN",
            "name": "PLN Account",
            "product": "myPOS",
            "cashAccountType": "E-Money"
        },
        {
            "accountNumber": "50158636782",
            "status": "Active",
            "iban": "BG57INTF40015015863678",
            "currency": "BGN",
            "name": "nskan",
            "product": "myPOS",
            "cashAccountType": "E-Money"
        }
    ],
    "pagination": {
        "pageSize": 2,
        "page": 1,
        "total": 2
    }
}

Common Use Cases

Get All Accounts

Retrieve the full list of accounts accessible under the current consent:

GET /v1/accounts

Get Accounts with Balances

Request account information including current balances (if permitted by consent):

GET /v1/accounts?withBalance=true

The withBalance parameter only works if the consent explicitly grants access to balance information. Otherwise, the parameter may be ignored.

Important Notes

First Call Requirement

This endpoint should be the first call after obtaining a valid OAuth2 access token from the consent authorization
The returned account IDs are required for subsequent calls to balance and transaction endpoints

Consent Scope

Only accounts included in the consent authorization will be returned
Account visibility depends on user selection during the consent flow

Balance Information

Balance data is only included if:
1. The consent grants balance access
2. The withBalance=true query parameter is provided
3. The ASPSP supports balance information in this response

Next Steps

Read Account Details - Get detailed information for a specific account
Read Balance - Check account balance
Read Transaction List - View account transaction history