Files
accounted/extensions/general/enable-banking/lib/api-client.ts
T
MattssonandClaude Opus 4.7 ed9bdc4c00 Bug/transaction import (#435)
* fix(invoices): drop UTKAST banner on numbered invoices and preserve logo aspect ratio

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* revert(invoices): restore UTKAST banner for drafts; keep logo aspect ratio fix

Numbered drafts intentionally surface UTKAST until manually marked sent.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* revert(invoices): drop logo objectFit change

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

* feat(enable-banking): implement transaction fetch strategy and update related logic

---------

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-11 00:27:44 +02:00

701 lines
20 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'
// 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
available_auth_methods?: AuthMethod[]
}
export interface AuthMethod {
name: string
title?: string
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
}
export interface AccountInfo {
uid: string
account_id?: {
iban?: string
bban?: string
other?: string
}
name?: string
product?: string
currency: string
identification_hash?: string
}
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?: {
iban?: string
bban?: string
}
creditor?: {
name?: string
}
debtor_name?: string
debtor_account?: {
iban?: string
bban?: string
}
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'
// Legacy types for backward compatibility
export interface Bank {
id: string
name: string
bic?: string
countries: string[]
logo_url?: string
}
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
}
// 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
// API Helper
async function authenticatedFetch(
endpoint: string,
options: RequestInit = {}
): Promise<Response> {
const url = `${ENABLE_BANKING_API_URL}${endpoint}`
const controller = new AbortController()
const timeout = setTimeout(() => controller.abort(), FETCH_TIMEOUT_MS)
try {
const response = await fetch(url, {
...options,
signal: controller.signal,
headers: {
'Authorization': getAuthorizationHeader(),
'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)) {
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 || []
}
/**
* Get list of supported banks (legacy format for backward compatibility)
*/
export async function getSupportedBanks(): Promise<Bank[]> {
try {
const aspsps = await getASPSPs('SE')
return aspsps.map((aspsp) => ({
id: `${aspsp.name.toLowerCase().replace(/\s+/g, '-')}-se`,
name: aspsp.name,
bic: aspsp.bic,
countries: [aspsp.country],
logo_url: aspsp.logo,
}))
} catch (error) {
console.error('Error fetching banks:', error)
// Return fallback list
return [
{ id: 'nordea-se', name: 'Nordea', bic: 'NDEASESS', countries: ['SE'] },
{ id: 'seb-se', name: 'SEB', bic: 'ESSESESS', countries: ['SE'] },
{ id: 'swedbank-se', name: 'Swedbank', bic: 'SWEDSESS', countries: ['SE'] },
{ id: 'handelsbanken-se', name: 'Handelsbanken', bic: 'HANDSESS', countries: ['SE'] },
]
}
}
/**
* 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'
*/
export async function startAuthorization(
aspspName: string,
aspspCountry: string,
redirectUrl: string,
state: string,
psuType: 'personal' | 'business' = 'personal'
): Promise<AuthResponse> {
// Calculate consent validity (90 days)
const validUntil = new Date()
validUntil.setDate(validUntil.getDate() + 90)
const requestBody = {
access: {
valid_until: validUntil.toISOString()
},
aspsp: {
name: aspspName,
country: aspspCountry
},
state,
redirect_url: redirectUrl,
psu_type: psuType
}
const response = await authenticatedFetch('/auth', {
method: 'POST',
body: JSON.stringify(requestBody)
})
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
*/
export async function createSession(code: string): Promise<SessionResponse> {
const response = await authenticatedFetch('/sessions', {
method: 'POST',
body: JSON.stringify({ 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()
}
/**
* 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()
console.error('[enable-banking] deleteSession failed', {
status: response.status,
statusText: response.statusText,
body,
sessionId,
})
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 || []
}
/**
* Get account balance (returns booked balance amount)
*/
export async function getAccountBalance(
accountUid: string
): Promise<{ amount: number; date: string }> {
const balances = await getAccountBalances(accountUid)
// Prefer closingBooked, then expected, then first available
const balance =
balances.find(b => b.balance_type === 'closingBooked') ||
balances.find(b => b.balance_type === 'expected') ||
balances[0]
if (!balance) {
return { amount: 0, date: new Date().toISOString().split('T')[0] }
}
return {
amount: parseFloat(balance.balance_amount.amount),
date: balance.reference_date || new Date().toISOString().split('T')[0]
}
}
/**
* 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,
})
throw new Error(`Failed to get transactions (${response.status}): ${body}`)
}
return response.json()
}
/**
* Get all transactions with pagination
*/
export async function getAllTransactions(
accountUid: string,
dateFrom?: string,
dateTo?: string,
strategy?: TransactionsFetchStrategy
): Promise<Transaction[]> {
const allTransactions: Transaction[] = []
let continuationKey: string | undefined
let page = 0
do {
const response = await getAccountTransactions(
accountUid,
dateFrom,
dateTo,
continuationKey,
strategy
)
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
}
} while (continuationKey)
return allTransactions
}
/**
* 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.
*/
export async function getAllTransactionsWithRaw(
accountUid: string,
dateFrom?: string,
dateTo?: string,
strategy?: TransactionsFetchStrategy
): Promise<{ transactions: Transaction[]; rawPages: string[] }> {
const allTransactions: Transaction[] = []
const rawPages: string[] = []
let continuationKey: string | undefined
let page = 0
let activeStrategy = strategy
while (true) {
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 (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()
// If the API rejects an unknown strategy on the very first request,
// fall back to the implicit default and retry the same page.
if (response.status === 400 && activeStrategy && page === 0 && !continuationKey) {
console.warn('[enable-banking] strategy rejected by API, retrying without strategy', {
accountUid,
strategy: activeStrategy,
body,
})
activeStrategy = undefined
continue
}
console.error('[enable-banking] getAllTransactionsWithRaw failed', {
status: response.status,
statusText: response.statusText,
body,
accountUid,
dateFrom,
dateTo,
strategy: activeStrategy,
page,
hasContinuationKey: !!continuationKey,
})
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 }
}
/**
* 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,
description: tx.remittance_information?.filter(r => r.trim()).join(' ') ||
(isCredit ? debtorName : creditorName) ||
'Unknown',
counterparty_name: isCredit ? debtorName : creditorName,
counterparty_account: isCredit
? tx.debtor_account?.iban || tx.debtor_account?.bban
: tx.creditor_account?.iban || tx.creditor_account?.bban,
merchant_category_code: tx.merchant_category_code
}
}
/**
* Get transactions in legacy format
*/
export async function getTransactions(
accountUid: string,
fromDate?: string,
toDate?: string,
accountCurrency: string = 'SEK'
): Promise<BankTransaction[]> {
const transactions = await getAllTransactions(accountUid, fromDate, toDate)
return transactions.map(tx => convertTransaction(tx, accountCurrency))
}
/**
* 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)
}