import * as z from "zod/v3"; import * as components from "../components/index.js"; import { MoovError } from "./mooverror.js"; /** * Details of a Transfer. */ export type TransferData = { transferID: string; createdOn: Date; source: components.TransferSource; destination: components.TransferDestination; completedOn?: Date | undefined; /** * Status of a transfer. */ status: components.TransferStatus; /** * Reason for a transfer's failure. */ failureReason?: components.TransferFailureReason | undefined; amount: components.Amount; /** * An optional description of the transfer that is used on receipts and for your own internal use. */ description?: string | undefined; /** * Free-form key-value pair list. Useful for storing information that is not captured elsewhere. */ metadata?: { [k: string]: string; } | undefined; /** * Total or markup fee. */ facilitatorFee?: components.FacilitatorFee | undefined; /** * Fees charged to your platform account for transfers. */ moovFee?: number | undefined; /** * Same as `moovFee`, but a decimal-formatted numerical string that represents up to 9 decimal place precision. */ moovFeeDecimal?: string | undefined; /** * Processing and pass-through costs that add up to the moovFee. */ moovFeeDetails?: components.MoovFeeDetails | undefined; /** * Fees charged to accounts involved in the transfer. */ moovFees?: Array | undefined; groupID?: string | undefined; cancellations?: Array | undefined; refundedAmount?: components.Amount | undefined; refunds?: Array | undefined; disputedAmount?: components.Amount | undefined; disputes?: Array | undefined; /** * ID of the sweep that created this transfer. */ sweepID?: string | undefined; scheduleID?: string | undefined; occurrenceID?: string | undefined; paymentLinkCode?: string | undefined; /** * Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged. */ salesTaxAmount?: components.Amount | undefined; /** * Optional alias from a foreign/external system which can be used to reference this resource. */ foreignID?: string | undefined; /** * An optional collection of line items for a transfer. * * @remarks * When line items are provided, their total plus sales tax must equal the transfer amount. */ lineItems?: components.TransferLineItems | undefined; }; /** * Details of a Transfer. */ export declare class Transfer extends MoovError { transferID: string; createdOn: Date; source: components.TransferSource; destination: components.TransferDestination; completedOn?: Date | undefined; /** * Status of a transfer. */ status: components.TransferStatus; /** * Reason for a transfer's failure. */ failureReason?: components.TransferFailureReason | undefined; amount: components.Amount; /** * An optional description of the transfer that is used on receipts and for your own internal use. */ description?: string | undefined; /** * Free-form key-value pair list. Useful for storing information that is not captured elsewhere. */ metadata?: { [k: string]: string; } | undefined; /** * Total or markup fee. */ facilitatorFee?: components.FacilitatorFee | undefined; /** * Fees charged to your platform account for transfers. */ moovFee?: number | undefined; /** * Same as `moovFee`, but a decimal-formatted numerical string that represents up to 9 decimal place precision. */ moovFeeDecimal?: string | undefined; /** * Processing and pass-through costs that add up to the moovFee. */ moovFeeDetails?: components.MoovFeeDetails | undefined; /** * Fees charged to accounts involved in the transfer. */ moovFees?: Array | undefined; groupID?: string | undefined; cancellations?: Array | undefined; refundedAmount?: components.Amount | undefined; refunds?: Array | undefined; disputedAmount?: components.Amount | undefined; disputes?: Array | undefined; /** * ID of the sweep that created this transfer. */ sweepID?: string | undefined; scheduleID?: string | undefined; occurrenceID?: string | undefined; paymentLinkCode?: string | undefined; /** * Optional sales tax amount. `transfer.amount.value` should be inclusive of any sales tax and represents the total amount charged. */ salesTaxAmount?: components.Amount | undefined; /** * Optional alias from a foreign/external system which can be used to reference this resource. */ foreignID?: string | undefined; /** * An optional collection of line items for a transfer. * * @remarks * When line items are provided, their total plus sales tax must equal the transfer amount. */ lineItems?: components.TransferLineItems | undefined; /** The original data that was passed to this error instance. */ data$: TransferData; constructor(err: TransferData, httpMeta: { response: Response; request: Request; body: string; }); } /** @internal */ export declare const Transfer$inboundSchema: z.ZodType; /** @internal */ export type Transfer$Outbound = { transferID: string; createdOn: string; source: components.TransferSource$Outbound; destination: components.TransferDestination$Outbound; completedOn?: string | undefined; status: string; failureReason?: string | undefined; amount: components.Amount$Outbound; description?: string | undefined; metadata?: { [k: string]: string; } | undefined; facilitatorFee?: components.FacilitatorFee$Outbound | undefined; moovFee?: number | undefined; moovFeeDecimal?: string | undefined; moovFeeDetails?: components.MoovFeeDetails$Outbound | undefined; moovFees?: Array | undefined; groupID?: string | undefined; cancellations?: Array | undefined; refundedAmount?: components.Amount$Outbound | undefined; refunds?: Array | undefined; disputedAmount?: components.Amount$Outbound | undefined; disputes?: Array | undefined; sweepID?: string | undefined; scheduleID?: string | undefined; occurrenceID?: string | undefined; paymentLinkCode?: string | undefined; salesTaxAmount?: components.Amount$Outbound | undefined; foreignID?: string | undefined; lineItems?: components.TransferLineItems$Outbound | undefined; }; /** @internal */ export declare const Transfer$outboundSchema: z.ZodType; //# sourceMappingURL=transfer.d.ts.map