import {z} from 'zod' export type CurrencyCode = string; export type AmountIntegerValueInput = {currency: CurrencyCode, value: number}; export type AmountStringValueInput = {currency: CurrencyCode, stringValue: string}; export type AmountInput = AmountIntegerValueInput | AmountStringValueInput; export type DirectDebitSchemeType = 'SDD_CORE' | 'SDD_B2B' | 'GB_DD_BACS' | 'AUTOGIRO' | 'CH_DD_LSV' | 'CH_DD_BDD' | 'US_DD_ACH'; export type InstrumentType = 'US_ACH' | 'CITI_WORLDLINK'; export type InstrumentInput = {type: InstrumentType}; export type SchemeDetailsUrgency = 'HIGH'; export type SchemeDetailsInput = {instrument?: InstrumentInput | undefined, intraCompany?: boolean | undefined, urgency?: SchemeDetailsUrgency | undefined}; export type Date = string; export type AccountType = 'ACCOUNT' | 'EXTERNAL_ACCOUNT' | 'INLINE'; export type ExternalAccountRef = {type: AccountType, id: string}; export type InternalAccountRef = {type: AccountType, id: string}; export type PaymentReference = string; export type CategoryPurpose = string; export type ChargeBearer = 'SHARED' | 'DEBTOR' | 'CREDITOR' | 'SERVICE_LEVEL'; export type ExternalID = string; export type Metadata = {[key: string]: string} | null; export type ResourceID = string; export type CreateDirectDebitRequest = {amount: AmountInput, scheme: DirectDebitSchemeType, schemeDetails?: SchemeDetailsInput | undefined, date: Date, source: ExternalAccountRef, destination: InternalAccountRef, reference: PaymentReference, categoryPurpose?: CategoryPurpose | undefined, chargeBearer?: ChargeBearer | undefined, externalId?: ExternalID | undefined, metadata?: Metadata | undefined, paymentScheduleId?: ResourceID | undefined}; export type CreateApiPaymentsV2DirectDebitsArgs = {body: CreateDirectDebitRequest}; export type CreateApiPaymentsV2DirectDebitsOptions = {baseUrl?: string | undefined, basicAuth?: {username: string, password: string} | undefined, fetch?: typeof fetch | undefined}; export const resourceID = z.string().min(32).max(64); export const organizationID = z.string(); export const currencyCode = z.string().min(3).max(3); export const amount = z.object({currency: currencyCode, stringValue: z.string(), value: z.number().int()}); export const directDebitSchemeType = z.enum(["SDD_CORE", "SDD_B2B", "GB_DD_BACS", "AUTOGIRO", "CH_DD_LSV", "CH_DD_BDD", "US_DD_ACH"]); export const instrumentType = z.enum(["US_ACH", "CITI_WORLDLINK"]); export const instrument = z.discriminatedUnion("type", [z.object({type: instrumentType, citiWorldlinkId: z.string()}), z.object({type: instrumentType, usAchCompanyId: z.string(), usAchCompanyName: z.string().optional(), usAchImmediateOrigin: z.string().optional()})]); export const schemeDetailsUrgency = z.literal("HIGH"); export const schemeDetails = z.object({instrument: instrument.optional(), intraCompany: z.boolean().optional(), initiatorId: z.string().optional(), urgency: schemeDetailsUrgency.optional()}); export const date = z.string(); export const paymentStatus = z.enum(["CREATED", "APPROVED", "REJECTED", "PENDING_SUBMISSION", "SENT", "PENDING_AT_BANK", "ACCEPTED", "EXECUTED", "FAILED", "RETURNED", "UNKNOWN"]); export const paymentStatusReason = z.object({code: z.string().optional(), description: z.string().optional()}); export const accountType = z.enum(["ACCOUNT", "EXTERNAL_ACCOUNT", "INLINE"]); export const marketCode = z.string().min(2).max(2); export const accountIdentifierType = z.enum(["IBAN", "NUMBER", "ADYEN", "AU_BPAY_BILLER_CODE", "DK_FIK", "INVESTMENT_NUMBER", "MY_JOMPAY_BILLER_CODE", "NATIONAL_ID_NUMBER", "PAYPAL", "PROPRIETARY", "SE_BANKGIRO", "SE_PLUSGIRO", "SOLDO", "WALLET_ADYEN_BALANCE_PLATFORM", "WALLET_AIRWALLEX", "WALLET_AIRWALLEX_NUMBER", "WALLET_CURRENCYCLOUD", "WALLET_FLASH_PAYMENTS", "WALLET_FREEMARKET", "WALLET_HYPERWALLET", "WALLET_INPAY", "WALLET_LEAD", "WALLET_MERCURY", "WALLET_MONEYCORP", "WALLET_PAYHAWK", "WALLET_REVOLUT", "WALLET_SKRILL", "WALLET_STRIPE", "WALLET_SWISSQUOTE", "WALLET_UNIT"]); export const accountIdentifier = z.object({type: accountIdentifierType, market: marketCode, number: z.string().min(1).max(255), invalid: z.boolean().optional()}); export const routingIdentifierType = z.enum(["BIC", "AT_BLZ", "AU_BSB", "BD_BRN", "BR_BRANCH", "BR_COMPE", "BR_ISP", "CA_CPA", "CH_BCC", "CH_SIC", "CL_SBIF", "CN_APS", "CZ_NBC", "DE_BLZ", "ES_NCC", "GB_DSC", "GR_BIC", "HK_NCC", "IE_NCC", "IL_NCC", "IN_FSC", "IT_NCC", "JP_ZGN", "KR_BOK", "KR_KFTC", "MX_ABM", "MY_NCC", "NZ_NCC", "PH_BRSTN", "PL_KNR", "PT_NCC", "RU_CBC", "SE_SBA", "SG_IBG", "TH_CBC", "TW_NCC", "US_ABA", "US_PID", "VN_CITAD", "ZA_NCC"]); export const routingConstraints = z.object({accountNumberType: accountIdentifierType.optional(), scheme: z.string().optional()}); export const routingIdentifier = z.object({type: routingIdentifierType, number: z.string().min(1).max(255), invalid: z.boolean().optional(), constraints: routingConstraints.optional()}); export const accountSnapshot = z.object({type: accountType, id: resourceID, organizationId: organizationID, market: marketCode, identifiers: z.array(accountIdentifier), routing: z.array(routingIdentifier), currency: currencyCode}); export const externalID = z.string(); export const countryCode = z.string().min(2).max(2); export const countrySubdivision = z.string().max(6); export const address = z.object({country: countryCode.optional(), countrySubdivision: countrySubdivision.optional(), city: z.string().max(64).optional(), postalCode: z.string().max(16).optional(), streetName: z.string().max(64).optional(), streetNumber: z.string().max(16).optional()}); export const nationalIdentifier = z.object({type: z.enum(["CIVIC", "COMPANY"]), market: marketCode, number: z.string()}); export const partyType = z.enum(["INDIVIDUAL", "COMPANY"]); export const accountHolder = z.object({type: z.enum(["COUNTERPARTY", "ENTITY", "INLINE"]), id: z.string().optional(), externalId: externalID.optional(), legalName: z.string(), address: address.optional(), nationalIdentifier: nationalIdentifier.optional(), partyType: partyType.optional(), email: z.string().optional(), phone: z.string().optional()}); export const externalAccountSnapshot = z.object({type: accountType, id: resourceID, externalId: externalID.optional(), organizationId: organizationID, market: marketCode, identifiers: z.array(accountIdentifier), routing: z.array(routingIdentifier).optional()}); export const resourceVersion = z.number().int().gte(1); export const mandateSnapshot = z.object({id: resourceID, creditorReference: z.string(), mandateReference: z.string().min(1).max(35), finalCollection: z.boolean(), signatureDate: date.optional(), version: resourceVersion}); export const approvalStatus = z.enum(["PENDING", "APPROVED", "REJECTED"]); export const userAuditInfo = z.object({id: resourceID, username: z.string(), name: z.string().optional(), roleId: z.string().optional()}); export const paymentApprovalStep = z.object({id: z.string(), approvalChainId: z.string(), requiredRoleIds: z.array(z.string()).optional(), status: approvalStatus, approver: userAuditInfo.optional(), updated: z.string().optional(), autoApproved: z.boolean(), allowCreatorApproval: z.boolean().optional(), sequentialApproval: z.boolean().optional(), sequenceNumber: z.number().int().optional()}); export const attachedTransactionRef = z.object({type: z.literal("TRANSACTION"), id: z.string()}); export const paymentReference = z.string().max(140); export const categoryPurpose = z.string(); export const chargeBearer = z.enum(["SHARED", "DEBTOR", "CREDITOR", "SERVICE_LEVEL"]); export const batchTreatmentType = z.enum(["INDIVIDUAL_PAYMENTS", "BATCH"]); export const batchDetails = z.object({id: resourceID, treatment: batchTreatmentType}); export const eTag = z.string(); export const metadata = z.record(z.string(), z.string()).nullable(); export const createdTimestamp = z.string(); export const updatedTimestamp = z.string(); export const directDebit = z.object({id: resourceID, organizationId: organizationID, creatorUserId: resourceID.optional(), amount: amount, scheme: directDebitSchemeType, schemeDetails: schemeDetails.optional(), date: date, status: paymentStatus, statusReason: paymentStatusReason.optional(), destination: accountSnapshot, destinationHolder: accountHolder, source: externalAccountSnapshot, sourceHolder: accountHolder, mandate: mandateSnapshot.optional(), approvalSteps: z.array(paymentApprovalStep), attachedTransactions: z.array(attachedTransactionRef), reference: paymentReference, categoryPurpose: categoryPurpose.optional(), chargeBearer: chargeBearer.optional(), connectionInstructionId: z.string().optional(), batch: batchDetails.optional(), paymentScheduleId: resourceID.optional(), etag: eTag, externalId: externalID.optional(), metadata: metadata.optional(), version: resourceVersion, created: createdTimestamp, updated: updatedTimestamp}); 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 }; /** * Create direct debit * * POST /payments/v2/direct-debits */ export const createApiPaymentsV2DirectDebits = async (args: CreateApiPaymentsV2DirectDebitsArgs, options?: CreateApiPaymentsV2DirectDebitsOptions) => { const {baseUrl = "https://api.atlar.com", fetch: fetchFn = fetch, basicAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (basicAuth !== undefined) headers.set('authorization', `Basic ${btoa(`${basicAuth.username}:${basicAuth.password}`)}`) const url = `${baseUrl.replace(/\/+$/, '')}/payments/v2/direct-debits${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(directDebit, await res.json()) };