import {z} from 'zod' export type GetApiPaymentInstrumentsPaymentInstrumentIdArgs = {'Finix-Version'?: string | undefined}; export type GetApiPaymentInstrumentsPaymentInstrumentIdOptions = {baseUrl?: string | undefined, BasicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const id = z.string().min(1); export const createdAt = z.string(); export const updatedAt = z.string(); export const createdVia = z.enum(["API", "ACCOUNT_UPDATER", "SETTLEMENT_REPORT", "SYSTEM", "TOKEN_IMPORT"]); export const accountUpdaterEnabledCard = z.boolean(); export const country = z.enum(["ABW", "AFG", "AGO", "AIA", "ALA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BES", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLM", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CUW", "CXR", "CYM", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESH", "ESP", "EST", "ETH", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUM", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAF", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MNP", "MRT", "MSR", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "REU", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SGS", "SHN", "SJM", "SLB", "SLE", "SLV", "SMR", "SOM", "SPM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SXM", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKL", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "UMI", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "XKX", "YEM", "ZAF", "ZMB", "ZWE"]).nullable(); export const address = z.object({line1: z.string().min(1).nullable(), line2: z.string().min(1).nullable().optional(), city: z.string().min(1).nullable(), region: z.string().min(1).nullable(), postal_code: z.string().min(1).nullable(), country: country}); export const applicationId = z.string().min(1); export const currency = z.enum(["CAD", "USD"]); export const identityId = z.string(); export const networkTokenEnabledCard = z.boolean(); export const nameVerificationResults = z.object({first_name_verification: z.enum(["MATCH", "MATCHED", "NO_MATCH", "NOT_SUPPORTED", "PARTIAL_MATCH", "UNKNOWN"]).optional(), last_name_verification: z.enum(["MATCH", "MATCHED", "NO_MATCH", "NOT_SUPPORTED", "PARTIAL_MATCH", "UNKNOWN"]).optional(), middle_name_verification: z.enum(["MATCH", "MATCHED", "NO_MATCH", "NOT_SUPPORTED", "PARTIAL_MATCH", "UNKNOWN"]).optional(), name_verification: z.enum(["MATCH", "MATCHED", "NO_MATCH", "NOT_SUPPORTED", "PARTIAL_MATCH", "UNKNOWN"]).optional()}).nullable(); export const tags = z.record(z.string(), z.unknown()).nullable(); export const paymentInstrumentCard = z.object({id: id.optional(), created_at: createdAt.optional(), updated_at: updatedAt.optional(), created_via: createdVia.optional(), account_updater_enabled: accountUpdaterEnabledCard.optional(), address: address.optional(), address_verification: z.enum(["POSTAL_CODE_AND_STREET_MATCH", "STREET_MATCH", "POSTAL_CODE_MATCH", "NO_ADDRESS", "NO_MATCH", "NOT_SUPPORTED", "UNKNOWN"]).optional(), application: applicationId.optional(), bin: z.string().optional(), brand: z.enum(["UNKNOWN", "DINERS_CLUB_INTERNATIONAL", "DANKORT", "MIR", "TROY", "UATP", "CHINA_T_UNION", "CHINA_UNION_PAY", "AMERICAN_EXPRESS", "VERVE", "RUPAY", "DISCOVER", "JCB", "MASTERCARD", "INTERPAYMENT", "INSTAPAYMENT", "MAESTRO", "VISA", "LANKAPAY", "DINERS_CLUB", "INTERAC"]).optional(), card_type: z.enum(["CREDIT", "DEBIT", "HSA_FSA", "NON_RELOADABLE_PREPAID", "RELOADABLE_PREPAID", "UNKNOWN"]).optional(), country: country.optional(), currency: currency.optional(), disabled_code: z.enum(["CARD_ACCOUNT_CLOSED", "INVALID_ACCOUNT_NUMBER", "LOST_OR_STOLEN_CARD", "NON_RELOADABLE_INSUFFICIENT_FUNDS", "PICK_UP_CARD", "RESTRICTED_CARD", "USER_INITIATED"]).nullable().optional(), disabled_message: z.string().nullable().optional(), enabled: z.boolean().optional(), expiration_month: z.number().int().gte(1).lte(12).optional(), expiration_year: z.number().int().gte(1).optional(), fast_funds_indicator: z.string().optional(), fingerprint: z.string().optional(), identity: identityId.optional(), instrument_type: z.enum(["APPLE_PAY", "GOOGLE_PAY", "PAYMENT_CARD", "PAYMENT_CARD_PRESENT", "TOKEN"]).optional(), issuer_country: z.enum(["ABW", "AFG", "AGO", "AIA", "ALA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BES", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLM", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CUW", "CXR", "CYM", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESH", "ESP", "EST", "ETH", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUM", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAF", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MNP", "MOZ", "MRT", "MSR", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NIU", "NLD", "NON_USA", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "REU", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SGS", "SHN", "SJM", "SLB", "SLE", "SLV", "SMR", "SOM", "SPM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SXM", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKL", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "UMI", "UNKNOWN", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "YEM", "ZAF", "ZMB", "ZWE"]).optional(), last_four: z.string().optional(), name: z.string().nullable().optional(), network_token_enabled: networkTokenEnabledCard.optional(), network_token_state: z.enum(["ACTIVE", "CLOSED", "ENABLED", "FAILED", "NOT_ENABLED", "SUSPENDED", "PENDING"]).optional(), payload_type: z.enum(["SOURCE", "DESTINATION"]).optional(), online_gambing_block_indicator: z.string().nullable().optional(), push_funds_block_indicator: z.string().optional(), name_verification_results: nameVerificationResults.optional(), security_code_verification: z.enum(["MATCHED", "UNKNOWN", "UNMATCHED"]).optional(), tags: tags.optional(), third_party: z.string().nullable().optional(), third_party_token: z.string().nullable().optional(), type: z.enum(["PAYMENT_CARD", "TOKEN", "GOOGLE_PAY", "APPLE_PAY"]).optional(), _links: z.object({application: z.object({href: z.string().optional()}).optional(), authorizations: z.object({href: z.string().optional()}).optional(), identity: z.object({href: z.string().optional()}).optional(), self: z.object({href: z.string().optional()}).optional(), transfers: z.object({href: z.string().optional()}).optional(), updates: z.object({href: z.string().optional()}).optional(), verifications: z.object({href: z.string().optional()}).optional()}).optional()}); export const institutionNumber = z.string().min(3).max(3).nullable(); export const transitNumber = z.string().min(5).max(5).nullable(); export const paymentInstrumentBank = z.object({id: id.optional(), created_at: createdAt.optional(), updated_at: updatedAt.optional(), created_via: createdVia.optional(), address: address.optional(), account_type: z.enum(["CHECKING", "BUSINESS_CHECKING", "BUSINESS_SAVINGS", "PERSONAL_CHECKING", "PERSONAL_SAVINGS", "SAVING"]).optional(), application: applicationId.optional(), bank_account_validation_check: z.enum(["INCONCLUSIVE", "INVALID", "NOT_ATTEMPTED", "VALID"]).optional(), bank_code: z.string().nullable().optional(), country: country.optional(), currency: currency.optional(), disabled_code: z.enum(["INVALID_BANK_ACCOUNT_ROUTING_NUMBER", "MICRODEPOSIT_RETURNED", "MICRODEPOSIT_VERIFICATION_REQUIRED", "MICRODEPOSIT_VERIFICATION_ATTEMPTS_EXCEEDED", "MICRODEPOSIT_VERIFICATION_EXPIRED", "TOTAL_MICRODEPOSIT_ATTEMPTS_EXCEEDED_ACCOUNT_LOCKED", "USER_INITIATED"]).nullable().optional(), disabled_message: z.string().nullable().optional(), enabled: z.boolean().optional(), fingerprint: z.string().optional(), identity: identityId.optional(), institution_number: institutionNumber.optional(), instrument_type: z.literal("BANK_ACCOUNT").optional(), masked_account_number: z.string().nullable().optional(), microdeposit: z.string().nullable().optional(), microdeposit_verification_url: z.string().nullable().optional(), name: z.string().nullable().optional(), tags: tags.optional(), third_party: z.enum(["PLAID", "PLAID_RESELLER"]).nullable().optional(), third_party_token: z.string().nullable().optional(), transit_number: transitNumber.optional(), type: z.literal("BANK_ACCOUNT").optional(), _links: z.object({application: z.object({href: z.string().optional()}).optional(), authorizations: z.object({href: z.string().optional()}).optional(), identity: z.object({href: z.string().optional()}).optional(), self: z.object({href: z.string().optional()}).optional(), transfers: z.object({href: z.string().optional()}).optional(), verifications: z.object({href: z.string().optional()}).optional()}).optional()}); export const getApiPaymentInstrumentsPaymentInstrumentIdResponse = z.union([paymentInstrumentCard, paymentInstrumentBank]); 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 }; /** * Fetch a Payment Instrument * * GET /payment_instruments/{payment_instrument_id} */ export const getApiPaymentInstrumentsPaymentInstrumentId = async (args: GetApiPaymentInstrumentsPaymentInstrumentIdArgs, options?: GetApiPaymentInstrumentsPaymentInstrumentIdOptions) => { const {baseUrl = "https://finix.sandbox-payments-api.com", fetch: fetchFn = fetch, BasicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['Finix-Version'] != null) headers.set("Finix-Version", String(args['Finix-Version'])) if (BasicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${BasicAuth.username}:${BasicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/payment_instruments/${encodeURIComponent(String(args.payment_instrument_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(getApiPaymentInstrumentsPaymentInstrumentIdResponse, await res.json()) };