import {z} from 'zod' export type GetApiV4PaymentauditPayoutsPayoutIdArgs = {railsId?: string | undefined, payoutId: string, remoteId?: string | undefined, remoteSystemId?: string | undefined, status?: ('ACCEPTED' | 'AWAITING_FUNDS' | 'FUNDED' | 'UNFUNDED' | 'BANK_PAYMENT_REQUESTED' | 'REJECTED' | 'ACCEPTED_BY_RAILS' | 'CONFIRMED' | 'FAILED' | 'RETURNED' | 'WITHDRAWN') | undefined, sourceAmountFrom?: number | undefined, sourceAmountTo?: number | undefined, paymentAmountFrom?: number | undefined, paymentAmountTo?: number | undefined, submittedDateFrom?: string | undefined, submittedDateTo?: string | undefined, transmissionType?: ('ACH' | 'SAME_DAY_ACH' | 'WIRE' | 'LOCAL' | 'GACHO') | undefined, page?: number | undefined, pageSize?: number | undefined, sort?: string | undefined, sensitive?: boolean | undefined}; export type GetApiV4PaymentauditPayoutsPayoutIdOptions = {baseUrl?: string | undefined, OAuth2?: string | undefined, fetch?: typeof fetch | undefined}; export const payoutPayor = z.object({payorId: z.string(), payorName: z.string(), dbaName: z.string(), principal: z.string(), principalId: z.string()}); export const payoutPrincipal = z.object({principal: z.string(), principalId: z.string()}); export const payoutSchedule = z.object({scheduleStatus: z.string(), scheduledAt: z.string(), scheduledFor: z.string(), scheduledByPrincipalId: z.string(), notificationsEnabled: z.boolean(), scheduledBy: z.string().optional()}); export const getPaymentsForPayoutResponseV4Summary = z.object({payoutStatus: z.string().optional(), submittedDateTime: z.string().optional(), instructedDateTime: z.string().optional(), withdrawnDateTime: z.string().optional(), quotedDateTime: z.string().optional(), payoutMemo: z.string().optional(), totalPayments: z.number().int().optional(), confirmedPayments: z.number().int().optional(), releasedPayments: z.number().int().optional(), incompletePayments: z.number().int().optional(), returnedPayments: z.number().int().optional(), withdrawnPayments: z.number().int().optional(), payoutType: z.string().optional(), submitting: payoutPayor.optional(), payoutFrom: payoutPayor.optional(), payoutTo: payoutPayor.optional(), quoted: payoutPrincipal.optional(), instructed: payoutPrincipal.optional(), withdrawn: payoutPrincipal.optional(), schedule: payoutSchedule.optional()}); export const pagedPayeeInvitationStatusResponseV3Page = z.object({numberOfElements: z.number().int().optional(), totalElements: z.number().int().optional(), totalPages: z.number().int().optional(), page: z.number().int().optional(), pageSize: z.number().int().optional()}); export const pagedPayeeResponseV3Links = z.object({rel: z.string().optional(), href: z.string().optional()}); export const paymentEventResponse = z.object({eventId: z.string(), eventDateTime: z.string(), eventType: z.string(), sourceCurrency: z.string().min(3).max(3).optional(), sourceAmount: z.number().int().optional(), paymentCurrency: z.string().min(3).max(3).optional(), paymentAmount: z.number().int().optional(), accountNumber: z.string().optional(), routingNumber: z.string().optional(), iban: z.string().optional(), accountName: z.string().optional(), principal: z.string().optional(), scheduledAt: z.string().optional(), scheduledFor: z.string().optional(), scheduledBy: z.string().optional()}); export const postInstructFxInfo = z.object({fxMode: z.string(), fxStatus: z.string(), fxStatusUpdatedAt: z.string(), fxTransactionReference: z.string().optional()}); export const paymentResponseV4Payout = z.object({payoutId: z.string().optional(), payoutFrom: payoutPayor.optional(), payoutTo: payoutPayor.optional()}); export const paymentResponseV4 = z.object({paymentId: z.string(), payeeId: z.string(), payorId: z.string(), payorName: z.string().optional(), quoteId: z.string(), sourceAccountId: z.string(), sourceAccountName: z.string().optional(), remoteId: z.string().optional(), remoteSystemId: z.string().optional(), remoteSystemPaymentId: z.string().optional(), sourceAmount: z.number().int().optional(), sourceCurrency: z.string().min(3).max(3).optional(), paymentAmount: z.number().int(), paymentCurrency: z.string().min(3).max(3).optional(), rate: z.number().optional(), invertedRate: z.number().optional(), isPaymentCcyBaseCcy: z.boolean().optional(), submittedDateTime: z.string(), status: z.string(), fundingStatus: z.string(), routingNumber: z.string().optional(), accountNumber: z.string().optional(), iban: z.string().optional(), paymentMemo: z.string().optional(), filenameReference: z.string().optional(), individualIdentificationNumber: z.string().optional(), traceNumber: z.string().optional(), payorPaymentId: z.string().optional(), paymentChannelId: z.string().optional(), paymentChannelName: z.string().optional(), accountName: z.string().optional(), railsId: z.string(), countryCode: z.string().optional(), payeeAddressCountryCode: z.string().optional(), events: z.array(paymentEventResponse), returnCost: z.number().int().optional(), returnReason: z.string().optional(), railsPaymentId: z.string().optional(), railsBatchId: z.string().optional(), railsAccountId: z.string().optional(), paymentScheme: z.string().optional(), rejectionReason: z.string().optional(), railsRejectionInformation: z.string().optional(), withdrawnReason: z.string().optional(), withdrawable: z.boolean().optional(), autoWithdrawnReasonCode: z.string().optional(), transmissionType: z.string().optional(), transmissionTypeRequested: z.string().optional(), paymentTrackingReference: z.string().optional(), paymentMetadata: z.string().optional(), transactionId: z.string().optional(), transactionReference: z.string().optional(), schedule: payoutSchedule.optional(), postInstructFxInfo: postInstructFxInfo.optional(), payout: paymentResponseV4Payout.optional()}); export const getPaymentsForPayoutResponseV4 = z.object({summary: getPaymentsForPayoutResponseV4Summary.optional(), page: pagedPayeeInvitationStatusResponseV3Page.optional(), links: z.array(pagedPayeeResponseV3Links).optional(), content: z.array(paymentResponseV4).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 Payments for Payout * * GET /v4/paymentaudit/payouts/{payoutId} */ export const getApiV4PaymentauditPayoutsPayoutId = async (args: GetApiV4PaymentauditPayoutsPayoutIdArgs, options?: GetApiV4PaymentauditPayoutsPayoutIdOptions) => { const {baseUrl = "https://api.sandbox.velopayments.com", fetch: fetchFn = fetch, OAuth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.railsId != null) query.append("railsId", String(args.railsId)) if (args.remoteId != null) query.append("remoteId", String(args.remoteId)) if (args.remoteSystemId != null) query.append("remoteSystemId", String(args.remoteSystemId)) if (args.status != null) query.append("status", String(args.status)) if (args.sourceAmountFrom != null) query.append("sourceAmountFrom", String(args.sourceAmountFrom)) if (args.sourceAmountTo != null) query.append("sourceAmountTo", String(args.sourceAmountTo)) if (args.paymentAmountFrom != null) query.append("paymentAmountFrom", String(args.paymentAmountFrom)) if (args.paymentAmountTo != null) query.append("paymentAmountTo", String(args.paymentAmountTo)) if (args.submittedDateFrom != null) query.append("submittedDateFrom", String(args.submittedDateFrom)) if (args.submittedDateTo != null) query.append("submittedDateTo", String(args.submittedDateTo)) if (args.transmissionType != null) query.append("transmissionType", String(args.transmissionType)) if (args.page != null) query.append("page", String(args.page)) if (args.pageSize != null) query.append("pageSize", String(args.pageSize)) if (args.sort != null) query.append("sort", String(args.sort)) if (args.sensitive != null) query.append("sensitive", String(args.sensitive)) if (OAuth2 !== undefined) headers.set('authorization', `Bearer ${OAuth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/v4/paymentaudit/payouts/${encodeURIComponent(String(args.payoutId))}${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(getPaymentsForPayoutResponseV4, await res.json()) };