Read user's consent's accounts list

get

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

Reads details about user's specific consent's accounts, with balances where required.
In case that the consent established for a non-Shekel account, so the account represent a multicurrency
account - then the currency code is set to "ILY".
For shekel accounts "currency" attribute should have a value of "ILS"

In cases where the IBAN, BBAN,MSISDN do not uniquely identify an instance of
the respective account type (e.g. a savings account), the ASPSP shall include a proprietary ID of
the respective account that uniquely identifies the account for this ASPSP

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.

consentId

string

required

length ≤ 523

Resource ID of the addressed consent.

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.

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

410Consent not found. When returned from accounts endpoints, it can also mean the related consent isn't valid nor suspended.

429Too many requests for the same resource

451The related consent is suspended, access for the data is temporarily blocked.

500Failed to fetch consent accounts list

502Failed to refresh related consent(s) status