import {z} from 'zod' export type GetApiRisksTransactionIdArgs = {'transaction-id': string}; export type GetApiRisksTransactionIdOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const countryId = z.enum(["DE", "AT", "CH"]); export const metadata = z.record(z.string(), z.unknown()).nullable(); export const xs2aAccountSnapshotResponse = z.object({object: z.string().optional(), days: z.number().int().optional(), from: z.string().optional(), to: z.string().optional(), filters: z.array(z.string()).optional(), all_tags: z.string().optional(), created_at: z.string().optional()}); export const xs2aAgeVerificationCheckResponse = z.object({confirmed: z.boolean().optional(), created_at: z.string().optional(), object: z.string().optional()}); export const currencyId = z.enum(["EUR", "CHF"]); export const xs2aBalanceCheckResponse = z.object({object: z.string().optional(), check_amount: z.number().int().optional(), check_currency_id: currencyId.optional(), check_passed: z.string().optional(), created_at: z.string().optional()}); export const xs2aBalanceOverviewResponse = z.object({object: z.string().optional(), balance: z.number().nullable().optional(), available: z.number().nullable().optional(), limit: z.number().nullable().optional(), currency_id: currencyId.optional(), created_at: z.string().optional()}); export const xs2aCashflowObject = z.object({month: z.number().int().optional(), incoming: z.number().optional(), outgoing: z.number().optional(), minimum_balance: z.number().optional(), incoming_transactions: z.number().int().optional(), outgoing_transactions: z.number().int().optional(), currency_id: currencyId.optional()}); export const xs2aCashflowOverviewResponse = z.object({created_at: z.string().optional(), object: z.string().optional(), cashflow: z.array(xs2aCashflowObject).optional()}); export const xs2aChargebackCheckResponse = z.object({chargebacks_count: z.number().int().optional(), chargebacks_coverage: z.number().int().optional(), chargebacks_revoked: z.number().int().optional(), chargebacks_sum_amount: z.number().optional(), currency_id: currencyId.optional(), object: z.string().optional(), created_at: z.string().optional()}); export const xs2aChildrenCheckResponse = z.object({children_at_account_holder: z.number().int().optional()}); export const xs2aRiskInsuranceContractCheckResponse = z.object({result: z.object({category_id: z.string().optional(), counter_iban: z.string().optional(), counter_holder: z.string().optional(), insurance_policy_number: z.array(z.string()).optional(), count: z.number().int().optional(), periodicity: z.string().optional(), last_amount: z.number().int().optional(), average_amount: z.number().int().optional(), total_amount: z.number().int().optional(), meta_data: z.array(z.string()).optional()}).optional()}); export const xs2aProfitLossCheckResponse = z.object({result: z.object({tax_ids: z.array(z.string()).optional(), profit_loss: z.object({period_start: z.string().optional(), period_end: z.string().optional(), period_days: z.number().int().optional(), turnover_income: z.number().optional(), cash_deposit: z.number().optional(), other_income: z.number().optional(), rent_expense: z.number().optional(), supplies_expense: z.number().optional(), personnel_expense: z.number().optional(), tax_expense: z.number().optional(), other_expense: z.number().optional(), cashflow: z.number().optional(), cashflow_revenue_ratio: z.number().optional()}).optional()}).optional()}); export const monthlySums = z.record(z.string(), z.number()); export const employer = z.object({name: z.string().optional(), months_with_salaries_count: z.number().int().optional(), booking_date_first_salary: z.string().optional(), booking_date_last_salary: z.string().optional(), months_sums_median: z.number().optional(), months_sums_minimum: z.number().optional(), public_employer: z.boolean().optional(), current_employer: z.boolean().optional()}); export const xs2aIncomeCheckResponse = z.object({data: z.object({full_months_count: z.number().int().optional(), category_short_name: z.object({monthly_sums: monthlySums.optional(), months_sums_median: z.number().optional(), months_sums_minimum: z.number().optional(), min_date: z.string().optional(), max_date: z.string().optional(), current_payment: z.boolean().optional(), forecast: z.number().optional(), forecast_month_count: z.number().int().optional(), current_employers: z.number().int().optional(), employer: employer.optional()}).optional()}).optional(), created_at: z.string().optional()}); export const xs2aAccountLinkedOffersCheckResponse = z.object({links: z.array(z.object({link: z.string().optional(), description: z.string().optional(), image: z.string().optional()})).optional()}); export const checksResult = z.object({amount: z.number().optional(), currency: currencyId.optional()}); export const xs2aCreditCheckResponse = z.object({checks: z.array(z.string()).optional(), check_days: z.number().int().optional(), results: z.object({income: checksResult.optional(), rent: checksResult.optional()}).optional(), object: z.string().optional(), created_at: z.string().optional()}); export const xs2aDirectDebitCheckResponse = z.object({check_amount: z.number().optional(), check_currency_id: currencyId.optional(), start_date: z.string().optional(), end_date: z.string().optional(), recommendation: z.enum(["DATE", "ANY", "REJECT"]).optional(), recommendation_date: z.string().optional(), object: z.string().optional(), created_at: z.string().optional()}); export const xs2aFactSheetListsResponse = z.object({fields: z.array(z.object({name: z.string().optional(), tags: z.array(z.string()).optional(), categories: z.array(z.string()).optional(), min_amount: z.number().optional(), max_amount: z.number().optional()})).optional(), days: z.number().int().optional(), result: z.array(z.object({fields: z.object({name: z.string().optional(), categories: z.array(z.string()).optional(), tags: z.array(z.string()).optional(), min_amount: z.number().optional(), max_amount: z.number().optional()}).optional(), turnovers_count: z.number().int().optional(), sum_amounts: z.number().optional(), timespan: z.number().int().optional(), distinct_counter_holders: z.number().int().optional(), turnovers: z.number().int().optional()})).optional(), created_at: z.string().optional(), object: z.string().optional()}); export const xs2aNameCheckResponse = z.object({name: z.string().optional(), firstname: z.string().optional(), match: z.string().optional(), similarity: z.number().int().optional(), created_at: z.string().optional(), object: z.string().optional()}); export const xs2aOverdraftLimitCheckResponse = z.object({booking_days: z.number().int().optional(), overdraft_limit_days: z.number().int().optional(), maximum_overdraft_used: z.number().optional(), average_overdraft_used: z.number().optional(), median_overdraft_used: z.number().optional(), currency_id: currencyId.optional(), object: z.string().optional(), created_at: z.string().optional()}); export const xs2aSeizureCheckResponse = z.object({is_seizure: z.number().int().optional(), days: z.number().int().optional(), object: z.string().optional(), created_at: z.string().optional()}); export const bankAccountObject = z.object({holder: z.string().optional(), description: z.string().optional(), iban: z.string().optional(), bic: z.string().optional(), country_id: countryId.optional()}); export const xs2aStandingOrdersCheckResponse = z.object({standing_orders: z.array(z.object({sender_account: bankAccountObject.optional(), recipient_account: bankAccountObject.optional(), amount: z.number().optional(), currency: currencyId.optional(), purpose: z.string().optional(), frequency: z.enum(["d", "w", "m", "y"]).optional(), frequency_interval: z.number().int().optional(), day: z.number().int().optional(), start_execution: z.string().optional(), end_execution: z.string().nullable().optional()})).optional(), object: z.string().optional(), created_at: z.string().optional()}); export const xs2aAllAccountsCheckResponse = z.object({accounts: z.array(bankAccountObject).optional(), object: z.string().optional(), created_at: z.string().optional()}); export const userAccountsObject = z.object({identifier: z.string().optional(), holder: z.string().optional(), description: z.string().optional(), iban: z.string().optional(), bic: z.string().optional(), account_number: z.string().optional(), bank_code: z.string().optional(), bank_name: z.string().optional(), country_id: countryId.optional(), joint_account: z.string().optional(), transaction_possible: z.boolean().optional(), account_type: z.string().optional(), balance: z.number().nullable().optional(), available: z.number().nullable().optional(), limit: z.number().nullable().optional(), currency_id: currencyId.optional(), turnover_days: z.number().int().optional(), turnover_available_days: z.number().int().optional(), turnover_count: z.number().int().optional(), average_account_usage: z.string().optional(), overdraft_days: z.number().int().optional(), overdraft_limit_days: z.number().int().optional(), completeness: z.object({counter_holder: z.string().optional(), counter_iban: z.string().optional(), purpose: z.string().optional()}).optional(), account_data_available: z.string().optional()}); export const otherAccountsObject = z.object({holder: z.string().optional(), iban: z.string().optional(), bic: z.string().optional(), country_id: countryId.optional(), bank_name: z.string().optional(), type: z.string().optional()}); export const creditCardsObject = z.object({holder: z.string().optional(), iban: z.string().optional(), bic: z.string().optional(), country_id: z.string().optional(), bank_name: z.string().optional(), description: z.string().optional()}); export const xs2aAccountStatusCheckResponse = z.object({account_details: z.array(userAccountsObject).optional(), other_accounts: z.array(otherAccountsObject).optional(), credit_cards: z.array(creditCardsObject).optional(), days: z.number().int().optional(), all_accounts: z.string().optional(), created_at: z.string().optional(), object: z.string().optional()}); export const matchesObject = z.object({expected_holder: z.string().optional(), match: z.enum(["NONE", "PERSON", "LAST_NAME", "COMPANY"]).optional()}); export const accountHoldersObject = z.object({type: z.string().optional(), holder: z.string().optional(), iban: z.string().optional(), matches: z.array(matchesObject).optional()}); export const xs2aHolderIdentificationCheckResponse = z.object({expect_holders: z.array(z.string()).optional(), accounts: z.array(accountHoldersObject).optional(), object: z.string().optional(), created_at: z.string().optional()}); export const calculationsTags = z.string(); export const calculationsCategories = z.string(); export const calculationsFunctions = z.enum(["sum", "count", "median", "average", "last", "min", "max", "min_date", "max_date", "clean_sum", "exists", "sums_of_every_month", "counts_of_every_month", "median_of_all_month_sums", "average_of_all_month_sums", "min_of_all_month_sums", "max_of_all_month_sums", "distinct_counter_holders"]); export const riskCalculationsResponse = z.object({tags: z.array(calculationsTags).optional(), categories: z.array(calculationsCategories).optional(), functions: z.array(calculationsFunctions).optional(), name: z.string().optional(), days: z.number().int().optional(), from: z.string().optional(), to: z.string().optional(), full_months: z.string().optional(), results: z.object({}).optional()}); export const xs2aRiskCalculationsCheckResponse = z.object({calculations: z.array(riskCalculationsResponse).optional(), created_at: z.string().optional(), object: z.string().optional()}); export const chargebacksObject = z.object({chargebacks_coverage_count: z.number().int().optional(), chargebacks_coverage_amount: z.number().optional(), chargebacks_revoke_count: z.number().int().optional(), chargebacks_revoke_amount: z.number().optional()}); export const encashmentObject = z.object({collection_count: z.number().int().optional(), collection_amount: z.number().optional(), collection_office_count: z.number().int().optional()}); export const accountProfileObject = z.object({cash_withdrawals: z.number().int().optional(), cash_deposits: z.number().int().optional(), payment_gez: z.string().optional(), payment_schufa: z.string().optional(), payment_donation: z.string().optional(), payment_party: z.string().optional(), payment_club: z.string().optional()}); export const loansObject = z.object({loans_count: z.number().int().optional(), loans_amount: z.number().optional(), subprime_lender_count: z.number().int().optional()}); export const flagsObject = z.record(z.string(), z.string()); export const xs2aAccountCharacteristicsCheckResponse = z.object({chargebacks: chargebacksObject.optional(), encashment: encashmentObject.optional(), account_profile: accountProfileObject.optional(), loans: loansObject.optional(), flags: flagsObject.optional(), object: z.string().optional(), created_at: z.string().optional()}); export const xs2aCollectionCheckResponse = z.object({result: z.object({instant_payment: z.boolean().optional(), monthly_installment: z.array(z.object({value: z.number().optional(), currency_id: z.string().optional(), day_of_month: z.number().int().optional()})).optional(), suspension: z.boolean().optional(), cash_flow_per_month: z.array(z.object({value: z.number().optional(), currency_id: z.string().optional(), periods: z.number().int().optional()})).optional(), motor_vehicle: z.boolean().optional(), real_estate: z.boolean().optional(), seizure: z.boolean().optional(), usable_account: z.boolean().optional(), debt_collection: z.array(z.object({sum: z.number().optional(), payments: z.number().int().optional(), currency_id: z.string().optional(), average_per_month: z.number().optional()})).optional()}).optional()}); export const riskObject = z.object({id: z.string().optional(), transaction: z.string().optional(), account_holder: z.string().optional(), iban: z.string().optional(), bic: z.string().optional(), bank_name: z.string().optional(), country_id: countryId.optional(), testmode: z.string().optional(), created_at: z.string().optional(), metadata: metadata.optional(), merchant_id: z.string().optional(), object: z.string().optional(), xs2a_account_snapshot: xs2aAccountSnapshotResponse.optional(), xs2a_age_verification_check: xs2aAgeVerificationCheckResponse.optional(), xs2a_balance_check: xs2aBalanceCheckResponse.optional(), xs2a_balance_overview: xs2aBalanceOverviewResponse.optional(), xs2a_cashflow_overview: xs2aCashflowOverviewResponse.optional(), xs2a_chargeback_check: xs2aChargebackCheckResponse.optional(), xs2a_children_check: xs2aChildrenCheckResponse.optional(), xs2a_risk_insurance_contract_check: xs2aRiskInsuranceContractCheckResponse.optional(), xs2a_profit_loss_check: xs2aProfitLossCheckResponse.optional(), xs2a_income_check: xs2aIncomeCheckResponse.optional(), xs2a_account_linked_offers_check: xs2aAccountLinkedOffersCheckResponse.optional(), xs2a_credit_check: xs2aCreditCheckResponse.optional(), xs2a_direct_debit_check: xs2aDirectDebitCheckResponse.optional(), xs2a_fact_sheet_lists: xs2aFactSheetListsResponse.optional(), xs2a_name_check: xs2aNameCheckResponse.optional(), xs2a_overdraft_limit_check: xs2aOverdraftLimitCheckResponse.optional(), xs2a_seizure_check: xs2aSeizureCheckResponse.optional(), xs2a_standing_orders_check: xs2aStandingOrdersCheckResponse.optional(), xs2a_all_accounts_check: xs2aAllAccountsCheckResponse.optional(), xs2a_account_status_check: xs2aAccountStatusCheckResponse.optional(), xs2a_holder_identification_check: xs2aHolderIdentificationCheckResponse.optional(), xs2a_risk_calculations_check: xs2aRiskCalculationsCheckResponse.optional(), xs2a_account_characteristics_check: xs2aAccountCharacteristicsCheckResponse.optional(), xs2a_collection_check: xs2aCollectionCheckResponse.optional()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Get a xs2a.risk transaction object * * GET /risks/{transaction-id} */ export const getApiRisksTransactionId = async (args: GetApiRisksTransactionIdArgs, options?: GetApiRisksTransactionIdOptions) => { const {baseUrl = "https://api.xs2a.com/v1", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/risks/${encodeURIComponent(String(args['transaction-id']))}${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(riskObject, await res.json()) };