Skip to main content

​
Money surface

Money provides financial visibility and action recommendations.

​
Primary capabilities

  • Fetch summary metrics (cash_balance, income_30d, spending_30d)
  • Fetch prioritized action list
  • Load action-level and metric-level detail
  • Dismiss action items with reason

​
Key endpoints

  • GET /api/money/metrics
  • GET /api/money/actions
  • GET /api/money/action/detail
  • POST /api/money/action/status/set
  • GET /api/money/metric/detail

​
Request and response examples

GET /api/money/metrics?asOfDate=2026-03-03
Authorization: Bearer <accessToken>

POST /api/money/action/status/set
Content-Type: application/json
Authorization: Bearer <accessToken>

{
  "userId": "1005",
  "insightId": "12345",
  "asOfDate": "2026-03-03",
  "status": "dismissed",
  "reason": "already_handled"
}

​
Response model notes

  • asOfDate is provided for data snapshot consistency.
  • currency and card data are returned by /api/money/metrics.
  • Action list entries include priorityRank and optional badges.

​
Common error patterns

  • 401 Unauthorized: missing or expired access token
  • 400 Bad Request: invalid insightId, metricKey, or status payload
  • 404 Not Found: requested detail entity not found for current scope