Endpoint Reference

All API key requests must include an Authorization: Bearer <token> header. See API Overview for how to generate a key.

API key access requires a Starter or higher plan. Free tier requests return 403 Forbidden. Each plan includes a monthly call quota.

Accounts

[
  {
    "id": "acc_abc123",
    "name": "Current Account",
    "type": "asset",
    "currency": "GBP",
    "balance": 2450.00,
    "subtypeId": "sub_checking",
    "subtype": {
      "id": "sub_checking",
      "name": "checking",
      "builtInId": "checking"
    },
    "starred": false,
    "archivedAt": null,
    "closingDay": null,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-03-20T14:22:00.000Z"
  }
]

{
  "id": "acc_abc123",
  "name": "Current Account",
  "type": "asset",
  "currency": "GBP",
  "balance": 2450.00,
  "subtypeId": "sub_checking",
  "subtype": {
    "id": "sub_checking",
    "name": "checking",
    "builtInId": "checking"
  },
  "starred": false,
  "archivedAt": null,
  "closingDay": null,
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-03-20T14:22:00.000Z"
}

Transactions

{
  "transactions": [
    {
      "id": "txn_abc",
      "fromAccountId": "acc_abc123",
      "toAccountId": null,
      "fromAmount": 45.00,
      "fromCurrency": "GBP",
      "toAmount": 45.00,
      "toCurrency": "GBP",
      "fxRate": null,
      "description": "Groceries",
      "date": "2024-03-15",
      "time": null,
      "trxOrigin": "api",
      "createdAt": "2024-03-15T12:30:00.000Z"
    }
  ],
  "total": 142
}

{
  "fromAccountId": "acc_abc123",
  "toAccountId": null,
  "fromAmount": 45.00,
  "fromCurrency": "GBP",
  "date": "2024-03-15",
  "description": "Groceries"
}

{
  "id": "txn_xyz",
  "installmentRuleId": null
}

Duplicate detection

Every POST /api/transactions request is checked against existing transactions before inserting. There are two levels:

Hard duplicate → 409 Conflict

If all of the following fields match an existing transaction exactly, the request is rejected and no row is inserted:

fromAccountId, toAccountId, date, time, fromAmount, fromCurrency, toAmount, toCurrency, description

null values are matched exactly — a transaction with no time only conflicts with another transaction that also has no time.

{
  "error": "Duplicate transaction",
  "existingId": "txn_abc"
}

Soft duplicate → 202 Accepted

If only date and fromAmount match an existing transaction (but the full field set does not), the transaction is inserted and flagged for review. It will appear in the Review page under Possible Duplicates, where you can choose to keep or delete it.

{
  "id": "txn_xyz",
  "installmentRuleId": null,
  "possibleDuplicateOf": "txn_abc",
  "duplicateLinkId": "dl_123"
}

A 202 response means the transaction was saved — it is not an error. Your integration should treat 201 and 202 as both successful.

For installment purchases (e.g. a credit card purchase paid in monthly instalments), include the installment fields:

fromAmount must always be the full original purchase price (not the per-installment amount).

When currentInstallment < numberOfInstallments, the response includes an installmentRuleId pointing to the newly created rule that will handle all remaining payments.

{
  "fromAccountId": "acc_credit_card",
  "toAccountId": "acc_expense",
  "fromAmount": 1200.00,
  "fromCurrency": "USD",
  "date": "2026-04-19",
  "description": "Laptop",
  "isInstallmentPayment": true,
  "numberOfInstallments": 12,
  "currentInstallment": 1,
  "yearlyInterestRate": 18.5
}

Response when an installment rule is created:

{
  "id": "txn_xyz",
  "installmentRuleId": "rule-abc123"
}

// Returns 204 No Content on success

Returns 404 Not Found if the transaction does not exist or belongs to another user.

Exchange rates

{ "rate": 0.79143 }