import {z} from 'zod' export type GetApiInternationalPaymentsInternationalPaymentIdArgs = {InternationalPaymentId: string, 'x-fapi-auth-date'?: string | undefined, 'x-fapi-customer-ip-address'?: string | undefined, 'x-fapi-interaction-id'?: string | undefined, Authorization: string, 'x-customer-user-agent'?: string | undefined, 'x-client-id'?: string | undefined}; export type GetApiInternationalPaymentsInternationalPaymentIdOptions = {baseUrl: string, TPPOAuth2Security?: string | undefined, fetch?: typeof fetch | undefined}; export const externalPaymentTransactionStatus3Code = z.enum(["RCVD", "PDNG", "ACTC", "PATC", "ACCP", "ACFC", "ACSP", "ACWC", "ACSC", "BLCK", "ACCC", "ACWP", "RJCT"]); export const oBStatusReason = z.object({StatusReasonCode: z.string().min(1).max(4).optional(), StatusReasonDescription: z.string().min(1).max(500).optional(), Path: z.string().min(1).max(500).optional()}); export const oBInternalAccountIdentification4Code = z.string(); export const identification0 = z.string().min(1).max(256); export const secondaryIdentification = z.string().min(1).max(34); export const oBDomesticRefundAccount1 = z.object({Account: z.object({SchemeName: oBInternalAccountIdentification4Code, Identification: identification0, Name: z.string().min(1).max(350), SecondaryIdentification: secondaryIdentification.optional()})}); export const oBInternalChargeBearerType1Code = z.enum(["BorneByCreditor", "BorneByDebtor", "FollowingServiceLevel", "Shared"]); export const oBInternalPaymentChargeType1Code = z.string(); export const oBActiveCurrencyAndAmountSimpleType = z.string(); export const activeOrHistoricCurrencyCode = z.string(); export const oBActiveOrHistoricCurrencyAndAmount = z.object({Amount: oBActiveCurrencyAndAmountSimpleType, Currency: activeOrHistoricCurrencyCode}); export const oBInternalLocalInstrument1Code = z.string(); export const externalProxyAccountType1Code = z.enum(["TELE", "EMAL", "DNAM", "CINC", "COTX", "COID", "CUST", "DRLC", "EIDN", "EWAL", "PVTX", "LEIC", "MBNO", "NIDN", "CCPT", "SHID", "SOSE", "TOKN", "UBIL", "VIPN", "BIID"]); export const oBProxy1 = z.object({Identification: z.string().min(1).max(2048), Code: externalProxyAccountType1Code, Type: z.string().min(1).max(35).optional()}); export const lEI = z.string().min(1).max(20); export const oBAddressType2Code = z.enum(["BIZZ", "DLVY", "MLTO", "PBOX", "ADDR", "HOME", "CORR", "STAT"]); export const department = z.string().min(1).max(70); export const subDepartment = z.string().min(1).max(70); export const streetName = z.string().min(1).max(140); export const buildingNumber = z.string().min(1).max(16); export const buildingName = z.string().min(1).max(140); export const floor = z.string().min(1).max(70); export const unitNumber = z.string().min(1).max(16); export const room = z.string().min(1).max(70); export const postBox = z.string().min(1).max(16); export const townName = z.string().min(1).max(140); export const districtName = z.string().min(1).max(140); export const careOf = z.string().min(1).max(140); export const postCode = z.string().min(1).max(16); export const countrySubDivision = z.string().min(1).max(35); export const countryCode = z.string(); export const oBPostalAddress7 = z.object({AddressType: oBAddressType2Code.optional(), Department: department.optional(), SubDepartment: subDepartment.optional(), StreetName: streetName.optional(), BuildingNumber: buildingNumber.optional(), BuildingName: buildingName.optional(), Floor: floor.optional(), UnitNumber: unitNumber.optional(), Room: room.optional(), PostBox: postBox.optional(), TownLocationName: townName.optional(), DistrictName: districtName.optional(), CareOf: careOf.optional(), PostCode: postCode.optional(), TownName: townName.optional(), CountrySubDivision: countrySubDivision.optional(), Country: countryCode.optional(), AddressLine: z.array(z.string().min(1).max(70)).optional()}); export const oBInternalFinancialInstitutionIdentification4Code = z.string(); export const identification1 = z.string().min(1).max(35); export const name = z.string().min(1).max(140); export const oBUltimateCreditor1 = z.object({Name: z.string().min(1).max(140).optional(), Identification: z.string().min(1).max(256).optional(), LEI: lEI.optional(), SchemeName: oBInternalAccountIdentification4Code.optional(), PostalAddress: oBPostalAddress7.optional()}); export const oBUltimateDebtor1 = z.object({Name: z.string().min(1).max(140).optional(), Identification: z.string().min(1).max(256).optional(), LEI: lEI.optional(), SchemeName: oBInternalAccountIdentification4Code.optional(), PostalAddress: oBPostalAddress7.optional()}); export const oBRegulatoryAuthority2 = z.object({Name: z.string().min(1).max(140).optional(), CountryCode: countryCode.optional()}); export const iSODateTime = z.string(); export const oBStructuredRegulatoryReporting3 = z.object({Type: z.string().min(1).max(35).optional(), Date: iSODateTime.optional(), Country: countryCode.optional(), Amount: oBActiveOrHistoricCurrencyAndAmount.optional(), Information: z.array(z.string().min(1).max(35)).optional()}); export const oBRegulatoryReporting1 = z.object({DebitCreditReportingIndicator: z.enum(["CRED", "DEBT", "BOTH"]).optional(), Authority: oBRegulatoryAuthority2.optional(), Details: z.array(oBStructuredRegulatoryReporting3).optional()}); export const externalDocumentType1Code = z.enum(["CINV", "CNFA", "CONT", "CREN", "DEBN", "DISP", "DNFA", "HIRI", "INVS", "MSIN", "PROF", "PUOR", "QUOT", "SBIN", "SPRR", "TISH"]).min(1).max(4); export const oBReferredDocumentInformation = z.object({Code: externalDocumentType1Code.optional(), Issuer: z.string().min(1).max(35).optional(), Number: z.string().min(1).max(35).optional(), RelatedDate: z.string().optional(), LineDetails: z.array(z.string().min(1).max(2048)).optional()}); export const externalCreditorReferenceType1Code = z.enum(["DISP", "FXDR", "PUOR", "RPIN", "RADM", "SCOR"]).min(1).max(4); export const identification3 = z.string().min(1).max(256); export const identification4 = z.string().min(1).max(256); export const oBRemittanceInformationStructured = z.object({ReferredDocumentInformation: z.array(oBReferredDocumentInformation).optional(), ReferredDocumentAmount: oBActiveCurrencyAndAmountSimpleType.optional(), CreditorReferenceInformation: z.object({Code: externalCreditorReferenceType1Code.optional(), Issuer: z.string().min(1).max(35).optional(), Reference: z.string().min(1).max(35).optional()}).optional(), Invoicer: identification3.optional(), Invoicee: identification4.optional(), TaxRemittance: z.string().min(1).max(140).optional(), AdditionalRemittanceInformation: z.array(z.string().min(1).max(140)).optional()}); export const oBRemittanceInformation2 = z.object({Structured: z.array(oBRemittanceInformationStructured).optional(), Unstructured: z.array(z.string().min(1).max(140)).optional()}); export const oBSupplementaryData1 = z.record(z.string(), z.unknown()); export const oBCashAccountDebtor4 = z.object({SchemeName: z.string().optional(), Identification: z.string().optional(), Name: z.string().optional(), SecondaryIdentification: z.string().optional(), LEI: lEI.optional()}); export const links = z.object({Self: z.string(), First: z.string().optional(), Prev: z.string().optional(), Next: z.string().optional(), Last: z.string().optional()}); export const meta = z.object({TotalPages: z.number().int().optional(), FirstAvailableDateTime: iSODateTime.optional(), LastAvailableDateTime: iSODateTime.optional()}); export const oBWriteInternationalResponse5 = z.object({Data: z.object({InternationalPaymentId: z.string().min(1).max(40), ConsentId: z.string().min(1).max(128), CreationDateTime: z.string(), Status: externalPaymentTransactionStatus3Code, StatusUpdateDateTime: z.string(), StatusReason: z.array(oBStatusReason).optional(), ExpectedExecutionDateTime: z.string().optional(), ExpectedSettlementDateTime: z.string().optional(), Refund: oBDomesticRefundAccount1.optional(), Charges: z.array(z.object({ChargeBearer: oBInternalChargeBearerType1Code, Type: oBInternalPaymentChargeType1Code, Amount: oBActiveOrHistoricCurrencyAndAmount})).optional(), ExchangeRateInformation: z.object({UnitCurrency: z.string(), ExchangeRate: z.number(), RateType: z.enum(["Actual", "Agreed", "Indicative"]), ContractIdentification: z.string().min(1).max(256).optional(), ExpirationDateTime: z.string().optional()}).optional(), Initiation: z.object({InstructionIdentification: z.string().min(1).max(35), EndToEndIdentification: z.string().min(1).max(35), LocalInstrument: oBInternalLocalInstrument1Code.optional(), InstructionPriority: z.enum(["Normal", "Urgent"]).optional(), ExtendedPurpose: z.string().min(1).max(140).optional(), ChargeBearer: oBInternalChargeBearerType1Code.optional(), CurrencyOfTransfer: z.string(), DestinationCountryCode: z.string().optional(), InstructedAmount: z.object({Amount: oBActiveCurrencyAndAmountSimpleType, Currency: activeOrHistoricCurrencyCode}), ExchangeRateInformation: z.object({UnitCurrency: z.string(), ExchangeRate: z.number().optional(), RateType: z.enum(["Actual", "Agreed", "Indicative"]), ContractIdentification: z.string().min(1).max(256).optional()}).optional(), DebtorAccount: z.object({SchemeName: oBInternalAccountIdentification4Code, Identification: identification0, Name: z.string().min(1).max(350).optional(), SecondaryIdentification: secondaryIdentification.optional(), Proxy: oBProxy1.optional()}).optional(), Creditor: z.object({Name: z.string().min(1).max(350).optional(), LEI: lEI.optional(), PostalAddress: oBPostalAddress7.optional()}).optional(), CreditorAgent: z.object({SchemeName: oBInternalFinancialInstitutionIdentification4Code.optional(), Identification: identification1.optional(), Name: name.optional(), LEI: lEI.optional(), PostalAddress: oBPostalAddress7.optional()}).optional(), CreditorAccount: z.object({SchemeName: oBInternalAccountIdentification4Code, Identification: identification0, Name: z.string().min(1).max(350), SecondaryIdentification: secondaryIdentification.optional(), Proxy: oBProxy1.optional()}), UltimateCreditor: oBUltimateCreditor1.optional(), UltimateDebtor: oBUltimateDebtor1.optional(), RegulatoryReporting: z.array(oBRegulatoryReporting1).optional(), RemittanceInformation: oBRemittanceInformation2.optional(), SupplementaryData: oBSupplementaryData1.optional()}), MultiAuthorisation: z.object({Status: z.enum(["AUTH", "AWAF", "RJCT"]), NumberRequired: z.number().int().optional(), NumberReceived: z.number().int().optional(), LastUpdateDateTime: z.string().optional(), ExpirationDateTime: z.string().optional()}).optional(), Debtor: oBCashAccountDebtor4.optional()}), Links: links.optional(), Meta: meta.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 an International Payment * * GET /international-payments/{InternationalPaymentId} */ export const getApiInternationalPaymentsInternationalPaymentId = async (args: GetApiInternationalPaymentsInternationalPaymentIdArgs, options: GetApiInternationalPaymentsInternationalPaymentIdOptions) => { const {baseUrl, fetch: fetchFn = fetch, TPPOAuth2Security} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['x-fapi-auth-date'] != null) headers.set("x-fapi-auth-date", String(args['x-fapi-auth-date'])) if (args['x-fapi-customer-ip-address'] != null) headers.set("x-fapi-customer-ip-address", String(args['x-fapi-customer-ip-address'])) if (args['x-fapi-interaction-id'] != null) headers.set("x-fapi-interaction-id", String(args['x-fapi-interaction-id'])) if (args.Authorization != null) headers.set("Authorization", String(args.Authorization)) if (args['x-customer-user-agent'] != null) headers.set("x-customer-user-agent", String(args['x-customer-user-agent'])) if (args['x-client-id'] != null) headers.set("x-client-id", String(args['x-client-id'])) if (TPPOAuth2Security !== undefined) headers.set('authorization', `Bearer ${TPPOAuth2Security}`) const url = `${baseUrl.replace(/\/+$/, '')}/international-payments/${encodeURIComponent(String(args.InternationalPaymentId))}${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(oBWriteInternationalResponse5, await res.json()) };