Read user's accounts list

get

https://example.com/tpp/v1/users/{userId}/accounts

Reads details about user's accounts, with balances where required for consents from all statuses exclude
"SuspendedByASPSP" (if there was an error in checking consent status, will appear in the list only consents
that were refreshed successfully within the past 3 days). Note that if there is no consents or there is only
one and we couldn't check its validity, an empty list will be returned (as opposed to the errors
of the endpoint /tpp/v1/users/{userId}/consents/{consentId}/accounts).

TPP with PSP_IC role is authorised to much less details about accounts,
all attributes that should be filtered are marked on schema AccountDetails.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

userId

string

required

ID of the addressed user. Consists of the sub + @ + tpp_id.

Query Params

preventUpdate

boolean

If contained, we won't update user's financial data (i.e. no account data requests will be made to the ASPSP).

withBalances

boolean

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.

withInvalid

boolean

If contained, we will include all consents. Otherwise, we will include only VALID consents.

transactionId

string

In case the request processing took longer than X-Request-Wait milliseconds,
this value will be used for resuming the past request.

Headers

X-Trace-Id

string

X-Request-Wait

integer

≥ 0

Defaults to 10

In case the request processing requires calls to external resources (as ASPSPs),
this value will define the maximum number of milliseconds
in which the API server will wait for all external resources' responses to complete.
If not present, the default configured duration will be used.

X-Psu-IP-Address

string

length ≤ 15

In case if end user is online, this header should be present and contain an IP address of the user.

X-Tpp-Id

string

Contains TPP name

Origin

string

Responses

200OK

401Consent insufficient meaning the consent doesn't include at least one of requested data baskets [ACCOUNTS, BALANCES, TRANSACTIONS] in order to access the addressed service.

404User not found

429Too many requests for the same resource

500Request to an ASPSP failed