These endpoints provide account information services and functions for creating and querying consents.
Read the identifiers of the available payment account together with
booking balance information, depending on the consent granted. It is
assumed that a consent of the PSU to this access is already given and
stored on the ASPSP system. The addressed list of accounts depends then
on the PSU ID and the stored consent addressed by consentId. Returns all
identifiers of the accounts, to which an account access has been granted
to through the /consents
endpoint by the PSU. In addition,
relevant information about the accounts and hyperlinks to corresponding
account information resources are provided if a related consent has been
already granted.
name | type | description | default |
---|---|---|---|
Consent-ID | header | n/a | |
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
X-Request-ID | header | n/a | |
withBalance | query | n/a |
code | condition |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method Not Allowed |
406 | Not Acceptable |
408 | Request Timeout |
409 | Conflict |
415 | Unsupported Media Type |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
media type | data type | description |
---|---|---|
application/json | AccountList (JSON) | |
application/problem+json | AccountList (JSON) |
name | description |
---|---|
X-Request-ID | ID of the request, unique to the call, as determined by the initiating party. |
This method creates a consent resource, defining access rights to dedicated
accounts of a PSU. There are two ways to create a consent. Either the
accounts must be explicitly specified as parameters within the
access
structure. Alternatively, it is possible to pass the
parameters accounts
, balances
and
transactions
empty. In this case, the PSU can make a selection
from its accounts after authentication within the redirect UI. The accounts
for which a consent has been issued can subsequently be retrieved by the TPP
via GET
.
It is not possible to accept access rights on all available accounts
(parameters availableAccounts
and allPsd2
will be
ignored).
It is not necessary to pass a PSU identifier (the corresponding values will be ignored). The identification of the PSU takes place when the SCA is executed.
Since the authentication process is implicitly started, the parameter
TPP-Redirect-URI
is always mandatory.
Side Effects: When this Consent Request is a request where
the recurringIndicator
equals true
, and if it
exists already a former consent for recurring access on account information
for the addressed PSU, then the former consent automatically expires as soon
as the new consent request is authorised by the PSU.
name | type | description | default |
---|---|---|---|
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
TPP-Nok-Redirect-URI | header | n/a | |
TPP-Redirect-URI | header | n/a | |
X-Request-ID | header | n/a |
media type | data type |
---|---|
application/json | Consents (JSON) |
code | condition |
---|---|
201 | Created |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method Not Allowed |
406 | Not Acceptable |
408 | Request Timeout |
409 | Conflict |
415 | Unsupported Media Type |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
media type | data type | description |
---|---|---|
application/json | ConsentsResponse201 (JSON) | |
application/problem+json | ConsentsResponse201 (JSON) |
name | description |
---|---|
X-Request-ID | ID of the request, unique to the call, as determined by the initiating party. |
Location | Location of the created resource. |
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.
name | type | description | default |
---|---|---|---|
Consent-ID | header | n/a | |
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
X-Request-ID | header | n/a | |
account-id | path | n/a | |
withBalance | query | n/a |
code | condition |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method Not Allowed |
406 | Not Acceptable |
408 | Request Timeout |
409 | Conflict |
415 | Unsupported Media Type |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
media type | data type | description |
---|---|---|
application/json | AccountDetails (JSON) | |
application/problem+json | AccountDetails (JSON) |
name | description |
---|---|
X-Request-ID | ID of the request, unique to the call, as determined by the initiating party. |
The TPP can delete an account information consent object if needed.
name | type | description | default |
---|---|---|---|
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
X-Request-ID | header | n/a | |
consentId | path | n/a |
code | condition |
---|---|
204 | No Content |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method Not Allowed |
406 | Not Acceptable |
408 | Request Timeout |
409 | Conflict |
415 | Unsupported Media Type |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
name | description |
---|---|
X-Request-ID | ID of the request, unique to the call, as determined by the initiating party. |
Returns the content of an account information consent object. This is returning the data for the TPP especially in cases, where the consent was directly managed between ASPSP and PSU e.g. in a re-direct SCA Approach.
name | type | description | default |
---|---|---|---|
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
X-Request-ID | header | n/a | |
consentId | path | n/a |
code | condition |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method Not Allowed |
406 | Not Acceptable |
408 | Request Timeout |
409 | Conflict |
415 | Unsupported Media Type |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
media type | data type | description |
---|---|---|
application/json | ConsentInformationResponse200Json (JSON) | |
application/problem+json | ConsentInformationResponse200Json (JSON) |
name | description |
---|---|
X-Request-ID | ID of the request, unique to the call, as determined by the initiating party. |
Reads account data including balances from a given account addressed by
{account-id}
.
name | type | description | default |
---|---|---|---|
Consent-ID | header | n/a | |
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
X-Request-ID | header | n/a | |
account-id | path | n/a |
code | condition |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method Not Allowed |
406 | Not Acceptable |
408 | Request Timeout |
409 | Conflict |
415 | Unsupported Media Type |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
media type | data type | description |
---|---|---|
application/json | ReadAccountBalanceResponse200 (JSON) | |
application/problem+json | ReadAccountBalanceResponse200 (JSON) |
name | description |
---|---|
X-Request-ID | ID of the request, unique to the call, as determined by the initiating party. |
Read transaction lists of a given account addressed by
{account-id}
, depending on the steering parameter
bookingStatus
; together with balances. For a given account,
additional parameters are e.g. the attributes dateFrom
and
dateTo
.
Valid values for the parameter bookingStatus
are:
If bookingStatus
equals "information", the service will
return standing order reports. In this case the query parameters
dateFrom
and dateTo
aren't supported.
name | type | description | default |
---|---|---|---|
Consent-ID | header | n/a | |
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
X-Request-ID | header | n/a | |
account-id | path | n/a | |
bookingStatus | query | n/a | |
dateFrom | query | n/a | |
dateTo | query | n/a | |
deltaList | query | n/a | |
entryReferenceFrom | query | n/a | |
page | query | n/a | |
pageSize | query | n/a | |
withBalance | query | n/a |
code | condition |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method Not Allowed |
406 | Not Acceptable |
408 | Request Timeout |
409 | Conflict |
415 | Unsupported Media Type |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
media type | data type | description |
---|---|---|
application/json | TransactionsResponse200Json (JSON) | |
application/problem+json | TransactionsResponse200Json (JSON) | |
application/text | object | |
application/xml | object |
name | description |
---|---|
X-Request-ID | ID of the request, unique to the call, as determined by the initiating party. |
Return a list of all authorisation sub-resource IDs which have been created. This function returns an array of hyperlinks to all generated authorisation sub-resources.
name | type | description | default |
---|---|---|---|
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
X-Request-ID | header | n/a | |
consentId | path | n/a |
code | condition |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method Not Allowed |
406 | Not Acceptable |
408 | Request Timeout |
409 | Conflict |
415 | Unsupported Media Type |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
media type | data type | description |
---|---|---|
application/json | Authorisations (JSON) | |
application/problem+json | Authorisations (JSON) |
name | description |
---|---|
X-Request-ID | ID of the request, unique to the call, as determined by the initiating party. |
Create an authorisation sub-resource and start the authorisation process of a consent. The usage of this access method is unnecessary and will be denied since the authorisation process is implicitly started.
name | type | description | default |
---|---|---|---|
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
TPP-Nok-Redirect-URI | header | n/a | |
TPP-Redirect-URI | header | n/a | |
X-Request-ID | header | n/a | |
consentId | path | n/a |
media type | data type |
---|---|
application/json | object (JSON) |
code | condition |
---|---|
405 | Method Not Allowed |
media type | data type | description |
---|---|---|
application/json | Error405NGAIS (JSON) | |
application/problem+json | Error405NGAIS (JSON) |
Read the status of an account information consent resource addressed by
{consentId}
.
name | type | description | default |
---|---|---|---|
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
X-Request-ID | header | n/a | |
consentId | path | n/a |
code | condition |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method Not Allowed |
406 | Not Acceptable |
408 | Request Timeout |
409 | Conflict |
415 | Unsupported Media Type |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
media type | data type | description |
---|---|---|
application/json | ConsentStatusResponse200 (JSON) | |
application/problem+json | ConsentStatusResponse200 (JSON) |
name | description |
---|---|
X-Request-ID | ID of the request, unique to the call, as determined by the initiating party. |
This method returns the SCA status of a consent initiation's authorisation sub-resource.
name | type | description | default |
---|---|---|---|
PSU-Accept-Language | header | n/a | |
PSU-IP-Address | header | n/a | |
X-Request-ID | header | n/a | |
authorisationId | path | n/a | |
consentId | path | n/a |
code | condition |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
405 | Method Not Allowed |
406 | Not Acceptable |
408 | Request Timeout |
409 | Conflict |
415 | Unsupported Media Type |
429 | Too Many Requests |
500 | Internal Server Error |
503 | Service Unavailable |
media type | data type | description |
---|---|---|
application/json | ScaStatusResponse (JSON) | |
application/problem+json | ScaStatusResponse (JSON) |
name | description |
---|---|
X-Request-ID | ID of the request, unique to the call, as determined by the initiating party. |