import {z} from 'zod' export type GetApiV1PaymentsArgs = {reference?: string | undefined, email?: string | undefined, state?: ('created' | 'started' | 'submitted' | 'success' | 'failed' | 'cancelled' | 'error') | undefined, card_brand?: string | undefined, from_date?: string | undefined, to_date?: string | undefined, page?: string | undefined, display_size?: string | undefined, cardholder_name?: string | undefined, first_digits_card_number?: string | undefined, last_digits_card_number?: string | undefined, from_settled_date?: string | undefined, to_settled_date?: string | undefined, agreement_id?: string | undefined}; export type GetApiV1PaymentsOptions = {baseUrl?: string | undefined, BearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const link = z.object({href: z.string().optional(), method: z.string().optional()}); export const searchNavigationLinks = z.object({first_page: link.optional(), last_page: link.optional(), next_page: link.optional(), prev_page: link.optional(), self: link.optional()}); export const postLink = z.object({href: z.string().optional(), method: z.string().optional(), params: z.record(z.string(), z.object({})).optional(), type: z.string().optional()}); export const paymentLinksForSearch = z.object({cancel: postLink.optional(), capture: postLink.optional(), events: link.optional(), refunds: link.optional(), self: link.optional()}); export const threeDSecure = z.object({required: z.boolean().optional()}); export const authorisationSummary = z.object({three_d_secure: threeDSecure.optional()}); export const address = z.object({city: z.string().max(255).optional(), country: z.string().optional(), line1: z.string().max(255).optional(), line2: z.string().max(255).optional(), postcode: z.string().max(25).optional()}); export const cardDetails = z.object({billing_address: address.optional(), card_brand: z.string().optional(), card_type: z.enum(["debit", "credit", "null"]).optional(), cardholder_name: z.string().optional(), expiry_date: z.string().optional(), first_digits_card_number: z.string().optional(), last_digits_card_number: z.string().optional(), wallet_type: z.enum(["Apple Pay", "Google Pay"]).optional()}); export const outcome = z.object({result: z.string().optional()}); export const exemption = z.object({outcome: outcome.optional(), requested: z.boolean().optional(), type: z.string().optional()}); export const externalMetadata = z.object({metadata: z.record(z.string(), z.object({})).optional()}); export const refundSummary = z.object({amount_available: z.number().int().optional(), amount_submitted: z.number().int().optional(), status: z.string().optional()}); export const paymentSettlementSummary = z.object({capture_submit_time: z.string().optional(), captured_date: z.string().optional(), settled_date: z.string().optional()}); export const paymentState = z.object({can_retry: z.boolean().nullable().optional(), code: z.string().optional(), finished: z.boolean().optional(), message: z.string().optional(), status: z.string().optional()}); export const paymentDetailForSearch = z.object({_links: paymentLinksForSearch.optional(), agreement_payment_type: z.enum(["instalment", "recurring", "unscheduled"]).optional(), amount: z.number().int().optional(), authorisation_mode: z.enum(["web", "moto_api", "external"]).optional(), authorisation_summary: authorisationSummary.optional(), card_brand: z.string().optional(), card_details: cardDetails.optional(), corporate_card_surcharge: z.number().int().optional(), created_date: z.string().optional(), delayed_capture: z.boolean().optional(), description: z.string().optional(), email: z.string().optional(), exemption: exemption.optional(), fee: z.number().int().optional(), language: z.enum(["en", "cy"]).optional(), metadata: externalMetadata.optional(), moto: z.boolean().optional(), net_amount: z.number().int().optional(), payment_id: z.string().optional(), payment_provider: z.string().optional(), provider_id: z.string().optional(), reference: z.string().optional(), refund_summary: refundSummary.optional(), return_url: z.string().optional(), settlement_summary: paymentSettlementSummary.optional(), state: paymentState.optional(), total_amount: z.number().int().optional()}); export const paymentSearchResults = z.object({_links: searchNavigationLinks.optional(), count: z.number().int().optional(), page: z.number().int().optional(), results: z.array(paymentDetailForSearch).optional(), total: z.number().int().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 }; /** * Search payments * * GET /v1/payments */ export const getApiV1Payments = async (args: GetApiV1PaymentsArgs, options?: GetApiV1PaymentsOptions) => { const {baseUrl = "https://publicapi.payments.service.gov.uk", fetch: fetchFn = fetch, BearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.reference != null) query.append("reference", String(args.reference)) if (args.email != null) query.append("email", String(args.email)) if (args.state != null) query.append("state", String(args.state)) if (args.card_brand != null) query.append("card_brand", String(args.card_brand)) if (args.from_date != null) query.append("from_date", String(args.from_date)) if (args.to_date != null) query.append("to_date", String(args.to_date)) if (args.page != null) query.append("page", String(args.page)) if (args.display_size != null) query.append("display_size", String(args.display_size)) if (args.cardholder_name != null) query.append("cardholder_name", String(args.cardholder_name)) if (args.first_digits_card_number != null) query.append("first_digits_card_number", String(args.first_digits_card_number)) if (args.last_digits_card_number != null) query.append("last_digits_card_number", String(args.last_digits_card_number)) if (args.from_settled_date != null) query.append("from_settled_date", String(args.from_settled_date)) if (args.to_settled_date != null) query.append("to_settled_date", String(args.to_settled_date)) if (args.agreement_id != null) query.append("agreement_id", String(args.agreement_id)) if (BearerAuth !== undefined) headers.set('authorization', `Bearer ${BearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/payments${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(paymentSearchResults, await res.json()) };