1.2.Read Account Details

GET /api/v1/accounts/{accountResourceId} {query-parameters}

Reads details about an account, with balances where required. It is assumed that a consent of the PSU to this access is already given and stored on the ASPSP system. The addressed details of this account depends then on the stored consent addressed by consentId, respectively the oAuth2 access token.


Path parameters

Attribute

Type

Description

accountNumber

String

The accountNumber is retrieved by using a Read Account List call. It is part of the Account model in the response.

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

accountNumber

String

Mandatory

 The unique identifier of the account.

status

Account Status

Mandatory

The status of the account.

iban

String

Mandatory

The IBAN related to the account.

currency

String

Mandatory

The currency of the account.

name

String

Mandatory

A custom name of the account.

balance

Double

Mandatory

The available balance in the account.

product

String

Mandatory

The contractor for the account, either myPOS or iCard.

cashAccountType

String

Mandatory

E-Money.

bicSwift

String

Mandatory

The BIC/SWIFT code.

beneficiaryName

String

Mandatory

The name of the beneficirary for the account.

beneficiaryAddress

String

Mandatory

The address of the beneficiary for the account.



  • No labels