v1
latestOpenAPI 3.0.1Creative Commons Attribution 4.0 International Public License2026-07-1334289536.7 KBRead account details
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.
NOTE: The account-id can represent a multicurrency account. In this case the currency code is set to "XXX".
Give detailed information about the addressed account.
Give detailed information about the addressed account together with balance information
Path parameters
This identification is denoting the addressed account, where the transaction has been performed.
This identification is denoting the addressed (card) account. The account-id is retrieved by using a "Read Account List" or "Read Card Account list" call. The account-id is the "resourceId" attribute of the account structure. Its value is constant at least throughout the lifecycle of a given consent.
Query parameters
If contained, this function reads the list of accessible payment accounts including the booking balance, if granted by the PSU in the related consent and available by the ASPSP. This parameter might be ignored by the ASPSP.
Headers
ID of the request, unique to the call, as determined by the initiating party.
Is contained if and only if the "Signature" element is contained in the header of the request.
A signature of the request by the TPP on application level. This might be mandated by ASPSP.
The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.
ID of the corresponding consent object as returned by an account information consent request.
This then contains the consentId of the related AIS consent, which was performed prior to this payment initiation.
The forwarded IP Address header field consists of the corresponding HTTP request IP Address field between PSU and TPP. It shall be contained if and only if this request was actively initiated by the PSU.
The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.
The forwarded Agent header field of the HTTP request between PSU and TPP, if available.
HTTP method used at the PSU ? TPP interface, if available. Valid values are:
- GET
- POST
- PUT
- PATCH
- DELETE
UUID (Universally Unique Identifier) for a device, which is used by the PSU, if available. UUID identifies either a device or a device dependant application installation. In case of an installation identification this ID needs to be unaltered until removal from device.
The forwarded Geo Location of the corresponding http request between PSU and TPP if available.
Response
OK
Example response
{
"account": {
"iban": "FR7612345987650123456789014",
"bban": "BARC12345612345678",
"msisdn": "+49 170 1234567",
"currency": "EUR",
"bic": "AAAADEBBXXX",
"balances": [
{
"balanceAmount": {
"currency": "EUR",
"amount": "123"
}
}
],
"_links": {
"balances": {
"href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
},
"transactions": {
"href": "/v1/payments/swiss-sepa-credit-transfers/1234-wertiq-983"
}
},
"ownerName": "John Doe"
}
}