Read Account Balance

Retrieve the balance(s) for a specific payment account using the PSD2 Account Information Service API.

Endpoint

GET /v1/accounts/{accountNumber}/balances

Description

Returns the balance(s) for a single payment account identified by accountNumber.

You must have a valid consent and OAuth2 access token for the account. The accountNumber is obtained from the Read Account List endpoint.

Request

Path Parameters

Parameter	Type	Description
`accountNumber`	String	The unique account number, retrieved from the Read Account List response.

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
`account`	Object	Identifier of the addressed account.
`balances`	Array of Objects	A list of balances regarding this account.

Code Examples

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'

Response Example

{
    "account": {
        "accountNumber": "50044620073",
        "iban": "BG57INTF40015004462007"
    },
    "balances": [
        {
            "amount": 4.200,
            "currency": "PLN",
            "balanceType": "available"
        }
    ]
}