getTestClock

getTestClock returns the current frozen time, posted and pending synthetic transactions, and each goal's progress with its posted and upcoming contributions. C…

Last updated October 2, 2026

Task for your agent (optional)

Try a task

Preview the prompt that will be copied

Reference

Authentication: bearer token required (see how to get a token)

getTestClock returns the current frozen time, posted and pending synthetic transactions, and each goal's progress with its posted and upcoming contributions. Clocks are visible only to their creator and expire automatically.

POSThttps://api-v2.financesavi.com/rpcRequires token

cURL

bash

curl -sS --max-time 30 -X POST 'https://api-v2.financesavi.com/rpc' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Bearer $SAVI_TOKEN" \
  -d '{"jsonrpc":"2.0","method":"getTestClock","params":{"id":"tc_example"},"id":1}'

The snippets read your token from the SAVI_TOKEN environment variable, so it is never pasted into code. Run export SAVI_TOKEN=<your token> first.

Request params

{
  "id": "tc_example"
}

Bearer token

No token yet? Get one in two calls. The token stays in this tab and is only sent to api-v2.financesavi.com.

Replace the ids with your own (see listAccounts) before sending a live request.

Captured response

Local API capture (scrubbed)

$ POST https://api-v2.financesavi.com/rpc  (getTestClock)
HTTP 200

{
  "jsonrpc": "2.0",
  "result": {
    "clock": {
      "id": "tc_example",
      "status": "READY",
      "frozenTime": "2026-10-02T19:24:43.985Z",
      "maxTime": "2036-10-02T18:24:43.985Z",
      "expiresAt": "2026-10-09T18:25:43.99Z",
      "transactions": [
        {
          "id": "txn_001",
          "at": "2026-10-02T19:24:43.985Z",
          "name": "Simulated payroll",
          "amount": 2500,
          "currency": "CAD",
          "type": "INCOME",
          "source": "SIMULATED_TEST_CLOCK"
        }
      ],
      "pendingTransactions": [],
      "goals": [
        {
          "id": "goal_001",
          "name": "Emergency fund",
          "targetAmount": 1000,
          "currentAmount": 250,
          "remainingAmount": 750,
          "progressPercent": 25,
          "contributions": [
            {
              "id": "contribution_001",
              "at": "2026-10-02T19:24:43.985Z",
              "amount": 150
            }
          ],
          "upcomingContributions": [
            {
              "id": "contribution_002",
              "at": "2026-10-02T20:24:43.985Z",
              "amount": 250
            }
          ]
        }
      ]
    }
  },
  "id": 1
}

Captured from the local sf1/api service and scrubbed. This preview does not send a request.