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.

This endpoint requires a valid Authorization: Bearer <token> header. Requests without a valid token return 401 Unauthorized.

​
GET /api/openfinance/products

Returns all financial products — accounts, credit cards, and loans — pulled from the user’s connected Open Finance providers. Products are populated or refreshed by calling POST /api/openfinance/sync/{connectionId}.

​
Response

​
id
string
required
Unique product identifier (UUID).
​
connectionId
string
required
UUID of the connection this product belongs to.
​
provider
string
required
Name of the provider that reported this product, e.g., "BBVA".
​
productType
string
required
Type of financial product, e.g., "checking", "savings", "credit_card", "loan".
​
name
string
required
Display name of the product as reported by the provider.
​
balance
number
required
Current balance as of the last sync.
​
currency
string
required
ISO 4217 currency code, e.g., "MXN".
​
nextPaymentAmount
number
Next scheduled payment amount (applicable to loans or credit cards), if available.
​
nextPaymentDate
string
Date of the next scheduled payment in ISO 8601 date format, if applicable.
​
lastSync
string
required
ISO 8601 timestamp of when this product’s data was last refreshed.
curl --request GET \
  --url http://localhost:5000/api/openfinance/products \
  --header 'Authorization: Bearer <token>'
Response
[
  {
    "id": "prod-uuid",
    "connectionId": "conn-uuid",
    "provider": "BBVA",
    "productType": "checking",
    "name": "Cuenta de débito",
    "balance": 8500.00,
    "currency": "MXN",
    "nextPaymentAmount": null,
    "nextPaymentDate": null,
    "lastSync": "2026-03-17T10:00:00Z"
  }
]

Build docs developers (and LLMs) love

Get started for freeTalk to us