Read Card Account Balance
Retrieve the balance(s) for a specific card account using the PSD2 Account Information Service API.
Endpoint
GET /v1/card-accounts/{accountNumber}/balances
Description
Returns the balance(s) for a single card account identified by accountNumber.
You must have a valid consent and OAuth2 access token for the card account. The accountNumber is obtained from the Read Card Account List endpoint.
Request
Path Parameters
| Parameter | Type | Description |
|---|---|---|
accountNumber | String | The unique card account number, retrieved from the Read Card 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 |
|---|---|---|
maskedPan | String | The masked PAN of the card. |
balances | Array of Objects | List of balances for the card account. |
Code Examples
curl -X GET \ https://mp-psd2-api.mypos.com/v1/card-accounts/50553500971/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
{
"maskedPan": "453754******2234",
"balances": [
{
"amount": 120.260,
"currency": "EUR",
"balanceType": "available"
}
]
}