import {z} from 'zod' export type GetApiFinancialDataV2TransactionsIdArgs = {id: string}; export type GetApiFinancialDataV2TransactionsIdOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const resourceID = z.string().min(32).max(64); export const organizationID = z.string(); export const date = z.string(); export const currencyCode = z.string().min(3).max(3); export const amount = z.object({currency: currencyCode, stringValue: z.string(), value: z.number().int()}); export const transactionReferences = z.object({mandateReference: z.string().optional(), endToEndId: z.string().optional(), bankTransactionReference: z.string().optional()}); export const transactionReconciliationStatus = z.enum(["RECONCILED", "PARTIALLY_RECONCILED", "NOT_RECONCILED"]); export const marketCode = z.string().min(2).max(2); export const nationalIdentifier = z.object({type: z.enum(["CIVIC", "COMPANY"]), market: marketCode, number: z.string()}); export const countryCode = z.string().min(2).max(2); export const countrySubdivision = z.string().max(6); export const accountIdentifierType = z.enum(["IBAN", "NUMBER", "ADYEN", "AU_BPAY_BILLER_CODE", "DK_FIK", "INVESTMENT_NUMBER", "MY_JOMPAY_BILLER_CODE", "NATIONAL_ID_NUMBER", "PAYPAL", "PROPRIETARY", "SE_BANKGIRO", "SE_PLUSGIRO", "SOLDO", "WALLET_ADYEN_BALANCE_PLATFORM", "WALLET_AIRWALLEX", "WALLET_AIRWALLEX_NUMBER", "WALLET_CURRENCYCLOUD", "WALLET_FLASH_PAYMENTS", "WALLET_FREEMARKET", "WALLET_HYPERWALLET", "WALLET_INPAY", "WALLET_LEAD", "WALLET_MERCURY", "WALLET_MONEYCORP", "WALLET_PAYHAWK", "WALLET_REVOLUT", "WALLET_SKRILL", "WALLET_STRIPE", "WALLET_SWISSQUOTE", "WALLET_UNIT"]); export const accountIdentifier = z.object({type: accountIdentifierType, market: marketCode, number: z.string().min(1).max(255), invalid: z.boolean().optional()}); export const routingIdentifierType = z.enum(["BIC", "AT_BLZ", "AU_BSB", "BD_BRN", "BR_BRANCH", "BR_COMPE", "BR_ISP", "CA_CPA", "CH_BCC", "CH_SIC", "CL_SBIF", "CN_APS", "CZ_NBC", "DE_BLZ", "ES_NCC", "GB_DSC", "GR_BIC", "HK_NCC", "IE_NCC", "IL_NCC", "IN_FSC", "IT_NCC", "JP_ZGN", "KR_BOK", "KR_KFTC", "MX_ABM", "MY_NCC", "NZ_NCC", "PH_BRSTN", "PL_KNR", "PT_NCC", "RU_CBC", "SE_SBA", "SG_IBG", "TH_CBC", "TW_NCC", "US_ABA", "US_PID", "VN_CITAD", "ZA_NCC"]); export const routingConstraints = z.object({accountNumberType: accountIdentifierType.optional(), scheme: z.string().optional()}); export const routingIdentifier = z.object({type: routingIdentifierType, number: z.string().min(1).max(255), invalid: z.boolean().optional(), constraints: routingConstraints.optional()}); export const counterpartyAccount = z.object({market: marketCode.optional(), identifiers: z.array(accountIdentifier), routing: z.array(routingIdentifier).optional(), rawIdentifier: z.string()}); export const counterpartyDetails = z.object({partyType: z.enum(["INDIVIDUAL", "COMPANY"]).optional(), name: z.string().optional(), nationalIdentifier: nationalIdentifier.optional(), address: z.object({country: countryCode.optional(), countrySubdivision: countrySubdivision.optional(), city: z.string().max(64).optional(), postalCode: z.string().max(16).optional(), streetName: z.string().max(64).optional(), streetNumber: z.string().max(16).optional(), rawAddressLines: z.array(z.string().max(255)).optional()}).optional(), account: counterpartyAccount.optional()}); export const proprietaryBankTransactionCode = z.object({code: z.string().max(35).nullable().optional(), issuer: z.string().max(35).nullable().optional()}); export const bankTransactionCode = z.object({domain: z.string().max(4), family: z.string().max(4).nullable().optional(), subfamily: z.string().max(4).nullable().optional(), proprietary: proprietaryBankTransactionCode.optional(), description: z.string().nullable().optional()}); export const returnReason = z.object({code: z.string().optional(), description: z.string().optional(), originalBankTransactionCode: bankTransactionCode.optional()}); export const currencyExchange = z.object({exchangeRate: z.string(), sourceCurrency: currencyCode, targetCurrency: currencyCode.optional(), unitCurrency: currencyCode.optional()}); export const chargeType = z.enum(["BROKERAGE_FEE", "COMMISSION", "SUMMATION", "BATCH", "AMENDMENT", "CANCELLATION_FEE", "CLEARING_FEE", "INVESTIGATION", "INTEREST", "NON_STP_CHARGES", "BORNE_BY_DEBTOR", "TELECOMMUNICATION_CHARGES", "ACCOUNT_MAINTENANCE_FEE", "REPORTING_CHARGES"]); export const chargeBearer = z.enum(["SHARED", "DEBTOR", "CREDITOR", "SERVICE_LEVEL"]); export const chargeIncluded = z.enum(["INCLUDED", "NOT_INCLUDED", "UNSPECIFIED"]); export const transactionCharge = z.object({amount: amount, type: chargeType.optional(), proprietaryType: z.string().optional(), chargeBearer: chargeBearer.optional(), included: chargeIncluded}); export const transactionVirtualAccount = z.object({market: marketCode.optional(), identifiers: z.array(accountIdentifier), routing: z.array(routingIdentifier).optional()}); export const batchInformation = z.object({transactionCount: z.number().int(), totalAmount: amount.optional()}); export const attachedTransactableRef = z.object({type: z.enum(["CREDIT_TRANSFER", "DIRECT_DEBIT", "EXPECTED_TRANSACTION", "PAYMENT_BATCH", "CONNECTION_INSTRUCTION"]), id: resourceID}); export const internalTransferRef = z.object({internalTransferId: resourceID, counterpartTransactionId: resourceID.optional(), counterpartAccountId: resourceID, status: z.enum(["PENDING", "CONFIRMED"]).optional()}); export const createdTimestamp = z.string(); export const updatedTimestamp = z.string(); export const resourceVersion = z.number().int().gte(1); export const eTag = z.string(); export const metadata = z.record(z.string(), z.string()).nullable(); export const transaction = z.object({id: resourceID, organizationId: organizationID, accountId: z.string(), date: date, amount: amount, reference: z.string().optional(), references: transactionReferences.optional(), reconciliationStatus: transactionReconciliationStatus, counterparty: counterpartyDetails.optional(), description: z.string(), instructedAmount: amount.optional(), bankTransactionCode: bankTransactionCode.optional(), valueDate: date.optional(), returned: z.boolean(), returnReason: returnReason.optional(), currencyExchange: currencyExchange.optional(), charges: z.array(transactionCharge).optional(), virtualAccount: transactionVirtualAccount.optional(), batchInformation: batchInformation.optional(), attachedTransactables: z.array(attachedTransactableRef), internalTransfer: internalTransferRef.optional(), created: createdTimestamp, updated: updatedTimestamp, version: resourceVersion, etag: eTag, metadata: metadata.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 transaction * * GET /financial-data/v2/transactions/{id} */ export const getApiFinancialDataV2TransactionsId = async (args: GetApiFinancialDataV2TransactionsIdArgs, options?: GetApiFinancialDataV2TransactionsIdOptions) => { const {baseUrl = "https://api.atlar.com", 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(/\/+$/, '')}/financial-data/v2/transactions/${encodeURIComponent(String(args.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(transaction, await res.json()) };