POST

Create refresh intent

language https://api.araucaria.money/v1/refresh-intents

Triggers an on-demand sync for up to 10 connections. Returns a refresh intent object you can poll to track per-connection progress. Only CONNECTED or VERIFYING connections can be included.

Deduplication: connections that were successfully synced within the last hour are marked completed immediately and no new sync job is dispatched. This protects end-user bank accounts from being locked out — many banks treat repeated automated logins within a short window as suspicious and will temporarily freeze the account. If all connections fall within this window the intent is returned as completed on creation.

Billing: refresh intents are metered at $0.10 each. You are charged once per intent that actually dispatches work, not per connection in it — an intent covering five connections costs $0.10, the same as one covering a single connection.

An intent whose connections were all absorbed by the deduplication window above is not charged, because no bank request is made. Scheduled background syncs are never charged as refresh intents; this price applies only to on-demand refreshes you request through this endpoint.

Request Example

bash

curl -X POST "https://api.araucaria.money/v1/refresh-intents" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Example

200 OK

json

{
  "id": "01JXABC123DEF456GHI789JKL0",
  "status": "pending",
  "connections": [
    {
      "connectionId": "conn_01JXABC123DEF456GHI789JKL1",
      "status": "queued",
      "error": null
    },
    {
      "connectionId": "conn_01JXABC123DEF456GHI789JKL2",
      "status": "syncing",
      "error": null
    }
  ],
  "createdAt": "2026-05-06T12:00:00.000Z"
}