Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Alejandrin08/Hackathon-SPEI/llms.txt

Use this file to discover all available pages before exploring further.

The Open Finance feature lets users connect their accounts at other financial institutions so that all their accounts, cards, and loans appear alongside their B-Accesible native accounts in a single view.

Connecting an external bank

1

Navigate to Accounts

Open the Accounts view (AccountsView). A list of your current B-Accesible accounts is shown. At the bottom, tap Connect external bank.
2

Fill in connection details

Enter the provider details to connect. The form maps to the CreateConnectionDto schema.
{
  "providerName": "Banco Nacional",
  "scopes": "accounts transactions",
  "authToken": "provider-oauth-token"
}
3

Create the connection

The frontend calls POST /api/openfinance/connections. On success, the new connection object is returned and displayed in the connected banks list.
{
  "id": "conn_abc123",
  "providerName": "Banco Nacional",
  "status": "pending",
  "lastSync": "0001-01-01T00:00:00Z"
}
4

Sync the connection

Tap Sync on the new connection to pull the latest data from that institution.
POST /api/openfinance/sync/{connectionId}
The sync operation fetches current account balances, card details, and loan information.
5

View external products

After a successful sync, external accounts, cards, and loans appear in AccountsView and CardsView alongside native B-Accesible products.

Endpoints

List connections

GET /api/openfinance/connectionsReturns all external bank connections for the authenticated user.

Create connection

POST /api/openfinance/connectionsCreates a new connection to an Open Finance provider. Requires providerName, scopes, and authToken.

Delete connection

DELETE /api/openfinance/connections/{id}Removes a connection and stops data sync for that institution. Existing product data is also removed.

List products

GET /api/openfinance/productsReturns all external financial products (accounts, cards, loans) from all connected banks.

Sync connection

POST /api/openfinance/sync/{connectionId}Triggers a manual sync to pull the latest data from a specific connection.

Security

All Open Finance endpoints require a valid JWT. The user ID is extracted from the JWT token on every request — users can only read and manage their own connections and products. Cross-user data access is not possible.

Frontend views

ViewDescription
AccountsViewDisplays native and connected external bank accounts in a unified list
CardsViewDisplays native and connected external cards from all linked institutions