List every connected account with masked numbers and formatted balances.

Returns {"accounts": [...]} where each entry has id, name, type (CHECKING/SAVINGS/CREDITCARD/FOREIGN/...), status, formatted_account (masked, e.g. "01-****-***4567-00"), connection (institution name, e.g. "ANZ"), balance (formatted with currency, e.g. "$2,543.21" or "USD 100.00") and currency (ISO 4217 code). balance and currency are None if the account has no balance block.

Fetch a single account by id.

Returns the same shape as one entry in list_accounts["accounts"]: id, name, type, status, formatted_account (masked), connection, balance (formatted with currency), currency.

List pending (not-yet-settled) transactions for one account.

Pending entries affect available balance immediately and can change or vanish before they settle. Returns {"account_id", "transactions": [...]} where each transaction has account_id, date (YYYY-MM-DD, NZ calendar day), description, amount (formatted in the account's currency, e.g. "-$5.50"), amount_raw (number rounded to cents; negative = debit), currency (None if the account reports none, in which case amount has no symbol), type, merchant, category and pending (always true). Pending entries have no id.

Return just the balance for an account. Cheaper than get_account.

Returns {"id", "balance", "available", "currency"} where balance and available are currency-formatted strings (e.g. "$2,543.21" or "USD 100.00") and currency is the ISO 4217 code. All three are None if the account has no balance block; available alone is None if not reported.

Trigger Akahu to fetch fresh data for every connected account.

Rate-limited by your bank. Idempotent within rate-limit windows. Use before a query that needs the freshest balance or transaction data. Requires write consent unless AKAHU_AUTOMATION_BYPASS=true. Returns {"success": bool, "message": str | None}.

Trigger Akahu to fetch fresh data for one specific account.

Rate-limited by your bank. Idempotent within rate-limit windows. Use when you only need to refresh one account (e.g. checking before a payday lookup). Requires write consent unless AKAHU_AUTOMATION_BYPASS=true.

Returns {"success": bool, "message": str | None, "account_id": str}.

List settled transactions with optional filters.

Returns {"transactions": [...], "truncated": bool} where each entry has id, account_id, date (YYYY-MM-DD, NZ calendar day), description, amount (formatted in the account's currency, e.g. "-$12.50" or "-USD 9.99"), amount_raw (number rounded to cents; negative = debit), currency (ISO code, or None when the account's currency is unknown, in which case amount has no symbol, e.g. "-1,234.50"), type, merchant (str | None), category (str | None). truncated is true when the scan stopped at the 20-page cap before reaching the end of the range; narrow the dates and call again.

Fetch one settled transaction by id.

Returns the same shape as one entry in get_transactions["transactions"].

Batch-fetch settled transactions by their ids in one request.

Useful when you have a list of transaction ids (e.g. from a prior query) and want to inspect them together. Returns {"transactions": [...]} with the same per-entry shape as get_transactions.

List all pending (not-yet-settled) transactions across the user's accounts.

Pending transactions affect available balance immediately but do not appear in get_transactions until they settle, and they can change or vanish before then. Returns {"transactions": [...]} where each entry has account_id, date (YYYY-MM-DD, NZ calendar day), description, amount (formatted in the account's currency), amount_raw, currency (None if unknown), type, merchant, category and pending (always true). Pending entries have no id.

Case-insensitive substring search across description and merchant name.

Searches settled transactions in a date window until limit matches are found. Without start_date the window is the 90 NZ days ending on end_date, or ending today. Use for free-text lookups; prefer get_transactions when filtering by account or amount. Returns {"transactions": [...], "truncated": bool} with the same shape and meaning as get_transactions.

Submit a support ticket about a transaction to Akahu staff.

Sends a ticket to a human at Akahu support. Always elicits user confirmation (not bypass-eligible); the prompt shows every value in the ticket, including the comment. Missing required values are collected before that prompt. issue_type validation:

• "DUPLICATE": requires other_transaction_id (the paired duplicate).

• "ENRICHMENT_ERROR": requires fields=[...] listing affected field names.

• "ENRICHMENT_SUGGESTION": requires fields=[...] listing suggested fields.

Returns {"success": bool, "message": str | None}.

Return identity/profile data for the connected Akahu user.

Returns {"id": str, "email": str | None, "name": str | None}, where name joins the profile's first_name and last_name when present.

Verify a name against the account holder via Akahu's identity check.

If account_id is provided, the check is scoped to that one account (POST /verify/name/{account_id}); otherwise Akahu matches against every identity source the user has connected (POST /verify/name).

Requires the appropriate Personal-App scope grant in your Akahu portal; without it Akahu returns 403 Forbidden. May incur a per-call charge from your bank. Always elicits user confirmation (not bypass-eligible).

Returns {"success": bool, "item": dict | None, "message": str | None} where item is Akahu's match-result envelope (shape documented at https://developers.akahu.nz/docs/enduring-verify-name).