GET /v1/accounts/{accountNumber}/balances

Read account data from a given account address by “accountNumber”

 

Path parameters

Attribute

Type

Description

accountNumber

String

The account-id is retrieved by using a Read Account List call. The accountNumber is the unique identifier of the account structure. Its value is constant.

 

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

account

Account

Object

Mandatory

Identifier of the addressed account.

balances

Array of

Balance

Objects

Mandatory

A list of balances regarding this account.

 

Example

 

Request

curl -X GET \
https://mp-psd2-api.mypos.com/v1/accounts/50044620073/balances \
-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/50044620073/balances"

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/50044620073/balances',
  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/50044620073/balances');
$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 
{
    "account": {
        "accountNumber": "50044620073",
        "iban": "BG57INTF40015004462007"
    },
    "balances": [
        {
            "amount": 4.200,
            "currency": "PLN",
            "balanceType": "available"
        }
    ]
}