import * as z from "zod/v3"; import { Result as SafeParseResult } from "../../types/fp.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; import { AmountDecimal, AmountDecimal$Outbound } from "./amountdecimal.js"; import { BillingSummaryDetails, BillingSummaryDetails$Outbound } from "./billingsummarydetails.js"; import { BillingSummaryInterchange, BillingSummaryInterchange$Outbound } from "./billingsummaryinterchange.js"; import { PartnerFees, PartnerFees$Outbound } from "./partnerfees.js"; /** * The total transaction volume amount. This field is deprecated and will be removed in a future release. * * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible. */ export type BillingSummaryVolumeAmount = { /** * A 3-letter ISO 4217 currency code. */ currency: string; /** * A decimal-formatted numerical string that represents up to 9 decimal place precision. * * @remarks * * For example, $12.987654321 is '12.987654321'. */ valueDecimal: string; }; /** * A summary of card acquiring fees. */ export type CardAcquiring = { /** * The total transaction volume amount. This field is deprecated and will be removed in a future release. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ volumeAmount?: BillingSummaryVolumeAmount | undefined; /** * The total number of transactions. This field is deprecated and will be removed in a future release. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ volumeCount?: number | undefined; /** * The total fee amount. */ feeAmount?: AmountDecimal | undefined; /** * Total fee revenue collected from merchants. */ merchantFeesCollected?: AmountDecimal | undefined; /** * Total fee costs incurred by the partner. */ partnerFeesAssessed?: AmountDecimal | undefined; /** * Net revenue after deducting partner fee costs. */ netIncome?: AmountDecimal | undefined; /** * A summary of interchange fees by card brand. */ interchangeFees?: BillingSummaryInterchange | undefined; }; /** * The total amount of platform fees. This field is deprecated and will be removed in a future release. Use summary.accountFees. * * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible. */ export type BillingSummaryPlatformFees = { /** * A 3-letter ISO 4217 currency code. */ currency: string; /** * A decimal-formatted numerical string that represents up to 9 decimal place precision. * * @remarks * * For example, $12.987654321 is '12.987654321'. */ valueDecimal: string; }; /** * The total amount of adjustment fees. This field is deprecated and will be removed in a future release. * * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible. */ export type AdjustmentFees = { /** * A 3-letter ISO 4217 currency code. */ currency: string; /** * A decimal-formatted numerical string that represents up to 9 decimal place precision. * * @remarks * * For example, $12.987654321 is '12.987654321'. */ valueDecimal: string; }; /** * The total amount of other card fees. This field is deprecated and will be removed in a future release. Use summary.otherCardFees. * * @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible. */ export type OtherFees = { /** * A 3-letter ISO 4217 currency code. */ currency: string; /** * A decimal-formatted numerical string that represents up to 9 decimal place precision. * * @remarks * * For example, $12.987654321 is '12.987654321'. */ valueDecimal: string; }; /** * A summary of all fees included in a statement. */ export type BillingSummary = { /** * A summary of card acquiring fees. */ cardAcquiring?: CardAcquiring | undefined; /** * A summary of ACH fees. */ ach?: BillingSummaryDetails | undefined; /** * A summary of instant payment fees. */ instantPayments?: BillingSummaryDetails | undefined; /** * The total amount of platform fees. This field is deprecated and will be removed in a future release. Use summary.accountFees. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ platformFees?: BillingSummaryPlatformFees | undefined; /** * A summary of account fees. */ accountFees?: BillingSummaryDetails | undefined; /** * The total amount of adjustment fees. This field is deprecated and will be removed in a future release. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ adjustmentFees?: AdjustmentFees | undefined; /** * The total amount of other card fees. This field is deprecated and will be removed in a future release. Use summary.otherCardFees. * * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible. */ otherFees?: OtherFees | undefined; /** * A summary of other card fees. */ otherCardFees?: BillingSummaryDetails | undefined; /** * The total amount of all fees. */ total?: AmountDecimal | undefined; /** * Total net revenue after deducting total partner fees. */ netIncomeSubtotal?: BillingSummaryDetails | undefined; /** * Partner’s share of the net income, expressed as a percentage. */ revenueShare?: string | undefined; /** * The portion of net income allocated to the partner before monthly partner costs. */ residualSubtotal?: AmountDecimal | undefined; /** * Monthly partner costs that are charged separately and not included in residual subtotal (e.g. platform fees, minimums). */ monthlyPartnerCosts?: PartnerFees | undefined; /** * Final partner payment after deducting monthlyPartnerCosts. */ netPartnerPayment?: AmountDecimal | undefined; }; /** @internal */ export declare const BillingSummaryVolumeAmount$inboundSchema: z.ZodType; /** @internal */ export type BillingSummaryVolumeAmount$Outbound = { currency: string; valueDecimal: string; }; /** @internal */ export declare const BillingSummaryVolumeAmount$outboundSchema: z.ZodType; export declare function billingSummaryVolumeAmountToJSON(billingSummaryVolumeAmount: BillingSummaryVolumeAmount): string; export declare function billingSummaryVolumeAmountFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const CardAcquiring$inboundSchema: z.ZodType; /** @internal */ export type CardAcquiring$Outbound = { volumeAmount?: BillingSummaryVolumeAmount$Outbound | undefined; volumeCount?: number | undefined; feeAmount?: AmountDecimal$Outbound | undefined; merchantFeesCollected?: AmountDecimal$Outbound | undefined; partnerFeesAssessed?: AmountDecimal$Outbound | undefined; netIncome?: AmountDecimal$Outbound | undefined; interchangeFees?: BillingSummaryInterchange$Outbound | undefined; }; /** @internal */ export declare const CardAcquiring$outboundSchema: z.ZodType; export declare function cardAcquiringToJSON(cardAcquiring: CardAcquiring): string; export declare function cardAcquiringFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const BillingSummaryPlatformFees$inboundSchema: z.ZodType; /** @internal */ export type BillingSummaryPlatformFees$Outbound = { currency: string; valueDecimal: string; }; /** @internal */ export declare const BillingSummaryPlatformFees$outboundSchema: z.ZodType; export declare function billingSummaryPlatformFeesToJSON(billingSummaryPlatformFees: BillingSummaryPlatformFees): string; export declare function billingSummaryPlatformFeesFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const AdjustmentFees$inboundSchema: z.ZodType; /** @internal */ export type AdjustmentFees$Outbound = { currency: string; valueDecimal: string; }; /** @internal */ export declare const AdjustmentFees$outboundSchema: z.ZodType; export declare function adjustmentFeesToJSON(adjustmentFees: AdjustmentFees): string; export declare function adjustmentFeesFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const OtherFees$inboundSchema: z.ZodType; /** @internal */ export type OtherFees$Outbound = { currency: string; valueDecimal: string; }; /** @internal */ export declare const OtherFees$outboundSchema: z.ZodType; export declare function otherFeesToJSON(otherFees: OtherFees): string; export declare function otherFeesFromJSON(jsonString: string): SafeParseResult; /** @internal */ export declare const BillingSummary$inboundSchema: z.ZodType; /** @internal */ export type BillingSummary$Outbound = { cardAcquiring?: CardAcquiring$Outbound | undefined; ach?: BillingSummaryDetails$Outbound | undefined; instantPayments?: BillingSummaryDetails$Outbound | undefined; platformFees?: BillingSummaryPlatformFees$Outbound | undefined; accountFees?: BillingSummaryDetails$Outbound | undefined; adjustmentFees?: AdjustmentFees$Outbound | undefined; otherFees?: OtherFees$Outbound | undefined; otherCardFees?: BillingSummaryDetails$Outbound | undefined; total?: AmountDecimal$Outbound | undefined; netIncomeSubtotal?: BillingSummaryDetails$Outbound | undefined; revenueShare?: string | undefined; residualSubtotal?: AmountDecimal$Outbound | undefined; monthlyPartnerCosts?: PartnerFees$Outbound | undefined; netPartnerPayment?: AmountDecimal$Outbound | undefined; }; /** @internal */ export declare const BillingSummary$outboundSchema: z.ZodType; export declare function billingSummaryToJSON(billingSummary: BillingSummary): string; export declare function billingSummaryFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=billingsummary.d.ts.map