d670fe6663
* fix(enable-banking): read BBAN from AccountIdentification.other and store it on the account Enable Banking has no top-level `bban` key on AccountIdentification: a Swedish BBAN (clearing + account number) arrives as `other.identification` with `other.scheme_name = 'BBAN'`, or in `all_account_ids`. The client typed `bban?: string` and read `.bban`, so the value was always undefined: no connected account ever carried its clearing + account number, and domestic counterparty accounts on transactions were dropped. Type the identifiers per the OpenAPI spec, add extractBban() and pickAccountIdentifier(), read counterparty identifiers through the scheme list (IBAN, then BBAN/BGNR/PGNR, then anything), and store `bban` on StoredAccount from the OAuth callback. The external_id dedup scope stays IBAN-then-uid and is untouched. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UaZTY21HVN57hJoPXKSLjV * feat(invoices): named payee accounts on cash_accounts with a default per currency A company had exactly one set of payment instructions per invoice currency (company_settings.invoice_payment_accounts), picked by currency alone. A second SEK bank account, or a second bankgiro number, had nowhere to live. cash_accounts is already the per-company bank-account entity. Migration 20260903150000 adds the payee fields (bankgiro, plusgiro, clearing + account number, BBAN, BIC, Swish, foreign routing) plus invoice_payee, a small invoice_payee_defaults table (one default account per currency; one account may be the default for several currencies, a SEK account with an IBAN is the usual EUR payee), and a SECURITY DEFINER mirror that rewrites the legacy map and the SEK bank columns from the default accounts. Every existing reader (PDF, email, reminders, v1, MCP) keeps working; the three writers that only touched legacy columns (PUT /api/settings, v1 settings, MCP update_company_settings) now write through to the default account, so what an agent sets is what the PDF prints. Peppol PaymentMeans is built from the resolver instead of the raw legacy column. bg_pg is dropped (never read or written; NULL on every prod and staging row). Backfill lands only on existing cash accounts (primary, IBAN match, or the only enabled account in the currency). Entries with no target stay in the map as the resolver fallback and get an attach action in settings. New: POST /api/cash-accounts (manual bank account on the next free 19xx), PATCH /api/cash-accounts/[id] payee fields (owner/admin), GET/PUT /api/cash-accounts/payee-defaults. Settings page rewritten as an account list with per-currency defaults. Behandlingshistorik and the full archive cover the new table and columns. Verified on staging: migration applied (11 defaults landed), mirror trigger observed rewriting company_settings from a payee edit. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UaZTY21HVN57hJoPXKSLjV * feat(invoices): choose which bank account an invoice is paid to, frozen at issue Migration 20260903160000 adds invoices.payment_cash_account_id (FK to cash_accounts, SET NULL) and invoices.payment_details, the payee fields frozen when the account is chosen and refreshed at issue. Resolver: resolveInvoicePaymentAccount / companyWithInvoicePaymentAccount / assertInvoicePaymentAccountForRender take an optional override, and hasRequiredInvoicePaymentAccount reads it from the invoice row, so every surface (PDF, Swish QR, email, reminders, payment confirmation, Peppol, recurring, staged MCP send) prints the frozen payee when one exists and the company default per currency otherwise. Invoices that never chose an account behave exactly as before. Issue paths (mark-sent, send, v1 send, v1 mark-sent, Peppol send, recurring, MCP send and mark-sent) refresh the snapshot from the account as it is at issue; a chosen account that is disabled, un-flagged or unusable for the currency blocks with INVOICE_SEND_PAYMENT_ACCOUNT_INVALID. Writers: dashboard POST/PATCH, v1 create/update and MCP create_invoice accept payment_cash_account_id and validate it against the company's payee accounts (INVOICE_PAYEE_ACCOUNT_INVALID). Credit notes inherit the original's payee; copies carry the choice; preview-pdf renders the chosen account. The editor shows "Betalas till" under the currency when the company has two or more usable payee accounts for that currency. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UaZTY21HVN57hJoPXKSLjV * feat(invoices): book manual payments on the invoice's chosen bank account Manual mark-paid (dashboard, v1, MCP gnubok_mark_invoice_as_paid) and the booking dialog's proposed lines debited 1930 regardless of which bank account the invoice asked to be paid to. They now resolve the chosen payee account's ledger account (resolveInvoiceSettlementAccount) and fall back to 1930 only when no account was chosen or the row is gone. Bank-transaction matching keeps debiting the account the money landed on and does not filter by the chosen account; between equal-confidence candidates it prefers the invoice that asked to be paid to the landing account. Scores are untouched, so nothing new auto-matches. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UaZTY21HVN57hJoPXKSLjV * chore(invoices): keep the payload-size and phantom-column ceilings after the payee work Shorten the new gnubok_create_invoice argument description (tools/list payload was 29 bytes over the 60 kB budget), inline the cash-account payee UPDATE/INSERT payloads and the settings select strings as literals so the phantom-column scanner can read their columns, and reuse ACCOUNT_NUMBER_RE instead of a hand-rolled copy. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UaZTY21HVN57hJoPXKSLjV * fix(invoices): harden the payee model after review (admin-only payee columns, separate payee IBAN, company-scoped FK) Review findings from CodeRabbit, Superagent, the Swedish accounting review and three skeptic passes, resolved in one batch: Schema (both migrations are unshipped and edited in place): - cash_accounts.payee_iban: the printed IBAN is its own column. iban stays the bank identity written by every sync and used to re-pair on reconnect, so a sync can no longer rewrite an invoice instruction or resurrect a cleared IBAN. The backfill copies each currency entry verbatim onto the target account (IBAN match first, then primary), so every invoice keeps printing exactly what it printed before; the bank IBAN is never pushed onto invoices that did not carry one. - Payee columns are owner/admin-only at the database (BEFORE trigger, service role exempt): cash_accounts is member-writable for bank sync, and the SECURITY DEFINER mirror would otherwise have let a member rewrite where customers pay. - Revoking an account as payee or disabling it drops its defaults; deleting a default drops that currency from the map and clears the legacy SEK columns (an admin saying "nothing to print" must not keep printing a closed account). The mirror leaves the legacy SEK columns alone when the map has no SEK entry, so legacy-only companies are never wiped by a mirror run for another currency. - Audit and mirror triggers fire on the same column set; anon and authenticated can no longer execute the trigger-only definer functions. - invoices.payment_cash_account_id is a composite same-company FK with SET NULL scoped to the account column. Code: - Only 19xx bank accounts can be payee: PATCH, the defaults PUT (which now also requires enabled, payee-flagged and usable for the currency), resolveInvoicePayeeChoice, and the mark-paid settlement resolver (which also refuses disabled rows and logs every fallback to 1930). - createManualBankAccount excludes every ledger slot any row already holds (findFreeLedgerAccount treats a manual holder as free; this path inserts). - The legacy settings writers (PUT /api/settings, v1, MCP) write through to the account BEFORE updating company_settings and fail the request on error; the account is written before it is adopted as default so the mirror never sees an empty payee. - snapshotInvoicePayee: dry runs no longer persist; a failed snapshot write blocks issue (INVOICE_PAYEE_SNAPSHOT_FAILED). v1 mark-sent/mark-paid projections carry the payee columns; v1 create validates the payee before the dry-run return and echoes it in the preview. - pickAccountIdentifier: supplementary IBAN wins over a primary BBAN, and non-account schemes (card PANs) are never persisted. - Editor shows the payee select for a single usable account with no default; the booking dialog waits for cash accounts before proposing lines; a failed default write no longer hides a created account. - Behandlingshistorik names the account on created/deleted defaults. - Regenerated skills/accounted-api; MCP argument description trimmed under the tools/list payload ceiling. Declined: clearing legacy columns via a forward migration (the mirror now does it on delete); Swedish review's "show the debit account in the mark-paid UI" (the booking dialog already proposes and lets the user edit the debit line); manual ledger collision (UNIQUE exists, and the create path now rejects it with a clear error); Peppol aligning to the PDF value for companies whose legacy column had drifted from the map (the PDF is the customer-facing document; both now agree). Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UaZTY21HVN57hJoPXKSLjV * fix(invoices): read NEW.invoice_payee only on the cash_accounts branch of the mirror trigger trg_mirror_invoice_payee_defaults fires for both tables; plpgsql resolves record fields per expression, so the combined condition failed with "record new has no field invoice_payee" whenever a default row changed, which took down every pg-real case on the payee tables. The revoke/disable check now sits inside its own TG_TABLE_NAME branch. The MCP settings executor test mocks the payee write-through like the settings route test already does. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UaZTY21HVN57hJoPXKSLjV * fix(invoices): keep member disables from revoking payee defaults, gate payee on 1920-1999, fit the MCP payload Cycle 3 of /resolve-pr on #2233. Superagent P1: the SECURITY DEFINER mirror trigger deleted an admin's invoice_payee_defaults rows whenever cash_accounts.enabled flipped to false, and enabled is member-writable (the bank picker's "Synkas ej"), so a member could undo an admin's payee decision. The trigger now drops defaults only on the admin-only invoice_payee true -> false revoke; the mirror trigger's WHEN no longer lists enabled. Disabled accounts stay out of the pick lists and the send gate already refuses an invoice that chose one. Applied to staging as the same function + trigger definition and probed inside a rolled-back block: disable keeps the default and the mirrored bankgiro, revoke clears both. pg-real: the admin-guard test ran three expectations inside one withUserContext transaction; the first raise aborted it and the next statement failed with "current transaction is aborted". One transaction per expectation now, and the member case also flips enabled to prove the column stays member-level. Swedish review: payee eligibility was /^19\d\d$/, which admits 1910 Kassa and the 1911-1919 tills. A customer pays to a giro or bank account, so isBankCashAccount, CreateCashAccountSchema.ledger_account and the PATCH route now require BAS 1920-1999; tests cover 1910 and 1919. Unit tests (3/4): the tools/list payload guard read 60 025, then 60 014 tokens after main merged #2166 and #2163 alongside this branch. The ceiling is not bumped and no read on this surface is a demotion candidate, so gnubok_create_invoice drops payment_cash_account_id; agent-created invoices print the per-currency default and v1 REST plus the editor keep the field. Recorded in DECISIONS.md. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UaZTY21HVN57hJoPXKSLjV * chore(migrations): move invoices_payment_cash_account to 20260903183000 after colliding with main's KPI migration origin/main merged 20260903160000_kpi_monthly_include_reversed_originals while this branch held the same version; identical versions abort the Supabase apply. Staging's schema_migrations row was moved to the new version with the file. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01UaZTY21HVN57hJoPXKSLjV * fix(invoices): gate invoice_payee on BAS 1920-1999 at the database, and unblock the typecheck ratchet Cycle 4 of /resolve-pr on #2233, on Emil's go. Swedish review: the 1920-1999 payee rule lived only in the routes. The cash_accounts_payee_admin_only trigger now also refuses invoice_payee on any other ledger (INVOICE_PAYEE_ACCOUNT_INVALID, 23514), whoever writes it, and the backfill only targets giro/bank rows, so a company whose single enabled cash_accounts row is a Stripe clearing account keeps its legacy bankgiro in company_settings instead of landing it on 1686. pg test covers insert and update on 1686 and 1910; the function was applied to staging and probed. Typecheck ratchet: main is red from two merges that landed with failing Checks, and every branch that syncs it inherits the errors. - #2242 added POST(req) calls to the fiscal-periods route test without the route params argument withRouteContext handlers take (25 errors in the file, baseline 23). All 25 calls now pass createMockRouteParams({}). - #2247 made SyncResult.requestedFromDate and historyNarrowed required; the 13 mockedSync results in the enable-banking accounts-route test lacked them. They now carry a fixed date and historyNarrowed: false. Both files' tests pass unchanged in behaviour. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> * chore(migrations): move invoices_payment_cash_account to 20260903193000 after colliding with main's party_promotion origin/main merged 20260903183000_party_promotion while this branch held the same version. Staging's schema_migrations row must follow (pending: the Supabase MCP was disconnected at the time of this commit). Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> --------- Co-authored-by: Claude Fable 5.1 <noreply@anthropic.com>
1378 lines
49 KiB
TypeScript
1378 lines
49 KiB
TypeScript
/**
|
|
* Enable Banking API integration for PSD2 bank connections
|
|
*
|
|
* Documentation: https://enablebanking.com/docs/api/reference/
|
|
*
|
|
* Flow:
|
|
* 1. POST /auth → { url, authorization_id }
|
|
* 2. User redirects to URL, authenticates with bank
|
|
* 3. Callback receives ?code=XXX&state=YYY
|
|
* 4. POST /sessions { code } → { session_id, accounts }
|
|
* 5. GET /accounts/{uid}/balances
|
|
* 6. GET /accounts/{uid}/transactions
|
|
*/
|
|
|
|
import { getAuthorizationHeader } from './jwt'
|
|
import { deriveTransactionLabel } from './transaction-label'
|
|
import { FALLBACK_DESCRIPTION } from '@/lib/transactions/external-id'
|
|
import { bankConnectorMode, CONNECTOR_COMPANY_HEADER } from '@/lib/connect/instance/upstreams'
|
|
import { dateFromDaysBefore, historyWindowDays } from './history-window'
|
|
|
|
// Prefer _PRODUCTION variant; sandbox uses api.tilisy.com, production uses api.enablebanking.com
|
|
const ENABLE_BANKING_API_URL =
|
|
process.env.ENABLE_BANKING_API_URL_PRODUCTION ||
|
|
process.env.ENABLE_BANKING_API_URL ||
|
|
'https://api.enablebanking.com'
|
|
|
|
// Types
|
|
|
|
export interface ASPSP {
|
|
name: string
|
|
country: string
|
|
logo?: string
|
|
bic?: string
|
|
beta?: boolean
|
|
max_consent_validity?: number
|
|
// Enable Banking returns this field as `auth_methods` on the ASPSP object.
|
|
auth_methods?: AuthMethod[]
|
|
}
|
|
|
|
export interface AuthMethod {
|
|
name: string
|
|
title?: string
|
|
// How the SCA is performed. Mobile BankID at several Swedish banks is a
|
|
// DECOUPLED method; the visible default is often a REDIRECT method.
|
|
approach?: 'REDIRECT' | 'DECOUPLED' | 'EMBEDDED'
|
|
// When true, Enable Banking only uses this method if it is requested
|
|
// explicitly via auth_method (it is not the implicit default).
|
|
hidden_method?: boolean
|
|
psu_types?: ('personal' | 'business')[]
|
|
}
|
|
|
|
export interface AuthResponse {
|
|
url: string
|
|
authorization_id: string
|
|
}
|
|
|
|
export interface SessionResponse {
|
|
session_id: string
|
|
access: {
|
|
valid_until: string
|
|
}
|
|
accounts: AccountInfo[]
|
|
aspsp: {
|
|
name: string
|
|
country: string
|
|
}
|
|
psu_type: string
|
|
/**
|
|
* Lifecycle state of the PSD2 session as Enable Banking sees it. Present on
|
|
* GET /sessions/{id}; used by probeSessionHealth to detect a consent that
|
|
* died bank-side without us attempting a transaction fetch.
|
|
*/
|
|
status?: string
|
|
}
|
|
|
|
/**
|
|
* Enable Banking GenericIdentification (OpenAPI 1.0.0). `scheme_name` is the
|
|
* SchemeName enum: BBAN, IBAN, BGNR (Swedish Bankgiro), PGNR (Swedish
|
|
* Plusgiro), CPAN, MIBN, ... For Swedish ASPSPs a BBAN is the bank clearing
|
|
* number followed by the account number, no separator.
|
|
*/
|
|
export interface GenericIdentification {
|
|
identification: string
|
|
scheme_name: string
|
|
issuer?: string
|
|
}
|
|
|
|
/**
|
|
* Enable Banking AccountIdentification. There is NO top-level `bban` key in
|
|
* the API: a BBAN arrives as `other.identification` with
|
|
* `other.scheme_name = 'BBAN'`. Earlier versions of this client typed
|
|
* `bban?: string` here and therefore never captured the Swedish clearing +
|
|
* account number for any connected account.
|
|
*/
|
|
export interface AccountIdentification {
|
|
iban?: string
|
|
other?: GenericIdentification
|
|
}
|
|
|
|
export interface AccountInfo {
|
|
uid: string
|
|
account_id?: AccountIdentification
|
|
/** Every identifier the ASPSP provided, including the primary one. */
|
|
all_account_ids?: GenericIdentification[]
|
|
name?: string
|
|
product?: string
|
|
currency: string
|
|
identification_hash?: string
|
|
}
|
|
|
|
const BBAN_SCHEMES = new Set(['BBAN'])
|
|
const DOMESTIC_ACCOUNT_SCHEMES = new Set(['BBAN', 'BGNR', 'PGNR'])
|
|
|
|
/**
|
|
* The account's BBAN (Swedish clearing + account number) if the ASPSP sent
|
|
* one, from the primary identifier or the full identifier list.
|
|
*/
|
|
export function extractBban(
|
|
account: Pick<AccountInfo, 'account_id' | 'all_account_ids'>,
|
|
): string | undefined {
|
|
const primary = account.account_id?.other
|
|
if (primary && BBAN_SCHEMES.has(primary.scheme_name?.toUpperCase()) && primary.identification) {
|
|
return primary.identification.replace(/\s+/g, '')
|
|
}
|
|
const listed = account.all_account_ids?.find(
|
|
(id) => BBAN_SCHEMES.has(id.scheme_name?.toUpperCase()) && Boolean(id.identification),
|
|
)
|
|
return listed ? listed.identification.replace(/\s+/g, '') : undefined
|
|
}
|
|
|
|
/**
|
|
* Best single identifier for a counterparty account: IBAN first, then a
|
|
* domestic scheme (BBAN, Bankgiro, Plusgiro) from the primary identifier or
|
|
* the additional list, then whatever else the bank sent.
|
|
*/
|
|
export function pickAccountIdentifier(
|
|
account: AccountIdentification | undefined,
|
|
additional?: GenericIdentification[],
|
|
): string | undefined {
|
|
if (account?.iban) return account.iban
|
|
const candidates: GenericIdentification[] = []
|
|
if (account?.other) candidates.push(account.other)
|
|
if (additional) candidates.push(...additional)
|
|
const iban = candidates.find(
|
|
(id) => id.scheme_name?.toUpperCase() === 'IBAN' && Boolean(id.identification),
|
|
)
|
|
if (iban) return iban.identification
|
|
const domestic = candidates.find(
|
|
(id) => DOMESTIC_ACCOUNT_SCHEMES.has(id.scheme_name?.toUpperCase()) && Boolean(id.identification),
|
|
)
|
|
// Anything else (card PANs, customer numbers, ...) is not an account and
|
|
// must not land in transactions.counterparty_account.
|
|
return domestic?.identification
|
|
}
|
|
|
|
export interface Balance {
|
|
balance_amount: {
|
|
amount: string
|
|
currency: string
|
|
}
|
|
balance_type: string
|
|
reference_date?: string
|
|
last_change_date_time?: string
|
|
}
|
|
|
|
export interface BalanceResponse {
|
|
balances: Balance[]
|
|
}
|
|
|
|
export interface Transaction {
|
|
entry_reference?: string
|
|
transaction_id?: string
|
|
booking_date?: string
|
|
value_date?: string
|
|
transaction_amount: {
|
|
amount: string
|
|
currency: string
|
|
}
|
|
credit_debit_indicator?: 'CRDT' | 'DBIT' // CRDT = credit (income), DBIT = debit (expense)
|
|
creditor_name?: string
|
|
creditor_account?: AccountIdentification
|
|
/** All other creditor account identifiers provided by the ASPSP. */
|
|
creditor_account_additional_identification?: GenericIdentification[]
|
|
creditor?: {
|
|
name?: string
|
|
}
|
|
debtor_name?: string
|
|
debtor_account?: AccountIdentification
|
|
/** All other debtor account identifiers provided by the ASPSP. */
|
|
debtor_account_additional_identification?: GenericIdentification[]
|
|
debtor?: {
|
|
name?: string
|
|
}
|
|
remittance_information?: string[]
|
|
merchant_category_code?: string
|
|
bank_transaction_code?: string
|
|
proprietary_bank_transaction_code?: string
|
|
}
|
|
|
|
export interface TransactionsResponse {
|
|
transactions: Transaction[]
|
|
continuation_key?: string
|
|
}
|
|
|
|
/**
|
|
* Strategy for how Enable Banking fetches transactions from the upstream ASPSP.
|
|
* - 'default': fast path, may return only the most recent window even if date_from is older
|
|
* - 'longest': fetch the longest available history (up to PSD2 90-day max), slower
|
|
*
|
|
* When omitted, Enable Banking applies its default strategy.
|
|
*/
|
|
export type TransactionsFetchStrategy = 'default' | 'longest'
|
|
|
|
export interface BankTransaction {
|
|
id: string
|
|
date: string
|
|
booking_date: string
|
|
amount: number
|
|
currency: string
|
|
description: string
|
|
counterparty_name?: string
|
|
counterparty_account?: string
|
|
reference?: string
|
|
merchant_category_code?: string
|
|
// ISO 20022 / proprietary transaction codes: carried through so the
|
|
// description fallback can derive a meaningful Swedish label when remittance
|
|
// text and a counterparty name are both absent. See deriveTransactionLabel.
|
|
bank_transaction_code?: string
|
|
proprietary_bank_transaction_code?: string
|
|
}
|
|
|
|
// Constants
|
|
const FETCH_TIMEOUT_MS = 15_000
|
|
const MAX_RETRIES = 2
|
|
const RETRY_DELAY_MS = 1000
|
|
const MAX_PAGINATION_PAGES = 100
|
|
const DEFAULT_PAGE_SIZE = 500
|
|
|
|
/**
|
|
* Thrown by getAccountTransactions on a non-OK response. Carries the HTTP
|
|
* status and raw body so the pagination caller (getAllTransactions) can run the
|
|
* same first-page strategy/window fallbacks as getAllTransactionsWithRaw. The
|
|
* message is identical to the previous plain Error for back-compat.
|
|
*/
|
|
class TransactionsFetchError extends Error {
|
|
constructor(
|
|
readonly status: number,
|
|
readonly body: string
|
|
) {
|
|
super(`Failed to get transactions (${status}): ${body}`)
|
|
this.name = 'TransactionsFetchError'
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Normalized signatures (uppercase, non-alphanumerics stripped) of the
|
|
* responses Enable Banking (or the upstream ASPSP via Enable Banking's
|
|
* envelope) returns when the PSD2 session can no longer be used: the consent
|
|
* was closed, expired, or invalidated bank-side. Spelling and casing vary by
|
|
* bank (CLOSED_SESSION, EXPIRED_SESSION, SESSION_EXPIRED / session_expired,
|
|
* INVALID_SESSION, SESSION_NOT_FOUND, WRONG_SESSION_STATUS, and the plain
|
|
* "Session is closed" message), so we match the whole family. A dead session
|
|
* is unrecoverable by retrying: the user must re-authorize.
|
|
*/
|
|
const SESSION_DEAD_NEEDLES = [
|
|
'CLOSEDSESSION', // CLOSED_SESSION
|
|
'SESSIONCLOSED', // "session closed"
|
|
'SESSIONISCLOSED', // "Session is closed"
|
|
'SESSIONEXPIRED', // SESSION_EXPIRED / session_expired
|
|
'EXPIREDSESSION', // EXPIRED_SESSION
|
|
'INVALIDSESSION', // INVALID_SESSION
|
|
'SESSIONNOTFOUND', // SESSION_NOT_FOUND
|
|
'WRONGSESSIONSTATUS', // WRONG_SESSION_STATUS
|
|
] as const
|
|
|
|
/**
|
|
* Whether a failed transactions response signals a dead PSD2 session (vs. a
|
|
* transient error or a config-level auth failure). Only 401/403 with a
|
|
* session-expiry signal in the body counts: a bare 401 "Unauthorized" is an
|
|
* app-credential problem, not a closed consent, and must NOT be misread as
|
|
* "reconnect the bank". The match is deterministic: normalize the body and
|
|
* test for any known session-dead needle.
|
|
*/
|
|
export function isSessionExpiredResponse(status: number, body: string): boolean {
|
|
if (status !== 401 && status !== 403) return false
|
|
const normalized = body.toUpperCase().replace(/[^A-Z0-9]/g, '')
|
|
return SESSION_DEAD_NEEDLES.some(needle => normalized.includes(needle))
|
|
}
|
|
|
|
/**
|
|
* User-facing (Swedish) messages persisted to bank_connections.error_message
|
|
* and returned to the settings UI. error_message is a literal string in the
|
|
* DB, not an i18n key, matching the extension's other user-facing strings.
|
|
* Raw Enable Banking error bodies are English JSON envelopes and must never
|
|
* land here: they belong in server logs only.
|
|
*/
|
|
export const REAUTH_REQUIRED_MESSAGE =
|
|
'Bankanslutningen har löpt ut. Förnya anslutningen för att fortsätta synka.'
|
|
export const SYNC_FAILED_MESSAGE =
|
|
'Banksynkningen misslyckades. Försök igen, eller förnya anslutningen om felet kvarstår.'
|
|
/**
|
|
* The bank is refusing right now and narrowing the window cannot help. Says
|
|
* explicitly that the connection does NOT need renewing: a transient
|
|
* ASPSP_ERROR used to surface as SYNC_FAILED_MESSAGE, whose "förnya
|
|
* anslutningen" advice costs a BankID round trip and fixes nothing (#2202).
|
|
*/
|
|
export const BANK_UNAVAILABLE_MESSAGE =
|
|
'Banken svarade inte just nu (tillfälligt fel hos banken). Försök igen om en stund. Anslutningen behöver inte förnyas.'
|
|
|
|
/**
|
|
* Thrown when a transactions fetch fails because the PSD2 session is dead
|
|
* (closed/expired/invalid). Distinct from TransactionsFetchError so the sync
|
|
* handler can flip the connection to 'expired' and prompt re-authorization
|
|
* instead of surfacing a raw error the user can't act on. Carries the status
|
|
* and raw body for logging. See isSessionExpiredResponse for the codes covered.
|
|
*/
|
|
export class SessionExpiredError extends Error {
|
|
constructor(
|
|
readonly status: number,
|
|
readonly body: string
|
|
) {
|
|
super(`Bank session expired (${status}): ${body}`)
|
|
this.name = 'SessionExpiredError'
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Thrown when the ASPSP rejected the transactions request and narrowing the
|
|
* history window is not the answer (issue #2202):
|
|
*
|
|
* - 'window-already-accepted': the rejected window is no wider than one this
|
|
* account has fetched successfully before (StoredAccount.accepted_history_days),
|
|
* so width is not the problem; the bank is refusing for its own reasons.
|
|
* - 'ladder-exhausted': every narrower window was refused too.
|
|
*
|
|
* Either way the sync should say "try again later" and must not flip the
|
|
* connection to expired/error or prompt a consent renewal. The message keeps
|
|
* the `Failed to get transactions (status)` prefix so existing log matching
|
|
* still works; carries the raw body for the server log only.
|
|
*/
|
|
export class AspspUnavailableError extends Error {
|
|
constructor(
|
|
readonly status: number,
|
|
readonly body: string,
|
|
readonly reason: 'window-already-accepted' | 'ladder-exhausted',
|
|
readonly dateFrom: string | undefined
|
|
) {
|
|
super(`Failed to get transactions (${status}), bank unavailable [${reason}]: ${body}`)
|
|
this.name = 'AspspUnavailableError'
|
|
}
|
|
}
|
|
|
|
// API Helper
|
|
|
|
async function authenticatedFetch(
|
|
endpoint: string,
|
|
options: RequestInit = {}
|
|
): Promise<Response> {
|
|
// Connector mode: a self-host with a connector key and no own Enable Banking
|
|
// credentials routes every upstream call through the hosted bank proxy. The
|
|
// proxy holds the real EB credentials and mints the JWT on its side, so the
|
|
// instance sends the connector key as a Bearer token and NEVER calls
|
|
// getAuthorizationHeader() (there is no private key to sign with here). When
|
|
// this instance has its own EB credentials, or on hosted, bankConnectorMode()
|
|
// returns null and the direct path below is byte-identical to before.
|
|
const connector = bankConnectorMode()
|
|
const url = connector ? `${connector.baseUrl}${endpoint}` : `${ENABLE_BANKING_API_URL}${endpoint}`
|
|
const authorization = connector ? `Bearer ${connector.key}` : getAuthorizationHeader()
|
|
const controller = new AbortController()
|
|
const timeout = setTimeout(() => controller.abort(), FETCH_TIMEOUT_MS)
|
|
|
|
try {
|
|
const response = await fetch(url, {
|
|
...options,
|
|
signal: controller.signal,
|
|
headers: {
|
|
'Authorization': authorization,
|
|
'Content-Type': 'application/json',
|
|
...options.headers,
|
|
},
|
|
})
|
|
|
|
return response
|
|
} finally {
|
|
clearTimeout(timeout)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retry wrapper for idempotent read operations.
|
|
* Retries on 429, 502, 503, 504, and AbortError (timeout).
|
|
*/
|
|
async function authenticatedFetchWithRetry(
|
|
endpoint: string,
|
|
options: RequestInit = {}
|
|
): Promise<Response> {
|
|
for (let attempt = 0; attempt <= MAX_RETRIES; attempt++) {
|
|
try {
|
|
const response = await authenticatedFetch(endpoint, options)
|
|
if (attempt < MAX_RETRIES && [429, 502, 503, 504].includes(response.status)) {
|
|
// A 429 caused by a DAILY quota cannot clear within the retry window:
|
|
// PSD2 unattended consents allow only a handful of balance calls per
|
|
// day (observed body: "Consent daily limit 4 is exceeded"), so
|
|
// retrying just burns time and duplicates the failure in logs. Read
|
|
// the body from a clone so the returned response stays consumable.
|
|
if (response.status === 429) {
|
|
const body = await response.clone().text().catch(() => '')
|
|
if (/daily limit/i.test(body)) {
|
|
console.warn(`[enable-banking] 429 daily quota exhausted for ${endpoint}: not retrying`, {
|
|
status: response.status,
|
|
body,
|
|
})
|
|
return response
|
|
}
|
|
}
|
|
console.warn(`[enable-banking] Retrying ${endpoint} (attempt ${attempt + 1}/${MAX_RETRIES})`, {
|
|
status: response.status,
|
|
statusText: response.statusText,
|
|
})
|
|
await new Promise(resolve => setTimeout(resolve, RETRY_DELAY_MS * (attempt + 1)))
|
|
continue
|
|
}
|
|
return response
|
|
} catch (error: unknown) {
|
|
const isAbort = error instanceof Error && error.name === 'AbortError'
|
|
if (attempt < MAX_RETRIES && isAbort) {
|
|
console.warn(`[enable-banking] Request timeout, retrying ${endpoint} (attempt ${attempt + 1}/${MAX_RETRIES})`)
|
|
await new Promise(resolve => setTimeout(resolve, RETRY_DELAY_MS * (attempt + 1)))
|
|
continue
|
|
}
|
|
console.error(`[enable-banking] Request failed for ${endpoint}`, {
|
|
attempt,
|
|
error: error instanceof Error ? error.message : String(error),
|
|
name: error instanceof Error ? error.name : undefined,
|
|
isTimeout: isAbort,
|
|
})
|
|
throw error
|
|
}
|
|
}
|
|
// Unreachable, but satisfies TypeScript
|
|
throw new Error('Max retries exceeded')
|
|
}
|
|
|
|
// API Functions
|
|
|
|
/**
|
|
* Get list of supported banks (ASPSPs) for a country
|
|
*/
|
|
export async function getASPSPs(country: string = 'SE', psuType?: 'personal' | 'business'): Promise<ASPSP[]> {
|
|
const resolvedPsuType = psuType || process.env.ENABLE_BANKING_PSU_TYPE || 'business'
|
|
const isSandbox = ENABLE_BANKING_API_URL.includes('tilisy')
|
|
const params = new URLSearchParams({
|
|
country,
|
|
sandbox: String(isSandbox),
|
|
psu_type: resolvedPsuType,
|
|
})
|
|
const response = await authenticatedFetchWithRetry(`/aspsps?${params.toString()}`)
|
|
|
|
if (!response.ok) {
|
|
const body = await response.text()
|
|
console.error('[enable-banking] getASPSPs failed', {
|
|
status: response.status,
|
|
statusText: response.statusText,
|
|
body,
|
|
country,
|
|
psuType: resolvedPsuType,
|
|
sandbox: isSandbox,
|
|
apiUrl: ENABLE_BANKING_API_URL,
|
|
})
|
|
throw new Error(`Failed to fetch banks (${response.status})`)
|
|
}
|
|
|
|
const data = await response.json()
|
|
return data.aspsps || []
|
|
}
|
|
|
|
/**
|
|
* Pick the DECOUPLED auth method worth pinning explicitly, or undefined to let
|
|
* Enable Banking run the ASPSP's default flow.
|
|
*
|
|
* A method is only pinned when pinning is both NECESSARY and APPLICABLE:
|
|
*
|
|
* - hidden_method === true: a hidden method is never used unless requested
|
|
* explicitly via auth_method, so pinning is the only way to reach it. That
|
|
* is the Handelsbanken case: its Mobile BankID (DECOUPLED) is hidden, and
|
|
* without pinning it corporate PSUs fail right after approving in the
|
|
* BankID app ("fel efter BankID"). A VISIBLE decoupled method is already
|
|
* part of the bank's own default flow; force-pinning it overrides a working
|
|
* default. That regression (from PR #854) broke Lunar-class banks: the user
|
|
* typed their personnummer on Enable Banking's page, was told to approve in
|
|
* the bank's app, and no approval request ever arrived.
|
|
* - psu_types, when present and non-empty, must include the PSU type we are
|
|
* authorizing as: a method scoped to 'personal' must never be pinned for a
|
|
* 'business' consent (and vice versa). A missing or empty psu_types means
|
|
* the method applies to all PSU types.
|
|
*/
|
|
export function selectPreferredAuthMethod(
|
|
authMethods: AuthMethod[] | undefined,
|
|
psuType: 'personal' | 'business'
|
|
): AuthMethod | undefined {
|
|
return authMethods?.find(
|
|
(m) =>
|
|
m.approach === 'DECOUPLED' &&
|
|
m.hidden_method === true &&
|
|
(!m.psu_types || m.psu_types.length === 0 || m.psu_types.includes(psuType))
|
|
)
|
|
}
|
|
|
|
/**
|
|
* Resolve the auth method to pin for a given bank, with full metadata so the
|
|
* caller can log approach/hidden_method/psu_types, or undefined to let Enable
|
|
* Banking use the ASPSP's default flow. Selection rules live in
|
|
* selectPreferredAuthMethod. Returns undefined on lookup failure so banks
|
|
* that already work are untouched.
|
|
*/
|
|
export async function getPreferredAuthMethodDetails(
|
|
aspspName: string,
|
|
country: string,
|
|
psuType: 'personal' | 'business'
|
|
): Promise<AuthMethod | undefined> {
|
|
try {
|
|
const aspsps = await getASPSPs(country, psuType)
|
|
const aspsp = aspsps.find((a) => a.name === aspspName)
|
|
return selectPreferredAuthMethod(aspsp?.auth_methods, psuType)
|
|
} catch (error) {
|
|
console.error('[enable-banking] getPreferredAuthMethod failed; using ASPSP default', {
|
|
aspspName,
|
|
country,
|
|
psuType,
|
|
error: error instanceof Error ? error.message : String(error),
|
|
})
|
|
return undefined
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Name-only convenience wrapper around getPreferredAuthMethodDetails: the
|
|
* value to send as auth_method on POST /auth, or undefined for the ASPSP
|
|
* default.
|
|
*/
|
|
export async function getPreferredAuthMethod(
|
|
aspspName: string,
|
|
country: string,
|
|
psuType: 'personal' | 'business'
|
|
): Promise<string | undefined> {
|
|
const method = await getPreferredAuthMethodDetails(aspspName, country, psuType)
|
|
return method?.name
|
|
}
|
|
|
|
/**
|
|
* Start bank authorization flow
|
|
*
|
|
* @param aspspName - The name of the ASPSP (bank) exactly as returned from /aspsps
|
|
* @param aspspCountry - The country code (e.g., 'SE')
|
|
* @param redirectUrl - URL to redirect user after bank authorization
|
|
* @param state - State parameter returned in callback (e.g., user ID)
|
|
* @param psuType - Type of user: 'personal' or 'business'
|
|
* @param authMethod - Optional Enable Banking auth_method name. When omitted,
|
|
* Enable Banking uses the ASPSP's visible default method. See
|
|
* getPreferredAuthMethod for why we pin Mobile BankID at some banks.
|
|
*/
|
|
export async function startAuthorization(
|
|
aspspName: string,
|
|
aspspCountry: string,
|
|
redirectUrl: string,
|
|
state: string,
|
|
psuType: 'personal' | 'business' = 'personal',
|
|
authMethod?: string,
|
|
companyId?: string
|
|
): Promise<AuthResponse> {
|
|
// Calculate consent validity (90 days)
|
|
const validUntil = new Date()
|
|
validUntil.setDate(validUntil.getDate() + 90)
|
|
|
|
const requestBody: {
|
|
access: { valid_until: string }
|
|
aspsp: { name: string; country: string }
|
|
state: string
|
|
redirect_url: string
|
|
psu_type: 'personal' | 'business'
|
|
auth_method?: string
|
|
} = {
|
|
access: {
|
|
valid_until: validUntil.toISOString()
|
|
},
|
|
aspsp: {
|
|
name: aspspName,
|
|
country: aspspCountry
|
|
},
|
|
state,
|
|
redirect_url: redirectUrl,
|
|
psu_type: psuType
|
|
}
|
|
if (authMethod) {
|
|
requestBody.auth_method = authMethod
|
|
}
|
|
|
|
// In connector mode the hosted bank proxy meters the per-company connection
|
|
// quota, so it needs to know which company this authorization is for. This is
|
|
// gated on bankConnectorMode(), NOT merely on companyId: on hosted and on
|
|
// own-credentials self-hosts companyId is always set, and sending an internal
|
|
// company UUID to the real Enable Banking API is both a needless behavior
|
|
// change and an identifier leak to a third-party processor. Off the connector
|
|
// path the direct request stays byte-identical.
|
|
const authHeaders =
|
|
companyId && bankConnectorMode() ? { [CONNECTOR_COMPANY_HEADER]: companyId } : undefined
|
|
|
|
const response = await authenticatedFetch('/auth', {
|
|
method: 'POST',
|
|
body: JSON.stringify(requestBody),
|
|
...(authHeaders ? { headers: authHeaders } : {}),
|
|
})
|
|
|
|
if (!response.ok) {
|
|
const body = await response.text()
|
|
console.error('[enable-banking] startAuthorization failed', {
|
|
status: response.status,
|
|
statusText: response.statusText,
|
|
body,
|
|
aspspName,
|
|
aspspCountry,
|
|
psuType,
|
|
redirectUrl,
|
|
apiUrl: ENABLE_BANKING_API_URL,
|
|
requestBody: JSON.stringify(requestBody),
|
|
})
|
|
throw new Error(`Failed to start bank connection (${response.status}): ${body}`)
|
|
}
|
|
|
|
return response.json()
|
|
}
|
|
|
|
/**
|
|
* Create a session after user completes bank authorization
|
|
*
|
|
* @param code - The authorization code from callback
|
|
* @param connectorState - The signed connector state echoed back through the
|
|
* hosted callback in connector mode. The bank proxy binds the /sessions
|
|
* exchange to the pending row it signed at /auth time (single-use, race-safe),
|
|
* so it is required in connector mode and absent on the direct path.
|
|
*/
|
|
export async function createSession(code: string, connectorState?: string): Promise<SessionResponse> {
|
|
const response = await authenticatedFetch('/sessions', {
|
|
method: 'POST',
|
|
body: JSON.stringify(connectorState ? { code, connector_state: connectorState } : { code })
|
|
})
|
|
|
|
if (!response.ok) {
|
|
const body = await response.text()
|
|
console.error('[enable-banking] createSession failed', {
|
|
status: response.status,
|
|
statusText: response.statusText,
|
|
body,
|
|
hasCode: !!code,
|
|
codeLength: code?.length,
|
|
apiUrl: ENABLE_BANKING_API_URL,
|
|
})
|
|
throw new Error(`Failed to create bank session (${response.status}): ${body}`)
|
|
}
|
|
|
|
return response.json()
|
|
}
|
|
|
|
/**
|
|
* Get session details
|
|
*
|
|
* @param sessionId - The session ID
|
|
*/
|
|
export async function getSession(sessionId: string): Promise<SessionResponse> {
|
|
const response = await authenticatedFetchWithRetry(`/sessions/${sessionId}`)
|
|
|
|
if (!response.ok) {
|
|
const body = await response.text()
|
|
console.error('[enable-banking] getSession failed', {
|
|
status: response.status,
|
|
statusText: response.statusText,
|
|
body,
|
|
sessionId,
|
|
})
|
|
throw new Error(`Failed to get session (${response.status}): ${body}`)
|
|
}
|
|
|
|
return response.json()
|
|
}
|
|
|
|
/**
|
|
* Session lifecycle values that mean the consent can no longer be used. Kept
|
|
* deliberately narrow: an unrecognized status resolves to 'unknown' and leaves
|
|
* the stored connection state untouched, because wrongly flipping a live
|
|
* connection to 'expired' costs the user a full BankID re-authorization.
|
|
*/
|
|
const SESSION_DEAD_STATUSES = new Set([
|
|
'CANCELLED',
|
|
'CLOSED',
|
|
'EXPIRED',
|
|
'INVALID',
|
|
'REJECTED',
|
|
'REVOKED',
|
|
])
|
|
|
|
/**
|
|
* Session lifecycle values that mean the consent is usable. Anything outside
|
|
* both sets (including a response carrying no status at all) is 'unknown':
|
|
* claiming 'alive' for a value we do not recognize would be asserting more
|
|
* than the probe actually established.
|
|
*/
|
|
const SESSION_ALIVE_STATUSES = new Set(['AUTHORIZED', 'VALID', 'ACTIVE'])
|
|
|
|
export type SessionHealth = 'alive' | 'dead' | 'unknown'
|
|
|
|
/**
|
|
* Ask Enable Banking whether a PSD2 session is still usable, without fetching
|
|
* any account data.
|
|
*
|
|
* Until this existed, a connection only ever learned its session was dead by
|
|
* TRYING to sync: a bank that invalidates a consent server-side (several
|
|
* ASPSPs drop the previous session when the same PSU authorizes again) left
|
|
* the row sitting at status 'active' with a stale last_synced_at, so the UI
|
|
* kept presenting old balances as current. Never throws: probing is a
|
|
* best-effort health signal, and 'unknown' is always a safe answer.
|
|
*/
|
|
export async function probeSessionHealth(sessionId: string): Promise<SessionHealth> {
|
|
try {
|
|
const response = await authenticatedFetchWithRetry(`/sessions/${sessionId}`)
|
|
const body = await response.text()
|
|
|
|
if (!response.ok) {
|
|
if (isSessionExpiredResponse(response.status, body)) return 'dead'
|
|
// The session record itself is gone: nothing left to sync with.
|
|
if (response.status === 404) return 'dead'
|
|
return 'unknown'
|
|
}
|
|
|
|
try {
|
|
const parsed = JSON.parse(body) as SessionResponse
|
|
const status = typeof parsed.status === 'string' ? parsed.status.toUpperCase() : null
|
|
if (status && SESSION_DEAD_STATUSES.has(status)) return 'dead'
|
|
if (status && SESSION_ALIVE_STATUSES.has(status)) return 'alive'
|
|
} catch {
|
|
// Unparseable body on a 200: treat as inconclusive, not as dead.
|
|
return 'unknown'
|
|
}
|
|
return 'unknown'
|
|
} catch (error) {
|
|
console.warn('[enable-banking] probeSessionHealth failed', {
|
|
sessionId,
|
|
error: error instanceof Error ? error.message : String(error),
|
|
})
|
|
return 'unknown'
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Delete/revoke a session
|
|
*
|
|
* @param sessionId - The session ID to revoke
|
|
*/
|
|
export async function deleteSession(sessionId: string): Promise<void> {
|
|
const response = await authenticatedFetch(`/sessions/${sessionId}`, {
|
|
method: 'DELETE'
|
|
})
|
|
|
|
if (!response.ok) {
|
|
const body = await response.text()
|
|
// A session Enable Banking has already dropped (404, or a 401/403 naming
|
|
// an expired/closed session) is the expected answer when we revoke a
|
|
// connection whose PSD2 consent ran out: every caller catches and carries
|
|
// on, so it does not belong in the error panel.
|
|
const alreadyGone = response.status === 404 || isSessionExpiredResponse(response.status, body)
|
|
const logLine = {
|
|
status: response.status,
|
|
statusText: response.statusText,
|
|
body,
|
|
sessionId,
|
|
}
|
|
if (alreadyGone) {
|
|
console.warn('[enable-banking] deleteSession: session already gone at Enable Banking', logLine)
|
|
} else {
|
|
console.error('[enable-banking] deleteSession failed', logLine)
|
|
}
|
|
throw new Error(`Failed to revoke session (${response.status}): ${body}`)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get account balances
|
|
*
|
|
* @param accountUid - The account UID (from session.accounts[].uid)
|
|
*/
|
|
export async function getAccountBalances(accountUid: string): Promise<Balance[]> {
|
|
const response = await authenticatedFetchWithRetry(`/accounts/${accountUid}/balances`)
|
|
|
|
if (!response.ok) {
|
|
const body = await response.text()
|
|
console.error('[enable-banking] getAccountBalances failed', {
|
|
status: response.status,
|
|
statusText: response.statusText,
|
|
body,
|
|
accountUid,
|
|
})
|
|
throw new Error(`Failed to get account balances (${response.status}): ${body}`)
|
|
}
|
|
|
|
const data: BalanceResponse = await response.json()
|
|
return data.balances || []
|
|
}
|
|
|
|
// Balance-type preference orders. ASPSPs report types either as camelCase
|
|
// names or ISO 20022 codes; both spellings of each type are accepted,
|
|
// case-insensitively. Booked answers "what has the bank settled", available
|
|
// answers "what can be spent right now" (the covering-decision number).
|
|
// closingBooked (settled, definitive) wins over expected, which wins over
|
|
// interimBooked (intraday booked): fall through to less-final booked types
|
|
// only when the stabler one is absent, and to the generic first-entry
|
|
// fallback only when no booked type exists at all.
|
|
const BOOKED_BALANCE_TYPES = ['closingbooked', 'clbd', 'expected', 'xpcd', 'interimbooked', 'itbd']
|
|
const AVAILABLE_BALANCE_TYPES = [
|
|
'interimavailable',
|
|
'itav',
|
|
'closingavailable',
|
|
'clav',
|
|
'forwardavailable',
|
|
'fwav',
|
|
]
|
|
|
|
function pickBalanceByType(balances: Balance[], preference: string[]): Balance | undefined {
|
|
for (const type of preference) {
|
|
const match = balances.find(b => b.balance_type?.toLowerCase() === type)
|
|
if (match) return match
|
|
}
|
|
return undefined
|
|
}
|
|
|
|
/**
|
|
* Get account balance from one BALANCES call: the booked amount (falling back
|
|
* to the first reported balance, as before) plus the available amount when the
|
|
* ASPSP reports one. One call: both figures come from the same quota-limited
|
|
* response, so exposing `available` costs nothing extra.
|
|
*
|
|
* Returns null when the ASPSP reports NO balances at all. The old behavior
|
|
* fabricated `amount: 0` here; once balances became user-facing ("how much
|
|
* money is in the bank", covering decisions before payment runs) a fabricated
|
|
* zero with a fresh timestamp is dangerous, so the caller keeps its previous
|
|
* stored value instead.
|
|
*/
|
|
export async function getAccountBalance(
|
|
accountUid: string
|
|
): Promise<{ amount: number; date: string; available: number | null } | null> {
|
|
const balances = await getAccountBalances(accountUid)
|
|
|
|
// Prefer closingBooked, then expected, then first available
|
|
const balance = pickBalanceByType(balances, BOOKED_BALANCE_TYPES) || balances[0]
|
|
|
|
if (!balance) {
|
|
return null
|
|
}
|
|
|
|
const availableBalance = pickBalanceByType(balances, AVAILABLE_BALANCE_TYPES)
|
|
const available = availableBalance
|
|
? parseFloat(availableBalance.balance_amount.amount)
|
|
: null
|
|
|
|
return {
|
|
amount: parseFloat(balance.balance_amount.amount),
|
|
date: balance.reference_date || new Date().toISOString().split('T')[0],
|
|
available: available != null && Number.isFinite(available) ? available : null,
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get account transactions
|
|
*
|
|
* @param accountUid - The account UID
|
|
* @param dateFrom - Start date (YYYY-MM-DD)
|
|
* @param dateTo - End date (YYYY-MM-DD)
|
|
* @param continuationKey - Pagination key from previous response
|
|
*/
|
|
export async function getAccountTransactions(
|
|
accountUid: string,
|
|
dateFrom?: string,
|
|
dateTo?: string,
|
|
continuationKey?: string,
|
|
strategy?: TransactionsFetchStrategy
|
|
): Promise<TransactionsResponse> {
|
|
const params = new URLSearchParams()
|
|
if (dateFrom) params.set('date_from', dateFrom)
|
|
if (dateTo) params.set('date_to', dateTo)
|
|
if (continuationKey) params.set('continuation_key', continuationKey)
|
|
if (strategy) params.set('strategy', strategy)
|
|
params.set('limit', String(DEFAULT_PAGE_SIZE))
|
|
|
|
const queryString = params.toString()
|
|
const endpoint = `/accounts/${accountUid}/transactions${queryString ? `?${queryString}` : ''}`
|
|
|
|
const response = await authenticatedFetchWithRetry(endpoint)
|
|
|
|
if (!response.ok) {
|
|
const body = await response.text()
|
|
console.error('[enable-banking] getAccountTransactions failed', {
|
|
status: response.status,
|
|
statusText: response.statusText,
|
|
body,
|
|
accountUid,
|
|
dateFrom,
|
|
dateTo,
|
|
strategy,
|
|
hasContinuationKey: !!continuationKey,
|
|
})
|
|
if (isSessionExpiredResponse(response.status, body)) {
|
|
throw new SessionExpiredError(response.status, body)
|
|
}
|
|
throw new TransactionsFetchError(response.status, body)
|
|
}
|
|
|
|
return response.json()
|
|
}
|
|
|
|
/**
|
|
* Get all transactions with pagination
|
|
*/
|
|
export async function getAllTransactions(
|
|
accountUid: string,
|
|
dateFrom?: string,
|
|
dateTo?: string,
|
|
strategy?: TransactionsFetchStrategy,
|
|
options?: HistoryWindowOptions
|
|
): Promise<Transaction[]> {
|
|
const allTransactions: Transaction[] = []
|
|
let continuationKey: string | undefined
|
|
let page = 0
|
|
let activeStrategy = strategy
|
|
// date_from is narrowed in place when the ASPSP rejects the window (below).
|
|
let activeDateFrom = dateFrom
|
|
|
|
while (true) {
|
|
let response: TransactionsResponse
|
|
try {
|
|
response = await getAccountTransactions(
|
|
accountUid,
|
|
activeDateFrom,
|
|
dateTo,
|
|
continuationKey,
|
|
activeStrategy
|
|
)
|
|
} catch (err) {
|
|
// Apply the same first-page recovery as getAllTransactionsWithRaw. Only
|
|
// TransactionsFetchError carries the status/body needed to decide;
|
|
// network errors and the like propagate untouched.
|
|
if (err instanceof TransactionsFetchError) {
|
|
const recovery = planFirstPageRecovery({
|
|
status: err.status,
|
|
body: err.body,
|
|
page,
|
|
hasContinuationKey: !!continuationKey,
|
|
activeStrategy,
|
|
activeDateFrom,
|
|
dateTo,
|
|
acceptedHistoryDays: options?.acceptedHistoryDays,
|
|
})
|
|
if (recovery.type === 'drop-strategy') {
|
|
console.warn('[enable-banking] strategy rejected by API, retrying without strategy', {
|
|
accountUid,
|
|
strategy: activeStrategy,
|
|
body: err.body,
|
|
})
|
|
activeStrategy = undefined
|
|
continue
|
|
}
|
|
if (recovery.type === 'narrow') {
|
|
console.warn('[enable-banking] ASPSP rejected history window, retrying with narrower date_from', {
|
|
accountUid,
|
|
previousDateFrom: activeDateFrom,
|
|
nextDateFrom: recovery.dateFrom,
|
|
dateTo,
|
|
body: err.body,
|
|
})
|
|
activeDateFrom = recovery.dateFrom
|
|
continue
|
|
}
|
|
if (recovery.type === 'aspsp-unavailable') {
|
|
throw bankUnavailable(accountUid, err.status, err.body, recovery.reason, activeDateFrom, dateTo)
|
|
}
|
|
}
|
|
throw err
|
|
}
|
|
|
|
allTransactions.push(...response.transactions)
|
|
continuationKey = response.continuation_key
|
|
page++
|
|
|
|
if (page >= MAX_PAGINATION_PAGES) {
|
|
console.warn(`[enable-banking] Pagination cap reached (${MAX_PAGINATION_PAGES} pages) for account ${accountUid}`)
|
|
break
|
|
}
|
|
if (!continuationKey) break
|
|
}
|
|
|
|
return allTransactions
|
|
}
|
|
|
|
/**
|
|
* Lookback windows (days before date_to) we step through when an ASPSP rejects
|
|
* the requested transaction history. Descending so each fallback yields a
|
|
* strictly narrower window. PSD2 obliges banks to ~90 days without fresh SCA;
|
|
* the smaller rungs cover banks that cap below that.
|
|
*/
|
|
const ASPSP_HISTORY_FALLBACK_DAYS = [90, 60, 30] as const
|
|
|
|
/**
|
|
* Per-account knowledge the caller can hand the pagination loops (#2202).
|
|
*/
|
|
export interface HistoryWindowOptions {
|
|
/**
|
|
* Widest window (whole days before date_to) this account's bank has
|
|
* accepted before: StoredAccount.accepted_history_days. When set, a
|
|
* rejected window that is no wider than this is reported as the bank being
|
|
* unavailable (AspspUnavailableError) instead of narrowed, and a wider
|
|
* rejected window jumps straight to this width instead of walking the
|
|
* 90/60/30 ladder. Unset (first sync, legacy rows): the ladder runs as
|
|
* before.
|
|
*/
|
|
acceptedHistoryDays?: number
|
|
}
|
|
|
|
/**
|
|
* Enable Banking wraps upstream-bank failures in a generic envelope, e.g.
|
|
* {"code":400,"message":"Error interacting with ASPSP","error":"ASPSP_ERROR"}.
|
|
* The envelope is the SAME for a history window beyond the bank's PSD2 limit
|
|
* and for a bank that is refusing right now (maintenance, throttling, an
|
|
* upstream error): the one sample of a transient failure on record carried
|
|
* "detail":"Unknown error", exactly like a window rejection does. So the
|
|
* string alone cannot tell the two apart; planFirstPageRecovery uses what the
|
|
* account has accepted before to decide (issue #2202).
|
|
*/
|
|
function isAspspError(body: string): boolean {
|
|
return body.includes('ASPSP_ERROR') || body.includes('interacting with ASPSP')
|
|
}
|
|
|
|
/**
|
|
* Given the date_from we just tried, return the next strictly-narrower
|
|
* date_from from ASPSP_HISTORY_FALLBACK_DAYS, anchored to date_to. Returns
|
|
* undefined when no narrower window remains (or date_to is missing), which
|
|
* ends the retry loop. The "strictly narrower" guard keeps the loop monotonic
|
|
* and terminating even if the original window was already short.
|
|
*/
|
|
function nextNarrowerDateFrom(
|
|
currentDateFrom: string | undefined,
|
|
dateTo: string | undefined
|
|
): string | undefined {
|
|
if (!dateTo) return undefined
|
|
const anchor = new Date(`${dateTo}T00:00:00Z`)
|
|
if (!Number.isFinite(anchor.getTime())) return undefined
|
|
|
|
for (const days of ASPSP_HISTORY_FALLBACK_DAYS) {
|
|
const candidate = new Date(anchor.getTime() - days * 24 * 60 * 60 * 1000)
|
|
.toISOString()
|
|
.split('T')[0]
|
|
if (!currentDateFrom || candidate > currentDateFrom) {
|
|
return candidate
|
|
}
|
|
}
|
|
return undefined
|
|
}
|
|
|
|
/**
|
|
* First-page recovery policy shared by getAllTransactions and
|
|
* getAllTransactionsWithRaw, so the two pagination loops can't drift. Fallbacks
|
|
* apply only to the very first request (page 0, no continuation_key): a
|
|
* continuation_key is scoped to the window/strategy that produced it, so the
|
|
* query is never rewritten mid-pagination.
|
|
*
|
|
* - 'drop-strategy' : an unsupported strategy enum: retry the same window.
|
|
* - 'narrow' : the ASPSP rejected the history window: retry with a
|
|
* narrower date_from (the bank caps history below the
|
|
* ask). With a known accepted width the retry jumps
|
|
* straight to it; without one it steps down the
|
|
* 90/60/30 ladder.
|
|
* - 'aspsp-unavailable' : the ASPSP rejected a window it has accepted before,
|
|
* or every narrower window too: width is not the
|
|
* problem, the bank is refusing right now. The caller
|
|
* throws AspspUnavailableError (#2202).
|
|
* - 'give-up' : nothing left to try; the caller should rethrow.
|
|
*/
|
|
type FirstPageRecovery =
|
|
| { type: 'drop-strategy' }
|
|
| { type: 'narrow'; dateFrom: string }
|
|
| { type: 'aspsp-unavailable'; reason: AspspUnavailableError['reason'] }
|
|
| { type: 'give-up' }
|
|
|
|
function planFirstPageRecovery(args: {
|
|
status: number
|
|
body: string
|
|
page: number
|
|
hasContinuationKey: boolean
|
|
activeStrategy: TransactionsFetchStrategy | undefined
|
|
activeDateFrom: string | undefined
|
|
dateTo: string | undefined
|
|
acceptedHistoryDays: number | undefined
|
|
}): FirstPageRecovery {
|
|
const {
|
|
status,
|
|
body,
|
|
page,
|
|
hasContinuationKey,
|
|
activeStrategy,
|
|
activeDateFrom,
|
|
dateTo,
|
|
acceptedHistoryDays,
|
|
} = args
|
|
if (status !== 400 || page !== 0 || hasContinuationKey) return { type: 'give-up' }
|
|
// Drop an unsupported strategy first: preserves the full requested window.
|
|
if (activeStrategy) return { type: 'drop-strategy' }
|
|
if (!isAspspError(body)) return { type: 'give-up' }
|
|
|
|
// A window this account has fetched before is the strongest signal on hand
|
|
// that width is not the problem: stop after this one call. Wider than that:
|
|
// retry once at the known-good width, which is the cheapest test with the
|
|
// best odds, instead of spending three rungs on a bank that is saying no.
|
|
const requestedDays = historyWindowDays(activeDateFrom, dateTo)
|
|
if (acceptedHistoryDays !== undefined && requestedDays !== undefined) {
|
|
if (requestedDays <= acceptedHistoryDays) {
|
|
return { type: 'aspsp-unavailable', reason: 'window-already-accepted' }
|
|
}
|
|
const dateFrom = dateFromDaysBefore(dateTo, acceptedHistoryDays)
|
|
if (dateFrom) return { type: 'narrow', dateFrom }
|
|
}
|
|
|
|
// No accepted width on record (first sync, legacy rows): step date_from
|
|
// toward date_to (e.g. Danske past ~90 days) so a partial sync survives.
|
|
const dateFrom = nextNarrowerDateFrom(activeDateFrom, dateTo)
|
|
if (dateFrom) return { type: 'narrow', dateFrom }
|
|
return { type: 'aspsp-unavailable', reason: 'ladder-exhausted' }
|
|
}
|
|
|
|
/** Log and build the error both pagination loops throw on 'aspsp-unavailable'. */
|
|
function bankUnavailable(
|
|
accountUid: string,
|
|
status: number,
|
|
body: string,
|
|
reason: AspspUnavailableError['reason'],
|
|
activeDateFrom: string | undefined,
|
|
dateTo: string | undefined
|
|
): AspspUnavailableError {
|
|
console.warn('[enable-banking] ASPSP refused a request that narrowing cannot fix; treating the bank as unavailable', {
|
|
accountUid,
|
|
reason,
|
|
dateFrom: activeDateFrom,
|
|
dateTo,
|
|
status,
|
|
body,
|
|
})
|
|
return new AspspUnavailableError(status, body, reason, activeDateFrom)
|
|
}
|
|
|
|
/**
|
|
* Get all transactions with raw JSON responses for archival.
|
|
* Returns both parsed transactions and the raw response strings.
|
|
*
|
|
* If `strategy` is provided and the API rejects it with a 400 on the first
|
|
* request, retry once without `strategy` so unknown enum values can't break
|
|
* the sync. Logs a warning when the fallback fires.
|
|
*
|
|
* If the ASPSP then still rejects the first page with an ASPSP_ERROR (typically
|
|
* a history window beyond the bank's PSD2 limit, e.g. Danske past ~90 days),
|
|
* progressively narrow date_from toward date_to (90→60→30 days, or straight to
|
|
* options.acceptedHistoryDays when the account has one) so a partial sync of
|
|
* the recent window survives instead of failing outright. Logs a warning on
|
|
* each narrowing. A rejection that narrowing cannot fix throws
|
|
* AspspUnavailableError (see planFirstPageRecovery).
|
|
*
|
|
* The result names the date_from the bank finally ANSWERED (effectiveDateFrom)
|
|
* next to the one that was asked for, so a truncated window is visible to the
|
|
* caller instead of looking like a complete sync (#2202).
|
|
*/
|
|
export interface TransactionsWithRaw {
|
|
transactions: Transaction[]
|
|
rawPages: string[]
|
|
/** The date_from the caller asked for. */
|
|
requestedDateFrom: string | undefined
|
|
/** The date_from the bank answered: equal to requestedDateFrom unless narrowed. */
|
|
effectiveDateFrom: string | undefined
|
|
/** True when the bank refused the requested window and a narrower one was used. */
|
|
narrowed: boolean
|
|
}
|
|
|
|
export async function getAllTransactionsWithRaw(
|
|
accountUid: string,
|
|
dateFrom?: string,
|
|
dateTo?: string,
|
|
strategy?: TransactionsFetchStrategy,
|
|
options?: HistoryWindowOptions
|
|
): Promise<TransactionsWithRaw> {
|
|
const allTransactions: Transaction[] = []
|
|
const rawPages: string[] = []
|
|
let continuationKey: string | undefined
|
|
let page = 0
|
|
let activeStrategy = strategy
|
|
// date_from is narrowed in place when the ASPSP rejects the window (below).
|
|
let activeDateFrom = dateFrom
|
|
|
|
while (true) {
|
|
const params = new URLSearchParams()
|
|
if (activeDateFrom) params.set('date_from', activeDateFrom)
|
|
if (dateTo) params.set('date_to', dateTo)
|
|
if (continuationKey) params.set('continuation_key', continuationKey)
|
|
if (activeStrategy) params.set('strategy', activeStrategy)
|
|
params.set('limit', String(DEFAULT_PAGE_SIZE))
|
|
|
|
const queryString = params.toString()
|
|
const endpoint = `/accounts/${accountUid}/transactions${queryString ? `?${queryString}` : ''}`
|
|
|
|
const response = await authenticatedFetchWithRetry(endpoint)
|
|
|
|
if (!response.ok) {
|
|
const body = await response.text()
|
|
const recovery = planFirstPageRecovery({
|
|
status: response.status,
|
|
body,
|
|
page,
|
|
hasContinuationKey: !!continuationKey,
|
|
activeStrategy,
|
|
activeDateFrom,
|
|
dateTo,
|
|
acceptedHistoryDays: options?.acceptedHistoryDays,
|
|
})
|
|
if (recovery.type === 'drop-strategy') {
|
|
console.warn('[enable-banking] strategy rejected by API, retrying without strategy', {
|
|
accountUid,
|
|
strategy: activeStrategy,
|
|
body,
|
|
})
|
|
activeStrategy = undefined
|
|
continue
|
|
}
|
|
if (recovery.type === 'narrow') {
|
|
console.warn('[enable-banking] ASPSP rejected history window, retrying with narrower date_from', {
|
|
accountUid,
|
|
previousDateFrom: activeDateFrom,
|
|
nextDateFrom: recovery.dateFrom,
|
|
dateTo,
|
|
body,
|
|
})
|
|
activeDateFrom = recovery.dateFrom
|
|
continue
|
|
}
|
|
if (recovery.type === 'aspsp-unavailable') {
|
|
throw bankUnavailable(accountUid, response.status, body, recovery.reason, activeDateFrom, dateTo)
|
|
}
|
|
// An expired PSD2 session is an expected end of life for a consent, not
|
|
// a failure: SessionExpiredError below flips the connection to 'expired'
|
|
// and asks the user to re-authorize. Log it at warn so only the genuine
|
|
// ASPSP/upstream failures reach the error panel.
|
|
const sessionExpired = isSessionExpiredResponse(response.status, body)
|
|
const logLine = {
|
|
status: response.status,
|
|
statusText: response.statusText,
|
|
body,
|
|
accountUid,
|
|
dateFrom: activeDateFrom,
|
|
dateTo,
|
|
strategy: activeStrategy,
|
|
page,
|
|
hasContinuationKey: !!continuationKey,
|
|
}
|
|
if (sessionExpired) {
|
|
console.warn('[enable-banking] getAllTransactionsWithRaw: bank session expired', logLine)
|
|
throw new SessionExpiredError(response.status, body)
|
|
}
|
|
console.error('[enable-banking] getAllTransactionsWithRaw failed', logLine)
|
|
throw new Error(`Failed to get transactions (${response.status}): ${body}`)
|
|
}
|
|
|
|
const rawText = await response.text()
|
|
rawPages.push(rawText)
|
|
|
|
const data: TransactionsResponse = JSON.parse(rawText)
|
|
allTransactions.push(...data.transactions)
|
|
continuationKey = data.continuation_key
|
|
page++
|
|
|
|
if (page >= MAX_PAGINATION_PAGES) {
|
|
console.warn(`[enable-banking] Pagination cap reached (${MAX_PAGINATION_PAGES} pages) for account ${accountUid}`)
|
|
break
|
|
}
|
|
if (!continuationKey) break
|
|
}
|
|
|
|
return {
|
|
transactions: allTransactions,
|
|
rawPages,
|
|
requestedDateFrom: dateFrom,
|
|
effectiveDateFrom: activeDateFrom,
|
|
narrowed: activeDateFrom !== dateFrom,
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Convert Enable Banking transaction to legacy format
|
|
*/
|
|
export function convertTransaction(tx: Transaction, accountCurrency: string): BankTransaction {
|
|
const rawAmount = parseFloat(tx.transaction_amount.amount)
|
|
|
|
// Use credit_debit_indicator to determine sign
|
|
// CRDT = credit (money in) = positive
|
|
// DBIT = debit (money out) = negative
|
|
const isCredit = tx.credit_debit_indicator === 'CRDT'
|
|
const amount = isCredit ? Math.abs(rawAmount) : -Math.abs(rawAmount)
|
|
|
|
// Get counterparty name from creditor/debtor objects or direct fields
|
|
const creditorName = tx.creditor?.name || tx.creditor_name
|
|
const debtorName = tx.debtor?.name || tx.debtor_name
|
|
|
|
return {
|
|
id: tx.entry_reference || tx.transaction_id || `${tx.booking_date}_${rawAmount}`,
|
|
date: tx.value_date || tx.booking_date || new Date().toISOString().split('T')[0],
|
|
booking_date: tx.booking_date || tx.value_date || new Date().toISOString().split('T')[0],
|
|
amount,
|
|
currency: tx.transaction_amount.currency || accountCurrency,
|
|
// Fallback chain: bank's payment message → counterparty name → a Swedish
|
|
// label derived from the ISO 20022 / MCC codes the bank DID send (card
|
|
// purchases, ATM, fees, interest) → 'Okänd transaktion'. The final fallback
|
|
// is also normalized at the ingest boundary, so any leftover lands as the
|
|
// same Swedish neutral.
|
|
description: tx.remittance_information?.filter(r => r.trim()).join(' ') ||
|
|
(isCredit ? debtorName : creditorName) ||
|
|
deriveTransactionLabel({
|
|
bankTransactionCode: tx.bank_transaction_code,
|
|
proprietaryBankTransactionCode: tx.proprietary_bank_transaction_code,
|
|
mcc: tx.merchant_category_code,
|
|
isCredit,
|
|
}) ||
|
|
FALLBACK_DESCRIPTION,
|
|
counterparty_name: isCredit ? debtorName : creditorName,
|
|
counterparty_account: isCredit
|
|
? pickAccountIdentifier(tx.debtor_account, tx.debtor_account_additional_identification)
|
|
: pickAccountIdentifier(tx.creditor_account, tx.creditor_account_additional_identification),
|
|
merchant_category_code: tx.merchant_category_code,
|
|
bank_transaction_code: tx.bank_transaction_code,
|
|
proprietary_bank_transaction_code: tx.proprietary_bank_transaction_code,
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Whether the current configuration targets the sandbox API
|
|
*/
|
|
export function isSandboxMode(): boolean {
|
|
return ENABLE_BANKING_API_URL.includes('tilisy')
|
|
}
|
|
|
|
// Utility functions
|
|
|
|
/**
|
|
* Check if consent is expiring soon (within 7 days)
|
|
*/
|
|
export function isConsentExpiringSoon(expiresAt: string | null): boolean {
|
|
if (!expiresAt) return false
|
|
|
|
const expiryDate = new Date(expiresAt)
|
|
const warningDate = new Date()
|
|
warningDate.setDate(warningDate.getDate() + 7)
|
|
|
|
return expiryDate <= warningDate
|
|
}
|
|
|
|
/**
|
|
* Get days until consent expires
|
|
*/
|
|
export function getDaysUntilExpiry(expiresAt: string | null): number | null {
|
|
if (!expiresAt) return null
|
|
|
|
const expiryDate = new Date(expiresAt)
|
|
const now = new Date()
|
|
const diffTime = expiryDate.getTime() - now.getTime()
|
|
const diffDays = Math.ceil(diffTime / (1000 * 60 * 60 * 24))
|
|
|
|
return Math.max(0, diffDays)
|
|
}
|