Account Information Service (AIS)

Read 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

get/v1/accounts/{account-id}

Path parameters

account-idstring required

This identification is denoting the addressed account, where the transaction has been performed.

Example:qwer3456tzui7890

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

withBalanceboolean

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

X-Request-IDstring required

ID of the request, unique to the call, as determined by the initiating party.

Digeststring

Is contained if and only if the "Signature" element is contained in the header of the request.

Signaturestring

A signature of the request by the TPP on application level. This might be mandated by ASPSP.

TPP-Signature-Certificatestring byte

The certificate used for signing the request, in base64 encoding. Must be contained if a signature is contained.

Consent-IDstring required

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.

PSU-IP-Addressstring ipv4

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.

PSU-IP-Portstring

The forwarded IP Port header field consists of the corresponding HTTP request IP Port field between PSU and TPP, if available.

PSU-Acceptstring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Charsetstring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Encodingstring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-Accept-Languagestring

The forwarded IP Accept header fields consist of the corresponding HTTP request Accept header fields between PSU and TPP, if available.

PSU-User-Agentstring

The forwarded Agent header field of the HTTP request between PSU and TPP, if available.

PSU-Http-Method'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'

HTTP method used at the PSU ? TPP interface, if available. Valid values are:

GET
POST
PUT
PATCH
DELETE

PSU-Device-IDstring

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.

PSU-Geo-Locationstring

The forwarded Geo Location of the corresponding http request between PSU and TPP if available.

Response

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"
  }
}

Changes

Changed in 4 of the 50 revisions of this API.282240

Feb 19, 20210d82c4699548316See the full diff
- ●
  added the new SCA_INVALID enum value to the // response property for the response status (media type: application/problem+json)
  response-property-enum-value-added
- ●
  added the new SCA_INVALID enum value to the response property for the response status (media type: application/problem+json)
  response-property-enum-value-added
- ●
  added the new SCA_INVALID enum value to the // response property for the response status (media type: application/json)
  response-property-enum-value-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 10, 2021b51fe6ddb1fc24165See the full diff
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the response property's maxLength was increased from 500 to 512 for the response status (media type: application/problem+json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
  response-property-max-length-increased
- ▲
  the // response property's maxLength was increased from 500 to 512 for the response status (media type: application/json)
  response-property-max-length-increased
- ●
  removed the optional property / from the response with the status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/problem+json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/problem+json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/problem+json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/problem+json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/problem+json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/problem+json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/problem+json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/json)
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status (media type: application/problem+json)
  response-optional-property-removed
- ○
  for the header request parameter PSU-Device-ID, the format was generalized from uuid to no format
  request-parameter-type-generalized
- ○
  for the header request parameter X-Request-ID, the format was generalized from uuid to no format
  request-parameter-type-generalized
- ○
  removed the SCA_INVALID enum value from the // response property for the response status (media type: application/problem+json)
  response-property-enum-value-removed
- ○
  removed the SCA_INVALID enum value from the response property for the response status (media type: application/problem+json)
  response-property-enum-value-removed
- ○
  removed the SCA_INVALID enum value from the // response property for the response status (media type: application/json)
  response-property-enum-value-removed
This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 10, 20213cc5b6a584f12319See the full diff
- ▲
  the / response property's maxLength was increased from 140 to 500 for the response status
  response-property-max-length-increased
- ▲
  the / response property's maxLength was increased from 35 to 70 for the response status
  response-property-max-length-increased
- ●
  added the new SCA_INVALID enum value to the // response property for the response status (media type: application/problem+json)
  response-property-enum-value-added
- ●
  added the new SCA_INVALID enum value to the response property for the response status (media type: application/problem+json)
  response-property-enum-value-added
- ●
  added the new SCA_INVALID enum value to the // response property for the response status (media type: application/json)
  response-property-enum-value-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status (media type: application/problem+json)
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  removed the authorised enum value from the /// response property for the response status
  response-property-enum-value-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 10, 2021f324b23056bf2See the full diff
- ▲
  for the header request parameter PSU-Device-ID, the format changed from no format to uuid
  request-parameter-type-changed
- ▲
  for the header request parameter X-Request-ID, the format changed from no format to uuid
  request-parameter-type-changed
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 50 revisions, 1 has no diff computed.

Full history