API Reference
  1. Feezback Aggregate Data API
  2. Account Information Service (AIS)

Read user's consent's card balances

get
https://example.com/tpp/v1/users//consents//cards//balances

Reads balances list of a specific user's card.
Each Aspsp can choose to get req in 1 of 2 date formats => dateFrom and dateTo OR valueDateFrom and valueDateTo.
If no dateFrom nor dateTo (or in the other form of valueDateFrom nor valueDateTo) are specified, all balances will be returned.
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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

string
required
length ≤ 523

Resource ID of the addressed consent.

string
required
length ≤ 523

Resource ID of the addressed card.

Query Params
boolean

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

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

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

string

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

Headers
string
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.

string
length ≤ 15

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

string

Contains TPP name

string
Responses

Updated about 1 month ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*

Updated about 1 month ago

Did this page help you?