import {z} from 'zod' export type BinPageOffsetToken = string; export type GetApiReportsReconciliationDetailsArgs = {from?: string | undefined, to?: string | undefined, sortOrder?: ('asc' | 'desc') | undefined, limit?: number | undefined, offsetToken?: BinPageOffsetToken | undefined}; export type GetApiReportsReconciliationDetailsOptions = {baseUrl?: string | undefined, ApiKey?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const componentsSchemasAcquirerBin = z.string(); export const americanExpressAquirerBin = z.string(); export const componentsSchemasBinKey = z.string(); export const bin = z.object({description: z.string(), acquirerBin: z.union([componentsSchemasAcquirerBin, americanExpressAquirerBin]), key: componentsSchemasBinKey}); export const componentsSchemasDoingBusinessAsName = z.string().min(1); export const acceptorKey = z.string().min(5).max(120); export const componentsSchemasMid = z.string(); export const americanExpressMid = z.string(); export const merchantAcceptor = z.object({legalName: z.string().min(1), doingBusinessAsName: componentsSchemasDoingBusinessAsName, description: z.string().min(1), key: acceptorKey, mid: z.union([componentsSchemasMid, americanExpressMid])}); export const componentsSchemasChargeKey = z.string(); export const openapiComponentsSchemasCurrencyCode5 = z.enum(["EUR", "USD", "AFN", "ALL", "DZD", "AOA", "XCD", "ARS", "AMD", "AWG", "AUD", "AZN", "BSD", "BHD", "BDT", "BBD", "BYN", "BZD", "XOF", "BMD", "INR", "BTN", "BOB", "BAM", "BWP", "NOK", "BRL", "BND", "BGN", "BIF", "CVE", "KHR", "XAF", "CAD", "KYD", "CLP", "CNY", "COP", "KMF", "CDF", "NZD", "CRC", "HRK", "CUP", "CUC", "ANG", "CZK", "DKK", "DJF", "DOP", "EGP", "SVC", "ERN", "ETB", "FKP", "FJD", "XPF", "GMD", "GEL", "GHS", "GIP", "GTQ", "GBP", "GNF", "GYD", "HTG", "HNL", "HKD", "HUF", "ISK", "IDR", "IRR", "IQD", "ILS", "JMD", "JPY", "JOD", "KZT", "KES", "KPW", "KRW", "KWD", "KGS", "LAK", "LBP", "LSL", "ZAR", "LRD", "LYD", "CHF", "MOP", "MKD", "MGA", "MWK", "MYR", "MVR", "MRU", "MUR", "MXN", "MDL", "MNT", "MAD", "MZN", "MMK", "NAD", "NPR", "NIO", "NGN", "OMR", "PKR", "PAB", "PGK", "PYG", "PEN", "PHP", "PLN", "QAR", "RON", "RUB", "RWF", "SHP", "WST", "STN", "SAR", "RSD", "SCR", "SLL", "SGD", "SBD", "SOS", "SSP", "LKR", "SDG", "SRD", "SZL", "SEK", "SYP", "TWD", "TJS", "TZS", "THB", "TOP", "TTD", "TND", "TRY", "TMT", "UGX", "UAH", "AED", "UYU", "UYW", "UZS", "VUV", "VES", "VND", "YER", "ZMW", "ZWL"]); export const openapiComponentsSchemasAmountValue3 = z.number().int().gte(0).lte(900000000); export const settlementAmountInteger = z.object({currency: openapiComponentsSchemasCurrencyCode5, value: openapiComponentsSchemasAmountValue3, impact: z.enum(["credit", "debit"])}); export const floatAmountValue = z.number(); export const rate = z.object({date: z.string().optional(), sourceCurrency: openapiComponentsSchemasCurrencyCode5.optional(), targetCurrency: openapiComponentsSchemasCurrencyCode5.optional(), rate: z.number().optional(), exponent: z.number().optional(), operation: z.enum(["multiply", "divide"]).optional(), type: z.enum(["buy", "sell", "mid"]).optional()}); export const currencyConversionRates = z.array(rate); export const settlementAmountFloatWithRate = z.object({currency: openapiComponentsSchemasCurrencyCode5, value: floatAmountValue, impact: z.enum(["credit", "debit"]), currencyConversionRates: currencyConversionRates.optional()}); export const componentsSchemasTransactionReference = z.string().min(1).max(120); export const componentsSchemasActionKey = z.string().min(5).max(120); export const componentsSchemasActionReference = z.string().min(1).max(120); export const componentsSchemasAcquirerIdCode = z.string(); export const transactionType = z.enum(["purchase", "refund", "payout", "funding"]); export const schemasTags = z.record(z.string(), z.string()); export const openapiComponentsSchemasCountryCodeAlpha3 = z.string(); export const openapiComponentsSchemasCountryCodeAlpha2 = z.string(); export const openapiComponentsSchemasCountryCodeNumeric = z.string(); export const openapiComponentsSchemasCountryCode = z.object({alpha3: openapiComponentsSchemasCountryCodeAlpha3.optional(), alpha2: openapiComponentsSchemasCountryCodeAlpha2.optional(), numeric: openapiComponentsSchemasCountryCodeNumeric.optional()}); export const schemasCardCountry = z.object({code: openapiComponentsSchemasCountryCode}); export const accountFundingSource = z.enum(["Credit", "Debit", "Prepaid", "Charge", "Deferred Debit", "Unknown"]); export const productType = z.enum(["Consumer", "Commercial", "Business", "Government", "Unknown"]); export const cardInfoSummary = z.object({cardCountry: schemasCardCountry, accountFundingSource: accountFundingSource, productType: productType}); export const publicInterchangeFeeProgram = z.object({segments: z.object({currency: z.string().optional(), fixed: z.number().optional(), basisPoints: z.number().optional(), max: z.number().optional(), min: z.number().optional()}).optional(), designator: z.union([z.object({network: z.literal("visa"), feeProgramIndicator: z.string().optional(), feeDescriptor: z.string().optional(), feeProgramName: z.string().optional(), cpsProgram: z.string().optional()}), z.object({network: z.literal("mastercard"), ird: z.string().optional(), businessServiceArrangement: z.object({cardProgramIdentifier: z.string().optional(), type: z.string().optional(), idCode: z.string().optional()}).optional(), feeProgramName: z.string().optional()}), z.object({network: z.literal("bancontact"), feeCode: z.string().optional(), feeProgramName: z.string().optional()})]).optional()}); export const transactionRegionalitySummary = z.object({transactionRegionality: z.enum(["domestic", "intraregional_eea", "intraregional_europe", "intraregional_asia_pacific", "intraregional_middle_east_and_africa", "intraregional_latin_america", "interregional"]), cardRegion: z.enum(["eea", "europe", "united_states", "canada", "asia_pacific", "middle_east_and_africa", "latin_america"]), merchantRegion: z.enum(["eea", "europe", "united_states", "canada", "asia_pacific", "middle_east_and_africa", "latin_america"])}); export const firstPresentmentDMSSpecific = z.object({arn: z.string(), processingDate: z.string(), bin: bin, clearableTime: z.string(), merchantAcceptor: merchantAcceptor, chargeKey: componentsSchemasChargeKey, authorizationAmount: settlementAmountInteger, clearingAmount: settlementAmountInteger, grossSettlementAmount: settlementAmountFloatWithRate, interchangeFeeAmount: settlementAmountFloatWithRate, transactionReference: componentsSchemasTransactionReference.optional(), actionKey: componentsSchemasActionKey.optional(), actionReference: componentsSchemasActionReference.optional(), filename: z.string(), acquirerIdCode: componentsSchemasAcquirerIdCode, transactionType: transactionType, tags: schemasTags.optional(), cardInfoSummary: cardInfoSummary.optional(), interchangeFeeProgram: publicInterchangeFeeProgram.optional(), cashbackAmount: z.object({value: openapiComponentsSchemasAmountValue3, currency: openapiComponentsSchemasCurrencyCode5}).optional(), transactionRegionalitySummary: transactionRegionalitySummary.optional()}); export const reconciliationDetailKey = z.string(); export const correctedReconciliationDetailKey = z.string(); export const openapiComponentsSchemasCreated2 = z.string(); export const openapiComponentsSchemasCardNetwork = z.enum(["mastercard", "visa", "bancontact", "american-express", "discover"]); export const settlementAmountFloat = z.object({currency: openapiComponentsSchemasCurrencyCode5, value: floatAmountValue, impact: z.enum(["credit", "debit"])}); export const fundsTransferDate = z.string(); export const fundsTransferBookDate = z.string(); export const settlementService = z.object({code: z.string(), name: z.string(), id: z.string()}); export const reconciliationDetailNetworkFundsTransferKey = z.string(); export const firstPresentmentDMSReconciliationDetail = z.object({type: z.literal("firstPresentment-dms"), typeSpecific: firstPresentmentDMSSpecific, key: reconciliationDetailKey, groupReference: z.string(), entry: z.number().int(), isCorrection: z.boolean(), correctedDetailKey: correctedReconciliationDetailKey.optional(), created: openapiComponentsSchemasCreated2, reportingFor: z.string(), network: openapiComponentsSchemasCardNetwork, netSettlementAmount: settlementAmountFloat, fundsTransferDate: fundsTransferDate, fundsTransferBookDate: fundsTransferBookDate, settlementService: settlementService, networkFundsTransferKey: reconciliationDetailNetworkFundsTransferKey.optional()}); export const rrn = z.string(); export const firstPresentmentSMSSpecific = z.object({rrn: rrn, processingDate: z.string(), bin: bin, transactionReference: componentsSchemasTransactionReference.optional(), actionKey: componentsSchemasActionKey.optional(), actionReference: componentsSchemasActionReference.optional(), merchantAcceptor: merchantAcceptor, chargeKey: componentsSchemasChargeKey, authorizationAmount: settlementAmountInteger, grossSettlementAmount: settlementAmountFloatWithRate, interchangeFeeAmount: settlementAmountFloatWithRate, acquirerIdCode: componentsSchemasAcquirerIdCode, transactionType: transactionType, tags: schemasTags.optional(), cardInfoSummary: cardInfoSummary.optional(), interchangeFeeProgram: publicInterchangeFeeProgram.optional(), transactionRegionalitySummary: transactionRegionalitySummary.optional()}); export const firstPresentmentSMSReconciliationDetail = z.object({type: z.literal("firstPresentment-sms"), typeSpecific: firstPresentmentSMSSpecific, key: reconciliationDetailKey, groupReference: z.string(), entry: z.number().int(), isCorrection: z.boolean(), correctedDetailKey: correctedReconciliationDetailKey.optional(), created: openapiComponentsSchemasCreated2, reportingFor: z.string(), network: openapiComponentsSchemasCardNetwork, netSettlementAmount: settlementAmountFloat, fundsTransferDate: fundsTransferDate, fundsTransferBookDate: fundsTransferBookDate, settlementService: settlementService, networkFundsTransferKey: reconciliationDetailNetworkFundsTransferKey.optional()}); export const firstPresentmentRTCSpecific = z.object({rrn: rrn.optional(), processingDate: z.string(), bin: bin, transactionReference: componentsSchemasTransactionReference.optional(), merchantAcceptor: merchantAcceptor, chargeKey: componentsSchemasChargeKey, authorizationAmount: settlementAmountInteger, grossSettlementAmount: settlementAmountFloatWithRate, interchangeFeeAmount: settlementAmountFloatWithRate, acquirerIdCode: componentsSchemasAcquirerIdCode, transactionType: transactionType, interchangeFeeProgram: publicInterchangeFeeProgram.optional(), switchPeriodNumber: z.string(), switchPeriodDate: z.string()}); export const firstPresentmentRTCReconciliationDetail = z.object({type: z.literal("firstPresentment-rtc"), typeSpecific: firstPresentmentRTCSpecific, key: reconciliationDetailKey, groupReference: z.string(), entry: z.number().int(), isCorrection: z.boolean(), correctedDetailKey: correctedReconciliationDetailKey.optional(), created: openapiComponentsSchemasCreated2, reportingFor: z.string(), network: openapiComponentsSchemasCardNetwork, netSettlementAmount: settlementAmountFloat, fundsTransferDate: fundsTransferDate, fundsTransferBookDate: fundsTransferBookDate, settlementService: settlementService, networkFundsTransferKey: reconciliationDetailNetworkFundsTransferKey.optional()}); export const processingDate = z.string(); export const cardNetworkFeeSpecific = z.object({acquirerIdCode: componentsSchemasAcquirerIdCode, processingDate: processingDate, type: z.string(), subType: z.string(), description: z.string()}); export const cardNetworkFeeReconciliationDetail = z.object({type: z.literal("cardNetworkFee-dms"), typeSpecific: cardNetworkFeeSpecific, key: reconciliationDetailKey, groupReference: z.string(), entry: z.number().int(), isCorrection: z.boolean(), correctedDetailKey: correctedReconciliationDetailKey.optional(), created: openapiComponentsSchemasCreated2, reportingFor: z.string(), network: openapiComponentsSchemasCardNetwork, netSettlementAmount: settlementAmountFloat, fundsTransferDate: fundsTransferDate, fundsTransferBookDate: fundsTransferBookDate, settlementService: settlementService, networkFundsTransferKey: reconciliationDetailNetworkFundsTransferKey.optional()}); export const arn = z.string(); export const preDisputeType = z.enum(["rapidDisputeResolution", "collaborationRefund"]); export const firstChargebackDMSSpecific = z.object({arn: arn, processingDate: processingDate, bin: bin, transactionReference: componentsSchemasTransactionReference.optional(), merchantAcceptor: merchantAcceptor.optional(), chargeKey: componentsSchemasChargeKey.optional(), acquirerIdCode: componentsSchemasAcquirerIdCode, authorizationAmount: settlementAmountInteger.optional(), grossSettlementAmount: settlementAmountFloat, interchangeFeeAmount: settlementAmountFloat, transactionType: transactionType, preDispute: preDisputeType.optional(), reversal: z.boolean().optional(), tags: schemasTags.optional()}); export const firstChargebackDMSReconciliationDetail = z.object({type: z.literal("firstChargeback-dms"), typeSpecific: firstChargebackDMSSpecific, key: reconciliationDetailKey, groupReference: z.string(), entry: z.number().int(), isCorrection: z.boolean(), correctedDetailKey: correctedReconciliationDetailKey.optional(), created: openapiComponentsSchemasCreated2, reportingFor: z.string(), network: openapiComponentsSchemasCardNetwork, netSettlementAmount: settlementAmountFloat, fundsTransferDate: fundsTransferDate, fundsTransferBookDate: fundsTransferBookDate, settlementService: settlementService, networkFundsTransferKey: reconciliationDetailNetworkFundsTransferKey.optional()}); export const secondPresentmentDMSSpecific = z.object({arn: arn, processingDate: processingDate, bin: bin, transactionReference: componentsSchemasTransactionReference.optional(), merchantAcceptor: merchantAcceptor.optional(), chargeKey: componentsSchemasChargeKey.optional(), acquirerIdCode: componentsSchemasAcquirerIdCode, authorizationAmount: settlementAmountInteger.optional(), grossSettlementAmount: settlementAmountFloat, interchangeFeeAmount: settlementAmountFloat, transactionType: transactionType, tags: schemasTags.optional()}); export const secondPresentmentDMSReconciliationDetail = z.object({type: z.literal("secondPresentment-dms"), typeSpecific: secondPresentmentDMSSpecific, key: reconciliationDetailKey, groupReference: z.string(), entry: z.number().int(), isCorrection: z.boolean(), correctedDetailKey: correctedReconciliationDetailKey.optional(), created: openapiComponentsSchemasCreated2, reportingFor: z.string(), network: openapiComponentsSchemasCardNetwork, netSettlementAmount: settlementAmountFloat, fundsTransferDate: fundsTransferDate, fundsTransferBookDate: fundsTransferBookDate, settlementService: settlementService, networkFundsTransferKey: reconciliationDetailNetworkFundsTransferKey.optional()}); export const secondPresentmentSMSSpecific = z.object({rrn: rrn, processingDate: processingDate, bin: bin, transactionReference: componentsSchemasTransactionReference.optional(), merchantAcceptor: merchantAcceptor.optional(), chargeKey: componentsSchemasChargeKey.optional(), acquirerIdCode: componentsSchemasAcquirerIdCode, authorizationAmount: settlementAmountInteger.optional(), grossSettlementAmount: settlementAmountFloat, interchangeFeeAmount: settlementAmountFloat, transactionType: transactionType, tags: schemasTags.optional()}); export const secondPresentmentSMSReconciliationDetail = z.object({type: z.literal("secondPresentment-sms"), typeSpecific: secondPresentmentSMSSpecific, key: reconciliationDetailKey, groupReference: z.string(), entry: z.number().int(), isCorrection: z.boolean(), correctedDetailKey: correctedReconciliationDetailKey.optional(), created: openapiComponentsSchemasCreated2, reportingFor: z.string(), network: openapiComponentsSchemasCardNetwork, netSettlementAmount: settlementAmountFloat, fundsTransferDate: fundsTransferDate, fundsTransferBookDate: fundsTransferBookDate, settlementService: settlementService, networkFundsTransferKey: reconciliationDetailNetworkFundsTransferKey.optional()}); export const preArbitrationDMSSpecific = z.object({arn: arn, processingDate: processingDate, bin: bin, transactionReference: componentsSchemasTransactionReference.optional(), merchantAcceptor: merchantAcceptor.optional(), chargeKey: componentsSchemasChargeKey.optional(), acquirerIdCode: componentsSchemasAcquirerIdCode, authorizationAmount: settlementAmountInteger.optional(), grossSettlementAmount: settlementAmountFloat, interchangeFeeAmount: settlementAmountFloat, transactionType: transactionType, reversal: z.boolean(), disputeOutcome: z.enum(["closedLost", "closedWon"]).optional(), tags: schemasTags.optional()}); export const preArbitrationDMSReconciliationDetail = z.object({type: z.literal("preArbitration-dms"), typeSpecific: preArbitrationDMSSpecific, key: reconciliationDetailKey, groupReference: z.string(), entry: z.number().int(), isCorrection: z.boolean(), correctedDetailKey: correctedReconciliationDetailKey.optional(), created: openapiComponentsSchemasCreated2, reportingFor: z.string(), network: openapiComponentsSchemasCardNetwork, netSettlementAmount: settlementAmountFloat, fundsTransferDate: fundsTransferDate, fundsTransferBookDate: fundsTransferBookDate, settlementService: settlementService, networkFundsTransferKey: reconciliationDetailNetworkFundsTransferKey.optional()}); export const arbitrationDMSSpecific = z.object({arn: arn, processingDate: processingDate, bin: bin, transactionReference: componentsSchemasTransactionReference.optional(), merchantAcceptor: merchantAcceptor.optional(), chargeKey: componentsSchemasChargeKey.optional(), acquirerIdCode: componentsSchemasAcquirerIdCode, authorizationAmount: settlementAmountInteger.optional(), grossSettlementAmount: settlementAmountFloat, interchangeFeeAmount: settlementAmountFloat, transactionType: transactionType, reversal: z.boolean(), disputeOutcome: z.enum(["closedLost", "closedWon"]).optional(), tags: schemasTags.optional()}); export const arbitrationDMSReconciliationDetail = z.object({type: z.literal("arbitration-dms"), typeSpecific: arbitrationDMSSpecific, key: reconciliationDetailKey, groupReference: z.string(), entry: z.number().int(), isCorrection: z.boolean(), correctedDetailKey: correctedReconciliationDetailKey.optional(), created: openapiComponentsSchemasCreated2, reportingFor: z.string(), network: openapiComponentsSchemasCardNetwork, netSettlementAmount: settlementAmountFloat, fundsTransferDate: fundsTransferDate, fundsTransferBookDate: fundsTransferBookDate, settlementService: settlementService, networkFundsTransferKey: reconciliationDetailNetworkFundsTransferKey.optional()}); export const firstChargebackSMSSpecific = z.object({rrn: rrn, processingDate: processingDate, bin: bin, transactionReference: componentsSchemasTransactionReference.optional(), actionKey: componentsSchemasActionKey.optional(), actionReference: componentsSchemasActionReference.optional(), merchantAcceptor: merchantAcceptor, chargeKey: componentsSchemasChargeKey, grossSettlementAmount: settlementAmountFloatWithRate, interchangeFeeAmount: settlementAmountFloatWithRate, acquirerIdCode: componentsSchemasAcquirerIdCode, transactionType: transactionType, preDispute: preDisputeType.optional(), reversal: z.boolean(), tags: schemasTags.optional()}); export const firstChargebackSMSReconciliationDetail = z.object({type: z.literal("firstChargeback-sms"), typeSpecific: firstChargebackSMSSpecific, key: reconciliationDetailKey, groupReference: z.string(), entry: z.number().int(), isCorrection: z.boolean(), correctedDetailKey: correctedReconciliationDetailKey.optional(), created: openapiComponentsSchemasCreated2, reportingFor: z.string(), network: openapiComponentsSchemasCardNetwork, netSettlementAmount: settlementAmountFloat, fundsTransferDate: fundsTransferDate, fundsTransferBookDate: fundsTransferBookDate, settlementService: settlementService, networkFundsTransferKey: reconciliationDetailNetworkFundsTransferKey.optional()}); export const reconciliationDetail = z.discriminatedUnion("type", [firstPresentmentDMSReconciliationDetail, firstPresentmentSMSReconciliationDetail, firstPresentmentRTCReconciliationDetail, cardNetworkFeeReconciliationDetail, firstChargebackDMSReconciliationDetail, secondPresentmentDMSReconciliationDetail, secondPresentmentSMSReconciliationDetail, preArbitrationDMSReconciliationDetail, arbitrationDMSReconciliationDetail, firstChargebackSMSReconciliationDetail]); export const responseOffsetToken = z.string(); export const reconciliationDetailsPage = z.object({items: z.array(reconciliationDetail), moreItems: z.boolean(), offsetToken: responseOffsetToken.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 }; /** * List Reconciliation Details * * GET /reports/reconciliationDetails * * Also accepts auth: BearerToken */ export const getApiReportsReconciliationDetails = async (args: GetApiReportsReconciliationDetailsArgs, options?: GetApiReportsReconciliationDetailsOptions) => { const {baseUrl = "https://eu-west-1.api.silverflow.com/v1", fetch: fetchFn = fetch, ApiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.from != null) query.append("from", String(args.from)) if (args.to != null) query.append("to", String(args.to)) if (args.sortOrder != null) query.append("sortOrder", String(args.sortOrder)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offsetToken != null) query.append("offsetToken", String(args.offsetToken)) if (ApiKey !== undefined) headers.set('authorization', `Basic ${btoa(`${ApiKey.username}:${ApiKey.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/reports/reconciliationDetails${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(reconciliationDetailsPage, await res.json()) };