Read Account Details
Get detailed information about a specific payment account, including balances if requested and permitted by consent.
Endpoint
GET /v1/accounts/{accountNumber}
Description
Returns details for a single payment account identified by accountNumber. Balance information is included if requested and allowed by the user's consent.
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. |
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. |
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 |
|---|---|---|
accountNumber | String | The unique identifier of the account. |
status | Account Status | The status of the account. |
iban | String | The IBAN related to the account. |
currency | String | The currency of the account. |
name | String | A custom name of the account. |
balance | Double | The available balance in the account. |
product | String | The contractor for the account, either myPOS or iCard. |
cashAccountType | String | Account classification (e.g., "E-Money"). |
bicSwift | String | The BIC/SWIFT code. |
beneficiaryName | String | The name of the beneficiary for the account. |
beneficiaryAddress | String | The address of the beneficiary for the account. |
Code Examples
curl -X GET \ https://mp-psd2-api.mypos.com/v1/accounts/50044620073 \ -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
{
"accountNumber": "50044620073",
"status": "Active",
"iban": "BG57INTF40015004462007",
"currency": "PLN",
"name": "PLN Account",
"balance": 4.200,
"product": "myPOS",
"cashAccountType": "E-Money",
"bicSwift": "MPOSGB2L",
"beneficiaryName": "TEST",
"beneficiaryAddress": "POL, TEST, TEST TEST"
}