import {z} from 'zod' export type GetApiAuthorizationsArgs = {'Finix-Version'?: string | undefined, after_cursor?: string | undefined, 'amount.gt'?: number | undefined, 'amount.gte'?: number | undefined, 'amount.lt'?: number | undefined, 'amount.lte'?: number | undefined, amount?: number | undefined, before_cursor?: string | undefined, 'created_at.gte'?: string | undefined, 'created_at.lte'?: string | undefined, currency?: string | undefined, device?: string | undefined, idempotency_id?: string | undefined, instrument_account_last4?: string | undefined, instrument_bin?: string | undefined, instrument_brand_type?: string | undefined, instrument_card_last4?: string | undefined, instrument_name?: string | undefined, is_void?: boolean | undefined, limit?: number | undefined, merchant?: string | undefined, merchant_identity_name?: string | undefined, merchant_mid?: string | undefined, merchant_processor_id?: string | undefined, state?: ('SUCCEEDED' | 'FAILED' | 'PENDING' | 'CANCELED') | undefined, 'tags.key'?: string | undefined, 'tags.value'?: string | undefined, trace_id?: string | undefined, 'updated_at.gte'?: string | undefined, 'updated_at.lte'?: string | undefined}; export type GetApiAuthorizationsOptions = {baseUrl?: string | undefined, BasicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const page = z.object({limit: z.number().int().optional(), next_cursor: z.string().nullable().optional()}); export const createdAt = z.string(); export const updatedAt = z.string(); export const additionalLodgingData = z.object({check_in_date: z.object({month: z.number().int().optional(), day: z.number().int().optional(), year: z.number().int().optional()}).nullable().optional(), check_out_date: z.object({month: z.number().int().optional(), day: z.number().int().optional(), year: z.number().int().optional()}).nullable().optional(), customer_service_phone: z.string().nullable().optional(), extra_charge_details: z.object({restaurant_amount: z.number().int().nullable().optional(), mini_bar_amount: z.number().int().nullable().optional(), laundry_amount: z.number().int().nullable().optional(), other_amount: z.number().int().nullable().optional(), phone_amount: z.number().int().nullable().optional(), gift_shop_amount: z.number().int().nullable().optional()}).nullable().optional(), hotel_agreement_number: z.string().nullable().optional(), is_advance_deposit: z.boolean().nullable().optional(), is_no_show: z.boolean().nullable().optional(), number_of_nights: z.number().int().nullable().optional(), property_phone: z.string().nullable().optional(), room_rate: z.string().nullable().optional(), room_tax: z.string().nullable().optional()}).nullable(); 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 additionalMotorVehicleRentalData = z.object({motor_vehicle_rental_agreement_number: z.string().nullable().optional(), customer_service_number: z.string().nullable().optional(), extra_charge_details: z.object({extra_mileage_amount: z.number().int().nullable().optional(), fuel_amount: z.number().int().nullable().optional(), insurance_amount: z.number().int().nullable().optional(), late_return_amount: z.number().int().nullable().optional(), one_way_service_fee_amount: z.number().int().nullable().optional(), parking_violation_amount: z.number().int().nullable().optional()}).nullable().optional(), is_no_show: z.boolean().nullable().optional(), number_of_days: z.number().int().nullable().optional(), rental_rate: z.string().nullable().optional(), renter_name: z.string().nullable().optional(), pickup_address: address.nullable().optional(), pickup_date: z.object({month: z.number().int().optional(), day: z.number().int().optional(), year: z.number().int().optional()}).nullable().optional(), return_address: address.nullable().optional(), return_date: z.object({month: z.number().int().optional(), day: z.number().int().optional(), year: z.number().int().optional()}).nullable().optional()}).nullable(); export const additionalBuyerCharges = z.object({convenience_amount: z.number().int().nullable().optional(), rent_surcharge_amount: z.number().int().nullable().optional(), surcharge_amount: z.number().int().nullable().optional()}).nullable(); export const additionalHealthcareData = z.object({clinic_amount: z.number().int().nullable().optional(), dental_amount: z.number().int().nullable().optional(), prescription_amount: z.number().int().nullable().optional(), vision_amount: z.number().int().nullable().optional()}).nullable(); export const customerReferenceNumber = z.string().max(17); export const additionalPurchaseData = z.object({customer_reference_number: customerReferenceNumber.optional(), customs_duty_amount: z.number().int().nullable().optional(), destination_country_code: z.string().nullable().optional(), destination_postal_code: z.string().max(10).nullable().optional(), discount_amount: z.number().int().nullable().optional(), invoice_reference_number: z.string().max(15).nullable().optional(), order_date: z.object({day: z.number().int().optional(), month: z.number().int().optional(), year: z.number().int().gte(1990).optional()}).nullable().optional(), sales_tax: z.number().int().nullable().optional(), sales_tax_finix_generated: z.number().int().nullable().optional(), ship_from_postal_code: z.string().max(10).nullable().optional(), shipping_amount: z.number().int().nullable().optional(), tax_exempt: z.boolean().optional(), item_data: z.array(z.object({amount_excluding_sales_tax: z.number().int().optional(), amount_including_sales_tax: z.number().int().optional(), commodity_code: z.string().max(12).optional(), cost_per_unit: z.number().int().optional(), item_description: z.string().max(25).optional(), item_discount_amount: z.number().int().optional(), merchant_product_code: z.string().max(12).optional(), quantity: z.number().gte(1).lte(99).optional(), unit_of_measure: z.string().max(3).optional(), sales_tax_amount: z.number().int().optional(), sales_tax_rate: z.number().optional()})).optional()}).nullable(); export const amount = z.number().int(); export const tags = z.record(z.string(), z.unknown()).nullable(); export const cardPresentDetails = z.object({approval_code: z.string().nullable().optional(), brand: z.string().nullable().optional(), digital_signature_file_id: z.string().nullable().optional(), emv_data: z.object({application_identifier: z.string().optional(), application_label: z.string().optional(), application_preferred_name: z.string().nullable().optional(), application_transaction_counter: z.string().optional(), cryptogram: z.string().optional(), issuer_code_table_index: z.string().nullable().optional(), pin_verified: z.boolean().optional(), tags: tags.optional()}).nullable().optional(), entry_mode: z.enum(["UNKNOWN", "SWIPED", "CONTACTLESS", "CHIP_ENTRY"]).nullable().optional(), masked_account_number: z.string().nullable().optional(), name: z.string().nullable().optional(), payment_type: z.string().optional()}).nullable(); export const currency = z.enum(["CAD", "USD"]); export const transfersAuthorizationsCreatedVia = z.enum(["API", "CARD_PRESENT_ANDROID_APP", "CARD_PRESENT_ANDROID_APP_MANUAL_ENTRY", "CARD_PRESENT_ANDROID_D135_SDK", "CARD_PRESENT_DEVICE_READER_SDK", "CARD_PRESENT_IOS_APP", "CARD_PRESENT_IOS_APP_MANUAL_ENTRY", "CARD_PRESENT_IOS_D135_SDK", "CARD_PRESENT_IOS_TAP_TO_PAY", "CARD_PRESENT_IOS_TAP_TO_PAY_SDK", "CARD_PRESENT_SEMI_INTEGRATED_API", "CARD_PRESENT_STANDALONE", "CARD_PRESENT_STANDALONE_MANUAL_ENTRY", "CHECKOUT_FORM", "CYBERSOURCE", "DEVICE_ORDER", "PAYMENT_LINK", "PAYOUT_LINK", "PLUGIN_ADMOJI", "PLUGIN_CHECKOUT_CHAMP", "PLUGIN_FYNTEK", "PLUGIN_GAMBLE_ID", "PLUGIN_GAMMA_SWEEP", "PLUGIN_GR4VY", "PLUGIN_HYPERSWITCH", "PLUGIN_LACORE", "PLUGIN_PAYSIGHT", "PLUGIN_PRYZR", "PLUGIN_SERVMAN", "PLUGIN_SOAP_PAY", "PLUGIN_STICKYIO", "PLUGIN_TAGADA", "PLUGIN_WOO_COMMERCE", "PLUGIN_VRIO", "SUBSCRIPTION", "UNKNOWN", "VIRTUAL_TERMINAL"]); export const failureCode = z.string().nullable(); export const failureMessage = z.string().nullable(); export const idempotencyId = z.string().nullable(); export const ipAddressV4 = z.string().nullable(); export const ipAddressDetails = z.object({ipv4: z.object({estimated_location: address.optional(), ip: ipAddressV4.optional(), latitude: z.number().optional(), longitude: z.number().optional()}).optional()}).nullable(); export const raw = z.union([z.object({}).nullable(), z.string().nullable()]); export const source = z.string(); export const self = z.object({href: z.string().min(1).optional()}); export const applicationLink = z.object({href: z.string().min(1).optional()}); export const merchantIdentity = z.object({href: z.string().optional()}); export const transfers = z.object({href: z.string().min(1).optional()}); export const authorization = z.object({id: z.string().optional(), created_at: createdAt.optional(), updated_at: updatedAt.optional(), "3d_secure_session": z.string().nullable().optional(), "3ds_redirect_url": z.string().nullable().optional(), additional_lodging_data: additionalLodgingData.optional(), additional_motor_vehicle_rental_data: additionalMotorVehicleRentalData.optional(), additional_buyer_charges: additionalBuyerCharges.optional(), additional_healthcare_data: additionalHealthcareData.optional(), additional_purchase_data: additionalPurchaseData.optional(), address_verification: z.string().nullable().optional(), amount: amount.optional(), amount_requested: z.number().int().optional(), application: z.string().optional(), card_present_details: cardPresentDetails.optional(), credential_on_file: z.object({initial_transfer_id: z.string().optional(), type: z.enum(["RECURRING", "UNSCHEDULED"]).optional()}).nullable().optional(), currency: currency.optional(), created_via: transfersAuthorizationsCreatedVia.optional(), device: z.string().nullable().optional(), expires_at: z.string().optional(), failure_code: failureCode.optional(), failure_message: failureMessage.optional(), identity: z.string().optional(), idempotency_id: idempotencyId.optional(), ip_address_details: ipAddressDetails.optional(), is_void: z.boolean().optional(), merchant: z.string().optional(), merchant_identity: z.string().optional(), messages: z.array(z.string()).nullable().optional(), network_details: z.object({brand: z.string().optional(), authorization_code: z.string().optional()}).nullable().optional(), raw: raw.optional(), receipt_last_printed_at: z.string().nullable().optional(), security_code_verification: z.string().nullable().optional(), source: source.optional(), state: z.enum(["CANCELED", "PENDING", "FAILED", "SUCCEEDED", "UNKNOWN"]).optional(), supplemental_fee: z.number().int().nullable().optional(), tags: tags.optional(), trace_id: z.string().optional(), transfer: z.string().nullable().optional(), void_state: z.enum(["UNATTEMPTED", "PENDING", "SUCCEEDED"]).optional(), _links: z.object({self: self.optional(), application: applicationLink.optional(), device: z.object({href: z.string().optional()}).optional(), merchant_identity: merchantIdentity.optional(), transfer: z.object({href: z.string().optional()}).optional(), transfers: transfers.optional()}).optional()}); export const next = z.object({href: z.string().optional()}); export const getApiAuthorizationsResponse = z.object({page: page.optional(), _embedded: z.object({authorizations: z.array(authorization).optional()}).optional(), _links: z.object({self: self.optional(), next: next.optional()}).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 Authorizations * * GET /authorizations */ export const getApiAuthorizations = async (args: GetApiAuthorizationsArgs, options?: GetApiAuthorizationsOptions) => { 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 (args.after_cursor != null) query.append("after_cursor", String(args.after_cursor)) if (args['amount.gt'] != null) query.append("amount.gt", String(args['amount.gt'])) if (args['amount.gte'] != null) query.append("amount.gte", String(args['amount.gte'])) if (args['amount.lt'] != null) query.append("amount.lt", String(args['amount.lt'])) if (args['amount.lte'] != null) query.append("amount.lte", String(args['amount.lte'])) if (args.amount != null) query.append("amount", String(args.amount)) if (args.before_cursor != null) query.append("before_cursor", String(args.before_cursor)) if (args['created_at.gte'] != null) query.append("created_at.gte", String(args['created_at.gte'])) if (args['created_at.lte'] != null) query.append("created_at.lte", String(args['created_at.lte'])) if (args.currency != null) query.append("currency", String(args.currency)) if (args.device != null) query.append("device", String(args.device)) if (args.idempotency_id != null) query.append("idempotency_id", String(args.idempotency_id)) if (args.instrument_account_last4 != null) query.append("instrument_account_last4", String(args.instrument_account_last4)) if (args.instrument_bin != null) query.append("instrument_bin", String(args.instrument_bin)) if (args.instrument_brand_type != null) query.append("instrument_brand_type", String(args.instrument_brand_type)) if (args.instrument_card_last4 != null) query.append("instrument_card_last4", String(args.instrument_card_last4)) if (args.instrument_name != null) query.append("instrument_name", String(args.instrument_name)) if (args.is_void != null) query.append("is_void", String(args.is_void)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.merchant != null) query.append("merchant", String(args.merchant)) if (args.merchant_identity_name != null) query.append("merchant_identity_name", String(args.merchant_identity_name)) if (args.merchant_mid != null) query.append("merchant_mid", String(args.merchant_mid)) if (args.merchant_processor_id != null) query.append("merchant_processor_id", String(args.merchant_processor_id)) if (args.state != null) query.append("state", String(args.state)) if (args['tags.key'] != null) query.append("tags.key", String(args['tags.key'])) if (args['tags.value'] != null) query.append("tags.value", String(args['tags.value'])) if (args.trace_id != null) query.append("trace_id", String(args.trace_id)) if (args['updated_at.gte'] != null) query.append("updated_at.gte", String(args['updated_at.gte'])) if (args['updated_at.lte'] != null) query.append("updated_at.lte", String(args['updated_at.lte'])) if (BasicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${BasicAuth.username}:${BasicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/authorizations${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(getApiAuthorizationsResponse, await res.json()) };