Read user's consent's loan account's balances

get

https://example.com/tpp/v1/users/{userId}/consents/{consentId}/loans/{loanId}/balances

Reads balances list of a specific user's loan account.
If no dateFrom nor dateTo are specified, all balances will be returned.

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

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.

loanId

string

required

length ≤ 523

Resource ID of the addressed loan.

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).

dateFrom

date

Conditional: Starting date (inclusive the date dateFrom) of the balances/transaction list.

For booked transactions, the relevant date is the booking date.

For pending transactions, the relevant date is the entry date, which may not be transparent
neither in this API nor other channels of the ASPSP.
BOI REMARK: The earliest date can be 12 months prior to "now".
In case of exception from the minimum value the response will be only for the minimum period (12 months).

dateTo

date

End date (inclusive the data dateTo) of the balances/transaction list, default is "now" if not given.

For booked transactions, the relevant date is the booking date.

For pending transactions, the relevant date is the entry date, which may not be transparent
neither in this API nor other channels of the ASPSP.
BOI-REMARK: ASPSP must support this option for account-id/transactions

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 or account 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.

500Request to an ASPSP failed

502Failed to refresh related consent(s) status