Read Account List | More APIs

GET /v1/accounts {query-parameters}

Read the identifiers of the available payment account together with 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.

Query parameters

Attribute	Type	Condition	Description
withBalance	Boolean	Optional	If contained, this response will include the booking balance, if granted by the PSU in the related consent and available by the ASPSP. Parameter might be ignored.

Request headers

Attribute	Type	Condition	Description
X-Request-ID	UUID	Mandatory	ID of the request, unique to the call, as determined by the initiating party (TPP).
Consent-ID	UUID	Mandatory	The consentId of the related AIS consent.
Authorization	String	Mandatory	The oAuth2 Bearer token obtained from the performed SCA performed prior to this request.
API-Key	String	Mandatory	Consumer key available on the developers portal.
PSU-IP-Address	String	Optional	The forwarded IP address header field consists of the corresponding http request IP address field between PSU and TPP.
PSU-IP-Port	String	Optional	The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
PSU-Device-ID	String	Optional	UUID (Universally Unique Identifier) for a device, which is used by the PSU if available. UUID identifies either a device or a device dependent application installation. In case of an installation identification this ID needs to be unaltered until removal from device.
PSU-Geo-Location	String	Optional	The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Request body

No request body

Response Code

HTTP Response Code 200 (OK).

Response headers

Attribute	Type	Condition	Description
X-Request-ID	UUID	Mandatory	ID of the request, unique to the call, as determined by the initiating party (TPP).

Response body

Attribute

Type

Condition

Description

accounts

Array of

Account

Objects

Mandatory

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

pagination

Pagination

Mandatory

Pagination information about the returned results.

Example

Request

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'

import requests

url = "https://mp-psd2-api.mypos.com/v1/accounts"

headers = {
    'API-Key': "aGDmxHAmpMWUL1txqCsjEcOS",
    'X-Request-ID': "a552babc-7081-44e7-9361-61eb17e0bfd9",
    'Authorization': "Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X"
}

response = requests.request("GET", url, headers=headers)

print(response.text)

var request = require("request");

var options = { method: 'GET',
  url: 'https://mp-psd2-api.mypos.com/v1/accounts',
  headers: {
    'Authorization': 'Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X',
    'X-Request-ID': 'a552babc-7081-44e7-9361-61eb17e0bfd9',
    'API-Key': 'aGDmxHAmpMWUL1txqCsjEcOS'
  }
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});

<?php

$request = new HttpRequest();
$request->setUrl('https://mp-psd2-api.mypos.com/v1/accounts');
$request->setMethod(HTTP_METH_GET);

$request->setHeaders(array(
  'Authorization' => 'Bearer oqeeWzoYfqkf1RsfyaB3hyNiLvY7GNAV6Kta7sGa9X',
  'X-Request-ID' => 'a552babc-7081-44e7-9361-61eb17e0bfd9',
  'API-Key' => 'aGDmxHAmpMWUL1txqCsjEcOS'
));

try {
  $response = $request->send();

  echo $response->getBody();
} catch (HttpException $ex) {
  echo $ex;
}

Response

{
    "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
    }
}