import {z} from 'zod' export type QualifiedIntermediaryInfo = {is_qi?: boolean | undefined, assumes_primary_withholding_responsibility?: boolean | undefined, assumes_primary_1446f_responsibility?: boolean | undefined, assumes_primary_nominee_responsibility?: boolean | undefined, is_qualified_securities_lender?: boolean | undefined, assumes_primary_1099_reporting?: boolean | undefined, does_not_assume_1099_reporting?: boolean | undefined}; export type ForeignAddress = {address1?: string | undefined, address2?: string | undefined, city?: string | undefined, state?: string | undefined, country?: string | undefined, postal_code?: string | undefined}; export type DisregardedEntityBranch = {chapter_4_status?: string | undefined, address?: ForeignAddress | undefined, giin?: string | undefined}; export type W8Certification = {has_capacity_to_sign: boolean, signer_name: string}; export type W8IMYFormRequest = {disregarded_entity_name?: string | undefined, chapter_3_status: 'QI_INCLUDING_A_QDD' | 'NONQUALIFIED_INTERMEDIARY' | 'TERRITORY_FINANCIAL_INSTITUTION' | 'US_BRANCH' | 'WITHHOLDING_FOREIGN_PARTNERSHIP' | 'WITHHOLDING_FOREIGN_TRUST' | 'NONWITHHOLDING_FOREIGN_PARTNERSHIP' | 'NONWITHHOLDING_FOREIGN_SIMPLE_TRUST' | 'NONWITHHOLDING_FOREIGN_GRANTOR_TRUST', chapter_4_status: 'NONPARTICIPATING_FFI' | 'PARTICIPATING_FFI' | 'REPORTING_MODEL1_FFI' | 'REPORTING_MODEL2_FFI' | 'REGISTERED_DEEMED_COMPLIANT_FFI' | 'TERRITORY_FINANCIAL_INSTITUTION' | 'SPONSORED_FFI' | 'CERTIFIED_DEEMED_COMPLIANT_NONREGISTERING_LOCAL_BANK' | 'CERTIFIED_DEEMED_COMPLIANT_FFI_WITH_ONLY_LOW_VALUE_ACCOUNTS' | 'CERTIFIED_DEEMED_COMPLIANT_SPONSORED_CLOSELY_HELD_INVESTMENT_VEHICLE' | 'CERTIFIED_DEEMED_COMPLIANT_LIMITED_LIFE_DEBT_INVESTMENT_ENTITY' | 'CERTAIN_INVESTMENT_ENTITIES_THAT_DO_NOT_MAINTAIN_FINANCIAL_ACCOUNTS' | 'OWNER_DOCUMENTED_FFI' | 'RESTRICTED_DISTRIBUTOR' | 'FOREIGN_CENTRAL_BANK_OF_ISSUE' | 'NONREPORTING_IGA_FFI' | 'EXEMPT_RETIREMENT_PLANS' | 'EXCEPTED_NONFINANCIAL_GROUP_ENTITY' | 'EXCEPTED_NONFINANCIAL_START_UP_COMPANY' | 'EXCEPTED_NONFINANCIAL_ENTITY_IN_LIQUIDATION_OR_BANKRUPTCY' | 'PUBLICLY_TRADED_NFFE_OR_NFFE_AFFILIATE_OF_A_PUBLICLY_TRADED_CORPORATION' | 'EXCEPTED_TERRITORY_NFFE' | 'ACTIVE_NFFE' | 'PASSIVE_NFFE' | 'DIRECT_REPORTING_NFFE' | 'SPONSORED_DIRECT_REPORTING_NFFE', us_tin_type?: ('QI-EIN' | 'WP-EIN' | 'WT-EIN' | 'EIN') | undefined, us_tin?: string | undefined, giin?: string | undefined, foreign_tin?: string | undefined, is_ftin_not_legally_required?: boolean | undefined, reference_number?: string | undefined, qualified_intermediary?: QualifiedIntermediaryInfo | undefined, disregarded_entity_branch?: DisregardedEntityBranch | undefined, certification: W8Certification}; export type CreateApiPayoutUserTokenTaxInterviewW8imyArgs = {body: W8IMYFormRequest}; export type CreateApiPayoutUserTokenTaxInterviewW8imyOptions = {baseUrl?: string | undefined, AUTHORIZERNAME?: string | undefined, fetch?: typeof fetch | undefined}; export const taxFormError = z.object({id: z.string().optional(), name: z.string().optional(), message: z.string().optional()}); export const taxFormSubmissionResponse = z.object({submission_id: z.string().optional(), form_type: z.enum(["W9", "W8BEN", "W8BENE", "W8ECI", "W8IMY"]).optional(), status: z.enum(["Submitted", "Pending", "Validated", "Error"]).optional(), submitted_at: z.string().optional(), errors: z.array(taxFormError).optional(), pdf_content: z.string().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 }; /** * Submit W-8IMY tax form * * POST /payout/{user_token}/tax/interview/w8imy * * Also accepts auth: api_key */ export const createApiPayoutUserTokenTaxInterviewW8imy = async (args: CreateApiPayoutUserTokenTaxInterviewW8imyArgs, options?: CreateApiPayoutUserTokenTaxInterviewW8imyOptions) => { const {baseUrl = "https://api.masspay.io/v1.0.0", fetch: fetchFn = fetch, AUTHORIZERNAME} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (AUTHORIZERNAME !== undefined) headers.set("Authorization", AUTHORIZERNAME) const url = `${baseUrl.replace(/\/+$/, '')}/payout/${encodeURIComponent(String(args.user_token))}/tax/interview/w8imy${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(taxFormSubmissionResponse, await res.json()) };