Skip to content

XS2A Use Cases

Sven Biellmann edited this page May 2, 2024 · 7 revisions

Use Case Category: My Accounts

UC1

Customer Core Use Cases

  • Show my accounts

TPP Functionality

  • Return the list of all accounts accessible for the logged in user

  • Retrieve a specific account with details

FI API Paths

  • /v[x]/accounts

(e.g. /v1/accounts where v1 is the major version 1 of the API)

Use Case Category: Account Data (balance)

UC2

Customer Core Use Cases

  • Show account data (balance) of one of my accounts

TPP Functionality

  • Retrieve account data of a specific account

FI API Paths

  • /v[x]/accounts/{accountId}/balance

(e.g. /v1/accounts/5423/balance where v1 is the major version 1 of the API and 5423 the account ID)

Use Case Category: Account Transactions

UC3

Customer Core Use Cases

  • Show transactions of one of my accounts

TPP Functionality

  • Retrieve transactions (to and from) of a specific account

  • Retrieve details of a specific transaction

FI API Paths

  • /v[x]/accounts/{accountId}/transactions

(e.g. /v1/accounts/5423/transactions where v1 is the major version 1 of the API and 5423 the account ID)