@xpayeg/sdk 1.0.0

package/dist/index.d.mts

@@ -0,0 +1,3874 @@
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface AddressDto {
+    city: string;
+    country: string;
+    line1: string;
+    line2: string;
+    postalCode: string;
+    state: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface AddressResponseDto {
+    /** Address line 1 */
+    line1?: string;
+    /** Address line 2 */
+    line2?: string;
+    /** City */
+    city?: string;
+    /** State/Province */
+    state?: string;
+    /** Postal code */
+    postalCode?: string;
+    /** Country code */
+    country?: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface AdjustableQuantityDto {
+    /** Whether adjustable quantity is enabled */
+    enabled: boolean;
+    /** Minimum quantity allowed */
+    minimum?: number;
+    /** Maximum quantity allowed */
+    maximum?: number;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface AmountDetailsTaxDto {
+    /** Tax amount charged on this payment, in the smallest currency unit (e.g. piasters for EGP). */
+    amount: number;
+    /** Tax rate applied, in basis points (1% = 100 bps). For example, `1400` means 14%. */
+    rateBps: number;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * Tax breakdown for this payment. `null` if no tax was collected.
+ * @nullable
+ */
+type AmountDetailsDtoTax = AmountDetailsTaxDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface AmountDetailsPlatformFeesDto {
+    /** Platform fee charged by XPay on this payment, in the smallest currency unit. */
+    amount: number;
+    /** VAT charged on the platform fee itself, in the smallest currency unit. */
+    vatAmount: number;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * Platform fee breakdown for this payment. `null` if not surfaced to the customer.
+ * @nullable
+ */
+type AmountDetailsDtoPlatformFees = AmountDetailsPlatformFeesDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface AmountDetailsDto {
+    /** Amount that pays for the product/service itself, in the smallest currency unit. Excludes tax, platform fees, tip, and discount. */
+    productAmount: number;
+    /**
+     * Tax breakdown for this payment. `null` if no tax was collected.
+     * @nullable
+     */
+    tax?: AmountDetailsDtoTax;
+    /**
+     * Platform fee breakdown for this payment. `null` if not surfaced to the customer.
+     * @nullable
+     */
+    platformFees?: AmountDetailsDtoPlatformFees;
+    /**
+     * Tip amount included in this payment, in the smallest currency unit. `null` if no tip.
+     * @nullable
+     */
+    tip?: number | null;
+    /**
+     * Discount amount applied, in the smallest currency unit. `null` if no discount.
+     * @nullable
+     */
+    discount?: number | null;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type BalanceTransactionFeeDetailDtoCurrency = typeof BalanceTransactionFeeDetailDtoCurrency[keyof typeof BalanceTransactionFeeDetailDtoCurrency];
+declare const BalanceTransactionFeeDetailDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface BalanceTransactionFeeDetailDto {
+    amount: number;
+    currency: BalanceTransactionFeeDetailDtoCurrency;
+    description: string;
+    /** Fee type. PROCESSOR_COST entries are internal (platform COGS) and are filtered out of merchant-facing payloads. */
+    type: string;
+    /** @nullable */
+    application: string | null;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type BalanceTransactionPayoutBatchDtoCurrency = typeof BalanceTransactionPayoutBatchDtoCurrency[keyof typeof BalanceTransactionPayoutBatchDtoCurrency];
+declare const BalanceTransactionPayoutBatchDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Batch lifecycle status. Merchant-facing status equals the batch status (not the individual payout status).
+ */
+type BalanceTransactionPayoutBatchDtoStatus = typeof BalanceTransactionPayoutBatchDtoStatus[keyof typeof BalanceTransactionPayoutBatchDtoStatus];
+declare const BalanceTransactionPayoutBatchDtoStatus: {
+    readonly open: "open";
+    readonly processing: "processing";
+    readonly in_transit: "in_transit";
+    readonly paid: "paid";
+    readonly partial_failed: "partial_failed";
+    readonly failed: "failed";
+    readonly canceled: "canceled";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface BalanceTransactionPayoutBatchDto {
+    /** PayoutBatch ID */
+    id: string;
+    object: string;
+    /** Total disbursement amount (batch total) */
+    amount: number;
+    currency: BalanceTransactionPayoutBatchDtoCurrency;
+    /** Batch lifecycle status. Merchant-facing status equals the batch status (not the individual payout status). */
+    status: BalanceTransactionPayoutBatchDtoStatus;
+    /**
+     * Expected / actual arrival date (ISO date, merchant business calendar). Null while batch is still OPEN / PROCESSING.
+     * @nullable
+     */
+    arrivalDate?: string | null;
+    /** Batch created timestamp (ISO 8601) */
+    createdAt: string;
+    /** Batch last-updated timestamp (ISO 8601) */
+    updatedAt: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Currency
+ */
+type BalanceTransactionResponseDtoCurrency = typeof BalanceTransactionResponseDtoCurrency[keyof typeof BalanceTransactionResponseDtoCurrency];
+declare const BalanceTransactionResponseDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Transaction status
+ */
+type BalanceTransactionResponseDtoStatus = typeof BalanceTransactionResponseDtoStatus[keyof typeof BalanceTransactionResponseDtoStatus];
+declare const BalanceTransactionResponseDtoStatus: {
+    readonly AVAILABLE: "AVAILABLE";
+    readonly PENDING: "PENDING";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Transaction type
+ */
+type BalanceTransactionResponseDtoType = typeof BalanceTransactionResponseDtoType[keyof typeof BalanceTransactionResponseDtoType];
+declare const BalanceTransactionResponseDtoType: {
+    readonly CHARGE: "CHARGE";
+    readonly PAYMENT: "PAYMENT";
+    readonly PAYMENT_FAILURE_REFUND: "PAYMENT_FAILURE_REFUND";
+    readonly PAYMENT_REFUND: "PAYMENT_REFUND";
+    readonly PAYMENT_REVERSAL: "PAYMENT_REVERSAL";
+    readonly REFUND: "REFUND";
+    readonly REFUND_FAILURE: "REFUND_FAILURE";
+    readonly ADJUSTMENT: "ADJUSTMENT";
+    readonly ADVANCE: "ADVANCE";
+    readonly ADVANCE_FUNDING: "ADVANCE_FUNDING";
+    readonly PAYOUT: "PAYOUT";
+    readonly PAYOUT_CANCEL: "PAYOUT_CANCEL";
+    readonly PAYOUT_FAILURE: "PAYOUT_FAILURE";
+    readonly PAYOUT_MINIMUM_BALANCE_HOLD: "PAYOUT_MINIMUM_BALANCE_HOLD";
+    readonly PAYOUT_MINIMUM_BALANCE_RELEASE: "PAYOUT_MINIMUM_BALANCE_RELEASE";
+    readonly RESERVED_FUNDS: "RESERVED_FUNDS";
+    readonly RESERVE_HOLD: "RESERVE_HOLD";
+    readonly RESERVE_RELEASE: "RESERVE_RELEASE";
+    readonly RECOVERY_FROM_FUTURE_FUNDS: "RECOVERY_FROM_FUTURE_FUNDS";
+    readonly XPAY_FEE: "XPAY_FEE";
+    readonly XPAY_FX_FEE: "XPAY_FX_FEE";
+    readonly TAX_FEE: "TAX_FEE";
+    readonly TOPUP: "TOPUP";
+    readonly TOPUP_REVERSAL: "TOPUP_REVERSAL";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * The PayoutBatch this balance transaction was included in, or null until it's batched.
+ * @nullable
+ */
+type BalanceTransactionResponseDtoPayoutBatch = BalanceTransactionPayoutBatchDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * A Balance Transaction records every movement of money in or out of your xpay balance: successful charges, refunds, payouts, processing fees, and adjustments. Each Balance Transaction links back to its `source` (the Charge, Refund, or Payout that produced it) and breaks down `gross`, `fee`, and `net` amounts. Use Balance Transactions to reconcile what was paid into your account against what was settled to your bank.
+ */
+interface BalanceTransactionResponseDto {
+    /** Balance transaction ID */
+    id: string;
+    /** Object type */
+    object: string;
+    /** Gross amount (positive for money in, negative for money out) in smallest currency unit */
+    amount: number;
+    /**
+     * Timestamp when funds become available in balance (ISO 8601)
+     * @nullable
+     */
+    availableOn?: string | null;
+    /** Created timestamp (ISO 8601) */
+    createdAt: string;
+    /** Currency */
+    currency: BalanceTransactionResponseDtoCurrency;
+    /**
+     * Human-readable description
+     * @nullable
+     */
+    description?: string | null;
+    /** Total fees in smallest currency unit */
+    fee: number;
+    /** Net amount after fees in smallest currency unit */
+    net: number;
+    /** Breakdown of the `fee`. Platform COGS entries (PROCESSOR_COST) are stripped before emission — merchants only see the fees they care about. */
+    feeDetails: BalanceTransactionFeeDetailDto[];
+    /** Transaction status */
+    status: BalanceTransactionResponseDtoStatus;
+    /** Transaction type */
+    type: BalanceTransactionResponseDtoType;
+    /** Reporting category for accounting/analytics. Falls back to `type` when the entity has no explicit override. */
+    reportingCategory: string;
+    /**
+     * Exchange rate when currency conversion occurred
+     * @nullable
+     */
+    exchangeRate?: number | null;
+    /** Source resource id (charge, refund, payout, topup, dispute). Scalar id only — merchants query the source explicitly. */
+    source: string;
+    /**
+     * The PayoutBatch this balance transaction was included in, or null until it's batched.
+     * @nullable
+     */
+    payoutBatch: BalanceTransactionResponseDtoPayoutBatch;
+    /**
+     * Associated payment intent ID (if applicable)
+     * @nullable
+     */
+    paymentIntentId?: string | null;
+    /** Merchant ID owning this balance transaction */
+    merchantId: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type BankTransferDestinationDetailsDtoReferenceStatus = typeof BankTransferDestinationDetailsDtoReferenceStatus[keyof typeof BankTransferDestinationDetailsDtoReferenceStatus];
+declare const BankTransferDestinationDetailsDtoReferenceStatus: {
+    readonly pending: "pending";
+    readonly available: "available";
+    readonly unavailable: "unavailable";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface BankTransferDestinationDetailsDto {
+    reference?: string;
+    referenceStatus?: BankTransferDestinationDetailsDtoReferenceStatus;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface BillingDetailsDto {
+    address: AddressDto;
+    email: string;
+    name: string;
+    phone: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface BillingDetailsResponseDto {
+    /** Cardholder name (name on card) */
+    name?: string;
+    /** Billing email */
+    email?: string;
+    /** Billing phone */
+    phone?: string;
+    /** Billing address */
+    address?: AddressResponseDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Dark mode preference
+ */
+type BrandingSettingsResponseDtoColorMode = typeof BrandingSettingsResponseDtoColorMode[keyof typeof BrandingSettingsResponseDtoColorMode];
+declare const BrandingSettingsResponseDtoColorMode: {
+    readonly light: "light";
+    readonly dark: "dark";
+    readonly system: "system";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Border style for inputs, buttons, cards
+ */
+type BrandingSettingsResponseDtoBorderStyle = typeof BrandingSettingsResponseDtoBorderStyle[keyof typeof BrandingSettingsResponseDtoBorderStyle];
+declare const BrandingSettingsResponseDtoBorderStyle: {
+    readonly rounded: "rounded";
+    readonly sharp: "sharp";
+    readonly pill: "pill";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Spacing density
+ */
+type BrandingSettingsResponseDtoSpacing = typeof BrandingSettingsResponseDtoSpacing[keyof typeof BrandingSettingsResponseDtoSpacing];
+declare const BrandingSettingsResponseDtoSpacing: {
+    readonly condensed: "condensed";
+    readonly normal: "normal";
+    readonly spacious: "spacious";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Input field size
+ */
+type BrandingSettingsResponseDtoInputSize = typeof BrandingSettingsResponseDtoInputSize[keyof typeof BrandingSettingsResponseDtoInputSize];
+declare const BrandingSettingsResponseDtoInputSize: {
+    readonly small: "small";
+    readonly medium: "medium";
+    readonly large: "large";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Input field style
+ */
+type BrandingSettingsResponseDtoInputStyle = typeof BrandingSettingsResponseDtoInputStyle[keyof typeof BrandingSettingsResponseDtoInputStyle];
+declare const BrandingSettingsResponseDtoInputStyle: {
+    readonly flat: "flat";
+    readonly outlined: "outlined";
+    readonly filled: "filled";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Form layout density
+ */
+type BrandingSettingsResponseDtoFormLayout = typeof BrandingSettingsResponseDtoFormLayout[keyof typeof BrandingSettingsResponseDtoFormLayout];
+declare const BrandingSettingsResponseDtoFormLayout: {
+    readonly compact: "compact";
+    readonly spacious: "spacious";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface ColorCustomizationResponseDto {
+    /** Primary brand color (buttons, links, accents). Hex only, e.g. `#635bff`. */
+    primary?: string;
+    /** Primary foreground (text on primary background). Hex only. */
+    primaryForeground?: string;
+    /** Page background color. Hex only. */
+    background?: string;
+    /** Main text color. Hex only. */
+    foreground?: string;
+    /** Border color. Hex only. */
+    border?: string;
+    /** Input, button, and dropdown border color. Hex only. */
+    input?: string;
+    /** Focus ring color. Hex only. */
+    ring?: string;
+    /** Muted/secondary background. Hex only. */
+    muted?: string;
+    /** Muted text color. Hex only. */
+    mutedForeground?: string;
+    /** Accent background. Hex only. */
+    accent?: string;
+    /** Accent text color. Hex only. */
+    accentForeground?: string;
+    /** Destructive/error color. Hex only. */
+    destructive?: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface BrandingSettingsResponseDto {
+    /** Dark mode preference */
+    colorMode?: BrandingSettingsResponseDtoColorMode;
+    /** Border style for inputs, buttons, cards */
+    borderStyle?: BrandingSettingsResponseDtoBorderStyle;
+    /** Spacing density */
+    spacing?: BrandingSettingsResponseDtoSpacing;
+    /** Input field size */
+    inputSize?: BrandingSettingsResponseDtoInputSize;
+    /** Input field style */
+    inputStyle?: BrandingSettingsResponseDtoInputStyle;
+    /** Form layout density */
+    formLayout?: BrandingSettingsResponseDtoFormLayout;
+    /** Color customization options */
+    colors?: ColorCustomizationResponseDto;
+    /** Font family override */
+    fontFamily?: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type CardDestinationDetailsDtoReferenceStatus = typeof CardDestinationDetailsDtoReferenceStatus[keyof typeof CardDestinationDetailsDtoReferenceStatus];
+declare const CardDestinationDetailsDtoReferenceStatus: {
+    readonly pending: "pending";
+    readonly available: "available";
+    readonly unavailable: "unavailable";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type CardDestinationDetailsDtoType = typeof CardDestinationDetailsDtoType[keyof typeof CardDestinationDetailsDtoType];
+declare const CardDestinationDetailsDtoType: {
+    readonly pending: "pending";
+    readonly refund: "refund";
+    readonly reversal: "reversal";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface CardDestinationDetailsDto {
+    /** Acquirer reference number (ARN) */
+    reference?: string;
+    referenceStatus?: CardDestinationDetailsDtoReferenceStatus;
+    referenceType?: string;
+    type?: CardDestinationDetailsDtoType;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface CardInfoResponseDto {
+    /** Card brand (e.g., Visa, Mastercard) */
+    brand: string;
+    /** Whether this is an on-us transaction (same bank) */
+    isOnUs: boolean;
+    /** Whether this is an international card */
+    isInternational: boolean;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface ThreeDSecureDto {
+    authenticationFlow: string;
+    electronicCommerceIndicator: string;
+    exemptionIndicator: string;
+    result: string;
+    resultReason: string;
+    transactionId: string;
+    version: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface WalletDto {
+    type: string;
+    dynamicLast4: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface ChargeCardDetailsDto {
+    brand: string;
+    country: string;
+    expMonth: number;
+    expYear: number;
+    funding: string;
+    last4: string;
+    network: string;
+    /** Card fingerprint for identifying the same card across customers */
+    fingerprint: string;
+    threeDSecure: ThreeDSecureDto;
+    wallet: WalletDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface ChargeConfigDto {
+    vatCollectionEnabled: boolean;
+    vatCollectionRate: number;
+    collectedVatAmount: number;
+    platformFeePassThrough: boolean;
+    merchantFeeDeduction: number;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface ChargeGeocodingLocationDto {
+    /** ISO 3166-1 alpha-2 country code */
+    countryCode?: string;
+    /** English country name */
+    countryName?: string;
+    /** ISO 3166-2 region code */
+    regionCode?: string;
+    /** English region/state name */
+    regionName?: string;
+    /** English city name */
+    cityName?: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface ChargeGeocodingDto {
+    /** The IP address that was resolved */
+    ipAddress: string;
+    location?: ChargeGeocodingLocationDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type ChargeResponseDtoCurrency = typeof ChargeResponseDtoCurrency[keyof typeof ChargeResponseDtoCurrency];
+declare const ChargeResponseDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * @nullable
+ */
+type PaymentMethodDetailsDtoCard = ChargeCardDetailsDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface ValuDetailsDto {
+    /**
+     * Loan number from the provider
+     * @nullable
+     */
+    loanNumber?: string | null;
+    /**
+     * Loan tenure in months
+     * @nullable
+     */
+    tenure?: number | null;
+    /**
+     * Monthly installment amount
+     * @nullable
+     */
+    emi?: string | null;
+    /**
+     * Down payment amount
+     * @nullable
+     */
+    downPayment?: string | null;
+    /**
+     * Total financed amount
+     * @nullable
+     */
+    financedAmount?: string | null;
+    /**
+     * First EMI due date
+     * @nullable
+     */
+    firstEmiDueDate?: string | null;
+    /**
+     * Last installment date
+     * @nullable
+     */
+    lastInstallmentDate?: string | null;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * ValU details (if type is 'valu')
+ * @nullable
+ */
+type PaymentMethodDetailsDtoValu = ValuDetailsDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface PaymentMethodDetailsDto {
+    /** Concrete PaymentMethodType value: 'card', 'valu', etc. */
+    type: string;
+    /** @nullable */
+    card?: PaymentMethodDetailsDtoCard;
+    /**
+     * ValU details (if type is 'valu')
+     * @nullable
+     */
+    valu?: PaymentMethodDetailsDtoValu;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface OutcomeDto {
+    networkStatus: string;
+    reason: string;
+    riskLevel: string;
+    riskScore: number;
+    sellerMessage: string;
+    type: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * @nullable
+ */
+type ChargeResponseDtoBalanceTransaction = BalanceTransactionResponseDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Customer's currency code (ISO 4217)
+ */
+type PresentmentDetailsDtoCurrency = typeof PresentmentDetailsDtoCurrency[keyof typeof PresentmentDetailsDtoCurrency];
+declare const PresentmentDetailsDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface PresentmentDetailsDto {
+    /** Amount in the customer's currency (smallest unit — e.g. fils for KWD, cents for USD) */
+    amount: number;
+    /** Customer's currency code (ISO 4217) */
+    currency: PresentmentDetailsDtoCurrency;
+    /** Locked exchange rate: presentment_major × rate = processing_major. Reused for refunds/disputes. Stored as numeric(15,6) — frontend can call `.toFixed(6)` to render the full 6-decimal string when needed. */
+    exchangeRate: number;
+    /** Reference to the immutable ExchangeRate record used — audit trail for FX reconciliation */
+    exchangeRateId: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Three-letter ISO currency code
+ */
+type RefundResponseDtoCurrency = typeof RefundResponseDtoCurrency[keyof typeof RefundResponseDtoCurrency];
+declare const RefundResponseDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Status of the refund (pending, requires_action, succeeded, failed, canceled)
+ */
+type RefundResponseDtoStatus = typeof RefundResponseDtoStatus[keyof typeof RefundResponseDtoStatus];
+declare const RefundResponseDtoStatus: {
+    readonly PENDING: "PENDING";
+    readonly REQUIRES_ACTION: "REQUIRES_ACTION";
+    readonly SUCCEEDED: "SUCCEEDED";
+    readonly FAILED: "FAILED";
+    readonly CANCELED: "CANCELED";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Reason for the refund
+ */
+type RefundResponseDtoReason = typeof RefundResponseDtoReason[keyof typeof RefundResponseDtoReason];
+declare const RefundResponseDtoReason: {
+    readonly DUPLICATE: "DUPLICATE";
+    readonly FRAUDULENT: "FRAUDULENT";
+    readonly REQUESTED_BY_CUSTOMER: "REQUESTED_BY_CUSTOMER";
+    readonly RISK_HOLD_CAPTURE: "RISK_HOLD_CAPTURE";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Reason for refund failure
+ */
+type RefundResponseDtoFailureReason = typeof RefundResponseDtoFailureReason[keyof typeof RefundResponseDtoFailureReason];
+declare const RefundResponseDtoFailureReason: {
+    readonly lost_or_stolen_card: "lost_or_stolen_card";
+    readonly expired_or_canceled_card: "expired_or_canceled_card";
+    readonly charge_for_pending_refund_disputed: "charge_for_pending_refund_disputed";
+    readonly insufficient_funds: "insufficient_funds";
+    readonly declined: "declined";
+    readonly merchant_request: "merchant_request";
+    readonly unknown: "unknown";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Reason for pending status
+ */
+type RefundResponseDtoPendingReason = typeof RefundResponseDtoPendingReason[keyof typeof RefundResponseDtoPendingReason];
+declare const RefundResponseDtoPendingReason: {
+    readonly processing: "processing";
+    readonly insufficient_funds: "insufficient_funds";
+    readonly charge_pending: "charge_pending";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type RefundDestinationDetailsDtoType = typeof RefundDestinationDetailsDtoType[keyof typeof RefundDestinationDetailsDtoType];
+declare const RefundDestinationDetailsDtoType: {
+    readonly card: "card";
+    readonly wallet: "wallet";
+    readonly bank_transfer: "bank_transfer";
+    readonly kiosk: "kiosk";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface WalletDestinationDetailsDto {
+    /** Wallet transaction reference */
+    reference?: string;
+    /** Wallet provider (e.g., vodafone_cash, fawry) */
+    provider?: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface KioskDestinationDetailsDto {
+    reference?: string;
+    provider?: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface RefundDestinationDetailsDto {
+    type: RefundDestinationDetailsDtoType;
+    card?: CardDestinationDetailsDto;
+    wallet?: WalletDestinationDetailsDto;
+    bankTransfer?: BankTransferDestinationDetailsDto;
+    kiosk?: KioskDestinationDetailsDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface RefundNextActionDisplayDetailsDto {
+    /** Email sent timestamp (ISO 8601) */
+    emailSentAt?: string;
+    emailSentTo?: string;
+    /** Expiration timestamp (ISO 8601) */
+    expiresAt?: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface RefundNextActionDto {
+    type: string;
+    displayDetails?: RefundNextActionDisplayDetailsDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * A Refund returns funds from a successful Charge back to the customer's original payment method. Refunds can be full or partial, and a single Charge can be refunded multiple times up to its original amount. The Refund's `status` reflects the processor's progress as the money makes its way back: `pending` while in flight, `succeeded` once the funds have been returned, or `failed` if the processor rejected the request.
+ */
+interface RefundResponseDto {
+    /** Unique identifier for the refund */
+    id: string;
+    /** Object type */
+    object: string;
+    /** Refund amount in smallest currency unit */
+    amount: number;
+    /** ID of the charge being refunded */
+    chargeId: string;
+    /** ID of the PaymentIntent being refunded */
+    paymentIntentId: string;
+    /**
+     * ID of the balance transaction for the refund, null until settled
+     * @nullable
+     */
+    balanceTransactionId: string | null;
+    /**
+     * Balance transaction for failed refund reversal, null unless the refund failed
+     * @nullable
+     */
+    failureBalanceTransactionId: string | null;
+    /**
+     * Processor-side refund id, null when not yet reconciled
+     * @nullable
+     */
+    externalRefundId: string | null;
+    /** Time at which the refund was created (ISO 8601) */
+    createdAt: string;
+    /** Three-letter ISO currency code */
+    currency: RefundResponseDtoCurrency;
+    /** Customer-facing view of the refund — amount in the original charge's presentment currency using the charge's LOCKED exchange rate. Populated only when the charge had a presentment currency different from processing. */
+    presentmentDetails?: PresentmentDetailsDto;
+    /** Status of the refund (pending, requires_action, succeeded, failed, canceled) */
+    status: RefundResponseDtoStatus;
+    /** Reason for the refund */
+    reason?: RefundResponseDtoReason;
+    /** Reason for refund failure */
+    failureReason?: RefundResponseDtoFailureReason;
+    /** Reason for pending status */
+    pendingReason?: RefundResponseDtoPendingReason;
+    /** Description for non-card refunds */
+    description?: string;
+    /** Payment method-specific refund details */
+    destinationDetails?: RefundDestinationDetailsDto;
+    /** Next action if requires_action */
+    nextAction?: RefundNextActionDto;
+    /** Email for refund instructions */
+    instructionsEmail?: string;
+    /** Receipt number for email receipts */
+    receiptNumber?: string;
+    /** Original platform fee (NOT refunded - kept by platform) */
+    feeAmount?: number;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface ChargeSessionDto {
+    browser?: string;
+    browserVersion?: string;
+    platform?: string;
+    device?: string;
+    deviceVendor?: string;
+    deviceModel?: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface ProcessorCapabilitiesDto {
+    /** Whether this processor supports refunds */
+    supportsRefund: boolean;
+    /** Whether partial refunds are supported */
+    supportsPartialRefund: boolean;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Settlement model snapshotted at charge time
+ */
+type ChargeResponseDtoSettlementModel = typeof ChargeResponseDtoSettlementModel[keyof typeof ChargeResponseDtoSettlementModel];
+declare const ChargeResponseDtoSettlementModel: {
+    readonly aggregated: "aggregated";
+    readonly direct: "direct";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * A Charge represents a single attempt to move money from a customer's payment method to your account. It records what was paid, by whom, through which processor, and the final outcome: `succeeded`, `failed`, or `refunded`. A single PaymentIntent may produce multiple Charges if earlier attempts fail; only the most recent successful Charge actually moves funds, and any subsequent Refunds reference it directly.
+ */
+interface ChargeResponseDto {
+    id: string;
+    object: string;
+    amount: number;
+    amountCaptured: number;
+    amountRefunded: number;
+    currency: ChargeResponseDtoCurrency;
+    /** Created timestamp (ISO 8601) */
+    createdAt: string;
+    status: string;
+    paid: boolean;
+    refunded: boolean;
+    captured: boolean;
+    /** Captured timestamp (ISO 8601) */
+    capturedAt: string;
+    failureCode: string;
+    failureMessage: string;
+    receiptUrl: string;
+    receiptEmail: string;
+    billingDetails: BillingDetailsDto;
+    paymentMethodDetails: PaymentMethodDetailsDto;
+    outcome: OutcomeDto;
+    /** @nullable */
+    balanceTransaction: ChargeResponseDtoBalanceTransaction;
+    /** Present when customer paid in a different currency than settlement (EGP) */
+    presentmentDetails?: PresentmentDetailsDto;
+    /** Refunds issued against this charge, ordered newest-first. */
+    refunds: RefundResponseDto[];
+    paymentIntentId: string;
+    paymentMethodId: string;
+    calculatedStatementDescriptor: string;
+    disputed: boolean;
+    externalChargeId: string;
+    config: ChargeConfigDto;
+    geocoding?: ChargeGeocodingDto;
+    session?: ChargeSessionDto;
+    processorCapabilities?: ProcessorCapabilitiesDto;
+    /**
+     * ID of the currently-active risk hold on this charge, if any
+     * @nullable
+     */
+    activeHoldId?: string | null;
+    /** Settlement model snapshotted at charge time */
+    settlementModel: ChargeResponseDtoSettlementModel;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Customer type. `registered` is a permanent merchant-managed record; `guest` is a session-scope dedup unit created automatically when `customerCreation` is `if_required`.
+ */
+type CheckoutSessionCustomerDtoType = typeof CheckoutSessionCustomerDtoType[keyof typeof CheckoutSessionCustomerDtoType];
+declare const CheckoutSessionCustomerDtoType: {
+    readonly guest: "guest";
+    readonly registered: "registered";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface ShippingResponseDto {
+    /** Recipient name */
+    name?: string;
+    /** Recipient phone */
+    phone?: string;
+    /** Shipping address */
+    address?: AddressResponseDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Customer metadata
+ */
+type CheckoutSessionCustomerDtoMetadata = {
+    [key: string]: unknown;
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface CheckoutSessionCustomerDto {
+    /** Customer ID */
+    id: string;
+    /** Customer type. `registered` is a permanent merchant-managed record; `guest` is a session-scope dedup unit created automatically when `customerCreation` is `if_required`. */
+    type: CheckoutSessionCustomerDtoType;
+    /** Customer name */
+    name?: string;
+    /** Customer email */
+    email?: string;
+    /** Customer phone */
+    phone?: string;
+    /** Customer address */
+    address?: AddressResponseDto;
+    /** Customer shipping details */
+    shipping?: ShippingResponseDto;
+    /** Customer metadata */
+    metadata?: CheckoutSessionCustomerDtoMetadata;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Session mode
+ */
+type CheckoutSessionResponseDtoMode = typeof CheckoutSessionResponseDtoMode[keyof typeof CheckoutSessionResponseDtoMode];
+declare const CheckoutSessionResponseDtoMode: {
+    readonly payment: "payment";
+    readonly setup: "setup";
+    readonly subscription: "subscription";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * UI mode
+ */
+type CheckoutSessionResponseDtoUiMode = typeof CheckoutSessionResponseDtoUiMode[keyof typeof CheckoutSessionResponseDtoUiMode];
+declare const CheckoutSessionResponseDtoUiMode: {
+    readonly hosted: "hosted";
+    readonly embedded: "embedded";
+    readonly custom: "custom";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Submit type
+ */
+type CheckoutSessionResponseDtoSubmitType = typeof CheckoutSessionResponseDtoSubmitType[keyof typeof CheckoutSessionResponseDtoSubmitType];
+declare const CheckoutSessionResponseDtoSubmitType: {
+    readonly PAY: "PAY";
+    readonly SUBSCRIBE: "SUBSCRIBE";
+    readonly BOOK: "BOOK";
+    readonly DONATE: "DONATE";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Customer creation mode
+ */
+type CheckoutSessionResponseDtoCustomerCreation = typeof CheckoutSessionResponseDtoCustomerCreation[keyof typeof CheckoutSessionResponseDtoCustomerCreation];
+declare const CheckoutSessionResponseDtoCustomerCreation: {
+    readonly always: "always";
+    readonly if_required: "if_required";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Session status
+ */
+type CheckoutSessionResponseDtoStatus = typeof CheckoutSessionResponseDtoStatus[keyof typeof CheckoutSessionResponseDtoStatus];
+declare const CheckoutSessionResponseDtoStatus: {
+    readonly open: "open";
+    readonly complete: "complete";
+    readonly expired: "expired";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Payment status
+ */
+type CheckoutSessionResponseDtoPaymentStatus = typeof CheckoutSessionResponseDtoPaymentStatus[keyof typeof CheckoutSessionResponseDtoPaymentStatus];
+declare const CheckoutSessionResponseDtoPaymentStatus: {
+    readonly paid: "paid";
+    readonly unpaid: "unpaid";
+    readonly no_payment_required: "no_payment_required";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Currency code (ISO 4217)
+ */
+type CheckoutSessionResponseDtoCurrency = typeof CheckoutSessionResponseDtoCurrency[keyof typeof CheckoutSessionResponseDtoCurrency];
+declare const CheckoutSessionResponseDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface TotalDetailsResponseDto {
+    /** Discount amount */
+    amountDiscount: number;
+    /** Shipping amount */
+    amountShipping?: number;
+    /** Tax amount */
+    amountTax: number;
+    /** Platform fee amount (only when feesPassThrough is enabled) */
+    amountPlatformFee?: number;
+    /** Collected VAT amount (only when vatCollectionEnabled is enabled) */
+    amountCollectedVat?: number;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Customer's currency code (ISO 4217)
+ */
+type SessionPresentmentDetailsDtoCurrency = typeof SessionPresentmentDetailsDtoCurrency[keyof typeof SessionPresentmentDetailsDtoCurrency];
+declare const SessionPresentmentDetailsDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface SessionPresentmentDetailsDto {
+    /** Amount in the customer's currency (smallest unit — e.g. fils for KWD, cents for USD) */
+    amount: number;
+    /** Customer's currency code (ISO 4217) */
+    currency: SessionPresentmentDetailsDtoCurrency;
+    /** Locked exchange rate: presentment_major × rate = processing_major. Reused for refunds/disputes. Stored as numeric(15,6) — frontend can call `.toFixed(6)` to render the full 6-decimal string when needed. */
+    exchangeRate: number;
+    /** Reference to the immutable ExchangeRate record used — audit trail for FX reconciliation */
+    exchangeRateId: string;
+    /** Subtotal before discounts/fees, in presentment smallest unit */
+    amountSubtotal: number;
+    /** Final total the customer sees, in presentment smallest unit */
+    amountTotal: number;
+    /** Discount applied, in presentment smallest unit (0 when no discount) */
+    amountDiscount: number;
+    /** Collected VAT in presentment smallest unit (only when VAT collection is enabled) */
+    amountCollectedVat?: number;
+    /** Platform fee in presentment smallest unit (only when feesPassThrough is enabled) */
+    amountPlatformFee?: number;
+    /** Tax in presentment smallest unit (only when tax is charged) */
+    amountTax?: number;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * What happens after payment: redirect to merchant URL or show hosted confirmation page
+ */
+type CheckoutSessionResponseDtoAfterCompletion = {
+    [key: string]: unknown;
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface CustomerDetailsResponseDto {
+    /** Customer name */
+    name?: string;
+    /** Customer email */
+    email?: string;
+    /** Customer phone */
+    phone?: string;
+    /** Billing details including cardholder name and address */
+    billingDetails?: BillingDetailsResponseDto;
+    /** Shipping details */
+    shipping?: ShippingResponseDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * ISO 4217 currency code this payment is denominated in.
+ */
+type NestedPaymentIntentResponseDtoCurrency = typeof NestedPaymentIntentResponseDtoCurrency[keyof typeof NestedPaymentIntentResponseDtoCurrency];
+declare const NestedPaymentIntentResponseDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Lifecycle status. Combines the raw processor state with refund state, so values like `REFUNDED`, `PARTIALLY_REFUNDED`, `UNCAPTURED`, and `FAILED` may appear in addition to the base processor states.
+ */
+type NestedPaymentIntentResponseDtoStatus = typeof NestedPaymentIntentResponseDtoStatus[keyof typeof NestedPaymentIntentResponseDtoStatus];
+declare const NestedPaymentIntentResponseDtoStatus: {
+    readonly REQUIRES_PAYMENT_METHOD: "REQUIRES_PAYMENT_METHOD";
+    readonly REQUIRES_CONFIRMATION: "REQUIRES_CONFIRMATION";
+    readonly REQUIRES_ACTION: "REQUIRES_ACTION";
+    readonly PROCESSING: "PROCESSING";
+    readonly UNCAPTURED: "UNCAPTURED";
+    readonly CANCELED: "CANCELED";
+    readonly SUCCEEDED: "SUCCEEDED";
+    readonly FAILED: "FAILED";
+    readonly REFUNDED: "REFUNDED";
+    readonly PARTIALLY_REFUNDED: "PARTIALLY_REFUNDED";
+    readonly AMOUNT_CAPTURABLE_UPDATED: "AMOUNT_CAPTURABLE_UPDATED";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * When to capture funds from the customer. `automatic` (default) captures immediately on successful confirmation. `manual` only authorizes — call the capture endpoint later (within 7 days) to actually move the money.
+ */
+type NestedPaymentIntentResponseDtoCaptureMethod = typeof NestedPaymentIntentResponseDtoCaptureMethod[keyof typeof NestedPaymentIntentResponseDtoCaptureMethod];
+declare const NestedPaymentIntentResponseDtoCaptureMethod: {
+    readonly automatic: "automatic";
+    readonly manual: "manual";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * How the PaymentIntent moves out of `REQUIRES_CONFIRMATION`. `automatic` (default) confirms as soon as a payment method is attached. `manual` requires you to call confirm explicitly.
+ */
+type NestedPaymentIntentResponseDtoConfirmationMethod = typeof NestedPaymentIntentResponseDtoConfirmationMethod[keyof typeof NestedPaymentIntentResponseDtoConfirmationMethod];
+declare const NestedPaymentIntentResponseDtoConfirmationMethod: {
+    readonly automatic: "automatic";
+    readonly manual: "manual";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface ShippingDto {
+    /** Shipping address. */
+    address: AddressDto;
+    /**
+     * Recipient name as provided by the customer.
+     * @nullable
+     */
+    name?: string | null;
+    /**
+     * Recipient phone number as provided by the customer.
+     * @nullable
+     */
+    phone?: string | null;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * Shipping address and recipient details for this payment. `null` if no shipping was collected.
+ * @nullable
+ */
+type NestedPaymentIntentResponseDtoShipping = ShippingDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * Breakdown of `amount` into product amount, tax, platform fees, tip, and discount. `null` for legacy payments without itemized breakdown.
+ * @nullable
+ */
+type NestedPaymentIntentResponseDtoAmountDetails = AmountDetailsDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * Mirror of `amount` / `currency` in the currency the customer actually saw at checkout, when different from the settlement currency. `null` when customer paid in the same currency.
+ * @nullable
+ */
+type NestedPaymentIntentResponseDtoPresentmentDetails = PresentmentDetailsDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * The most recent Charge attempt for this PaymentIntent. `null` if no Charge has been attempted yet.
+ * @nullable
+ */
+type NestedPaymentIntentResponseDtoLatestCharge = ChargeResponseDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type PaymentMethodCardDtoNetworks = {
+    [key: string]: unknown;
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface ThreeDSecureUsageDto {
+    supported: boolean;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface PaymentMethodCardDto {
+    brand: string;
+    country: string;
+    displayBrand: string;
+    expMonth: number;
+    expYear: number;
+    fingerprint: string;
+    funding: string;
+    last4: string;
+    networks: PaymentMethodCardDtoNetworks;
+    regulatedStatus: string;
+    threeDSecureUsage: ThreeDSecureUsageDto;
+    wallet: WalletDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * @nullable
+ */
+type PaymentMethodObjectDtoCard = PaymentMethodCardDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * ValU details (if type is 'valu')
+ * @nullable
+ */
+type PaymentMethodObjectDtoValu = ValuDetailsDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+type PaymentMethodObjectDtoType = typeof PaymentMethodObjectDtoType[keyof typeof PaymentMethodObjectDtoType];
+declare const PaymentMethodObjectDtoType: {
+    readonly card: "card";
+    readonly fawry: "fawry";
+    readonly aman: "aman";
+    readonly valu: "valu";
+    readonly sympl: "sympl";
+    readonly tabby: "tabby";
+    readonly tamara: "tamara";
+    readonly vodafone_cash: "vodafone_cash";
+    readonly etisalat_cash: "etisalat_cash";
+    readonly orange_cash: "orange_cash";
+    readonly we_pay: "we_pay";
+    readonly apple_pay: "apple_pay";
+    readonly google_pay: "google_pay";
+    readonly samsung_pay: "samsung_pay";
+    readonly instapay: "instapay";
+    readonly bank_transfer: "bank_transfer";
+    readonly cash_on_delivery: "cash_on_delivery";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface PaymentMethodObjectDto {
+    id: string;
+    object: string;
+    /** @nullable */
+    card: PaymentMethodObjectDtoCard;
+    /**
+     * ValU details (if type is 'valu')
+     * @nullable
+     */
+    valu?: PaymentMethodObjectDtoValu;
+    billingDetails: BillingDetailsDto;
+    type: PaymentMethodObjectDtoType;
+    /** Created timestamp (ISO 8601) */
+    createdAt: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * Payment method attached to this PaymentIntent. `null` before a method is attached or after a failure clears it.
+ * @nullable
+ */
+type NestedPaymentIntentResponseDtoPaymentMethod = PaymentMethodObjectDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface CustomerDto {
+    /** ID of the Customer associated with this payment. */
+    id: string;
+    /**
+     * Customer's name as captured for this payment. Prefers the billing-details snapshot from the latest charge (immutable) over the Customer entity's current name.
+     * @nullable
+     */
+    name?: string | null;
+    /**
+     * Customer's email captured for this payment. Falls back to the Customer entity's email if no billing-details email was provided.
+     * @nullable
+     */
+    email?: string | null;
+    /**
+     * Customer's phone captured for this payment, in E.164 format when available.
+     * @nullable
+     */
+    phone?: string | null;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * The Customer this payment belongs to. `null` if no Customer is associated.
+ * @nullable
+ */
+type NestedPaymentIntentResponseDtoCustomer = CustomerDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface NextActionRedirectDto {
+    /** URL to redirect the customer to in order to complete the next step (typically 3-D Secure). */
+    url: string;
+    /**
+     * URL the customer is sent back to after completing the redirect step. `null` if no return URL was configured.
+     * @nullable
+     */
+    returnUrl?: string | null;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * Redirect details when `type` is `redirect_to_url`. `null` for any other action type.
+ * @nullable
+ */
+type NextActionDetailDtoRedirectToUrl = NextActionRedirectDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface NextActionDetailDto {
+    /** Kind of action the customer must take next. Today the only value is `redirect_to_url`; future payment methods may add new types. */
+    type: string;
+    /**
+     * Redirect details when `type` is `redirect_to_url`. `null` for any other action type.
+     * @nullable
+     */
+    redirectToUrl?: NextActionDetailDtoRedirectToUrl;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * Action the customer must take to advance the payment (e.g. complete 3-D Secure). `null` when no further action is needed.
+ * @nullable
+ */
+type NestedPaymentIntentResponseDtoNextAction = NextActionDetailDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Custom key/value pairs you attached when creating or updating the PaymentIntent. Useful for reconciling with your own systems. Empty object if none.
+ */
+type NestedPaymentIntentResponseDtoMetadata = {
+    [key: string]: unknown;
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Advice on whether and how to retry. One of `confirm_card_data`, `do_not_try_again`, `try_again_later`. `null` if no specific advice applies.
+ * @nullable
+ */
+type LastPaymentErrorDetailDtoAdviceCode = typeof LastPaymentErrorDetailDtoAdviceCode[keyof typeof LastPaymentErrorDetailDtoAdviceCode] | null;
+declare const LastPaymentErrorDetailDtoAdviceCode: {
+    readonly confirm_card_data: "confirm_card_data";
+    readonly do_not_try_again: "do_not_try_again";
+    readonly try_again_later: "try_again_later";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Snapshot of the payment method as it existed at the time of failure (brand, last 4, billing details, etc.). `null` if no payment method was attached when the error occurred.
+ * @nullable
+ */
+type LastPaymentErrorDetailDtoPaymentMethod = {
+    [key: string]: unknown;
+} | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Error category. One of `card_error`, `payment_method_error`, `api_error`, `invalid_request_error`. Use this for high-level branching in your error handling.
+ */
+type LastPaymentErrorDetailDtoType = typeof LastPaymentErrorDetailDtoType[keyof typeof LastPaymentErrorDetailDtoType];
+declare const LastPaymentErrorDetailDtoType: {
+    readonly card_error: "card_error";
+    readonly payment_method_error: "payment_method_error";
+    readonly api_error: "api_error";
+    readonly invalid_request_error: "invalid_request_error";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface LastPaymentErrorDetailDto {
+    /**
+     * Short machine-readable error code describing what failed (e.g. `card_declined`, `expired_card`, `incorrect_cvc`). `null` if no code applies.
+     * @nullable
+     */
+    code?: string | null;
+    /**
+     * More specific reason for a decline (e.g. `insufficient_funds`, `generic_decline`). Present when `code` is `card_declined`; otherwise `null`.
+     * @nullable
+     */
+    declineCode?: string | null;
+    /**
+     * Decline code returned by the card network itself, when different from `declineCode`. `null` if the network did not provide one.
+     * @nullable
+     */
+    networkDeclineCode?: string | null;
+    /**
+     * Link to documentation explaining this error and how to recover from it.
+     * @nullable
+     */
+    docUrl?: string | null;
+    /** Customer-safe message describing what went wrong. Safe to display in your UI. */
+    message: string;
+    /**
+     * Internal message for the merchant with more detail than `message`. Do NOT show this to customers. `null` if no merchant-only context is available.
+     * @nullable
+     */
+    merchantMessage?: string | null;
+    /**
+     * Advice on whether and how to retry. One of `confirm_card_data`, `do_not_try_again`, `try_again_later`. `null` if no specific advice applies.
+     * @nullable
+     */
+    adviceCode?: LastPaymentErrorDetailDtoAdviceCode;
+    /**
+     * Name of the request parameter that caused the error (e.g. `amount`, `payment_method`). `null` when the failure isn't tied to a specific parameter.
+     * @nullable
+     */
+    param?: string | null;
+    /**
+     * ID of the failed Charge that triggered this error. `null` if no charge was created.
+     * @nullable
+     */
+    chargeId?: string | null;
+    /**
+     * Snapshot of the payment method as it existed at the time of failure (brand, last 4, billing details, etc.). `null` if no payment method was attached when the error occurred.
+     * @nullable
+     */
+    paymentMethod?: LastPaymentErrorDetailDtoPaymentMethod;
+    /**
+     * Type of the payment method that failed (e.g. `card`, `valu`, `fawry`). `null` if unknown.
+     * @nullable
+     */
+    paymentMethodType?: string | null;
+    /** Error category. One of `card_error`, `payment_method_error`, `api_error`, `invalid_request_error`. Use this for high-level branching in your error handling. */
+    type: LastPaymentErrorDetailDtoType;
+    /**
+     * Raw error code returned by the upstream processor, unmapped. Useful for support tickets and processor-specific debugging. Most applications should rely on `code` and `declineCode` instead.
+     * @nullable
+     */
+    processorCode?: string | null;
+    /**
+     * Raw error message returned by the upstream processor, unmapped. Useful for support tickets and processor-specific debugging. Most applications should rely on `message` instead.
+     * @nullable
+     */
+    processorMessage?: string | null;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * Details of the most recent failed payment attempt for this PaymentIntent. `null` if no attempts have failed.
+ * @nullable
+ */
+type NestedPaymentIntentResponseDtoLastPaymentError = LastPaymentErrorDetailDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * A PaymentIntent embedded inside a CheckoutSession. Same fields as PaymentIntent, but without the `checkoutSession` back-reference (you are already reading this from the enclosing CheckoutSession).
+ */
+interface NestedPaymentIntentResponseDto {
+    /** Unique identifier for this PaymentIntent. Always prefixed with `pi_`. */
+    id: string;
+    /** String identifying the object type. Always `payment_intent` for this resource. */
+    object: string;
+    /**
+     * ID of the CheckoutSession that created this PaymentIntent. `null` for PaymentIntents created directly via the API without a session.
+     * @nullable
+     */
+    checkoutSessionId?: string | null;
+    /** Amount the customer is being charged, in the smallest currency unit of `currency` (e.g. piasters for EGP — `10000` = 100 EGP). */
+    amount: number;
+    /** Amount that can still be captured for this PaymentIntent, in the smallest currency unit. Non-zero only when `captureMethod` is `manual` and the payment has been authorized but not yet captured. Drops to `0` once captured (fully or partially). */
+    amountCapturable: number;
+    /** Amount actually received from the customer so far, in the smallest currency unit. Equals `amount` after a successful capture; `0` for payments that haven't reached SUCCEEDED. */
+    amountReceived: number;
+    /** ISO 4217 currency code this payment is denominated in. */
+    currency: NestedPaymentIntentResponseDtoCurrency;
+    /** Lifecycle status. Combines the raw processor state with refund state, so values like `REFUNDED`, `PARTIALLY_REFUNDED`, `UNCAPTURED`, and `FAILED` may appear in addition to the base processor states. */
+    status: NestedPaymentIntentResponseDtoStatus;
+    /** Created timestamp (ISO 8601) */
+    createdAt: string;
+    /** Updated timestamp (ISO 8601) */
+    updatedAt: string;
+    /** Secret used by the SDK to confirm the payment from the customer's browser. Do NOT log this or share it with any party other than the customer. Each PaymentIntent has one client secret for its lifetime. */
+    clientSecret: string;
+    /** When to capture funds from the customer. `automatic` (default) captures immediately on successful confirmation. `manual` only authorizes — call the capture endpoint later (within 7 days) to actually move the money. */
+    captureMethod: NestedPaymentIntentResponseDtoCaptureMethod;
+    /** How the PaymentIntent moves out of `REQUIRES_CONFIRMATION`. `automatic` (default) confirms as soon as a payment method is attached. `manual` requires you to call confirm explicitly. */
+    confirmationMethod: NestedPaymentIntentResponseDtoConfirmationMethod;
+    /**
+     * Arbitrary description you can attach when creating the PaymentIntent. Shown in the dashboard and useful for reconciling with your own systems. `null` if not provided.
+     * @nullable
+     */
+    description?: string | null;
+    /**
+     * Email to send the receipt to once the payment succeeds. `null` if no receipt email was set.
+     * @nullable
+     */
+    receiptEmail?: string | null;
+    /**
+     * ISO 8601 timestamp of when this PaymentIntent was canceled. `null` if it was never canceled.
+     * @nullable
+     */
+    canceledAt?: string | null;
+    /**
+     * Shipping address and recipient details for this payment. `null` if no shipping was collected.
+     * @nullable
+     */
+    shipping?: NestedPaymentIntentResponseDtoShipping;
+    /**
+     * Breakdown of `amount` into product amount, tax, platform fees, tip, and discount. `null` for legacy payments without itemized breakdown.
+     * @nullable
+     */
+    amountDetails?: NestedPaymentIntentResponseDtoAmountDetails;
+    /**
+     * Mirror of `amount` / `currency` in the currency the customer actually saw at checkout, when different from the settlement currency. `null` when customer paid in the same currency.
+     * @nullable
+     */
+    presentmentDetails?: NestedPaymentIntentResponseDtoPresentmentDetails;
+    /**
+     * The most recent Charge attempt for this PaymentIntent. `null` if no Charge has been attempted yet.
+     * @nullable
+     */
+    latestCharge?: NestedPaymentIntentResponseDtoLatestCharge;
+    /** All Charge attempts for this PaymentIntent, sorted by creation time ascending (oldest first). Each retry adds a new Charge. Empty array if no attempts have been made yet. */
+    charges: ChargeResponseDto[];
+    /**
+     * Payment method attached to this PaymentIntent. `null` before a method is attached or after a failure clears it.
+     * @nullable
+     */
+    paymentMethod?: NestedPaymentIntentResponseDtoPaymentMethod;
+    /**
+     * The Customer this payment belongs to. `null` if no Customer is associated.
+     * @nullable
+     */
+    customer?: NestedPaymentIntentResponseDtoCustomer;
+    /**
+     * Action the customer must take to advance the payment (e.g. complete 3-D Secure). `null` when no further action is needed.
+     * @nullable
+     */
+    nextAction?: NestedPaymentIntentResponseDtoNextAction;
+    /** Custom key/value pairs you attached when creating or updating the PaymentIntent. Useful for reconciling with your own systems. Empty object if none. */
+    metadata: NestedPaymentIntentResponseDtoMetadata;
+    /**
+     * Details of the most recent failed payment attempt for this PaymentIntent. `null` if no attempts have failed.
+     * @nullable
+     */
+    lastPaymentError?: NestedPaymentIntentResponseDtoLastPaymentError;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * The PaymentIntent for this session, or `null` if no payment has been started yet. The PaymentIntent's own `checkoutSession` field is not included here to keep the response self-contained.
+ * @nullable
+ */
+type CheckoutSessionResponseDtoPaymentIntent = NestedPaymentIntentResponseDto | null;
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Currency
+ */
+type PriceDtoCurrency = typeof PriceDtoCurrency[keyof typeof PriceDtoCurrency];
+declare const PriceDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Price type
+ */
+type PriceDtoType = typeof PriceDtoType[keyof typeof PriceDtoType];
+declare const PriceDtoType: {
+    readonly ONE_TIME: "ONE_TIME";
+    readonly RECURRING: "RECURRING";
+    readonly CUSTOM: "CUSTOM";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Billing interval
+ */
+type RecurringDtoInterval = typeof RecurringDtoInterval[keyof typeof RecurringDtoInterval];
+declare const RecurringDtoInterval: {
+    readonly DAY: "DAY";
+    readonly WEEK: "WEEK";
+    readonly MONTH: "MONTH";
+    readonly YEAR: "YEAR";
+    readonly CUSTOM: "CUSTOM";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface RecurringDto {
+    /** Billing interval */
+    interval?: RecurringDtoInterval;
+    /** Number of intervals between billings */
+    intervalCount?: number;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface CustomUnitAmountDto {
+    /** Minimum amount the customer may enter */
+    minimum?: number;
+    /** Maximum amount the customer may enter */
+    maximum?: number;
+    /** Suggested amount pre-filled at checkout */
+    preset?: number;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface ProductDto {
+    /** Product ID */
+    id: string;
+    /** Product name */
+    name: string;
+    /** Product description */
+    description?: string;
+    /** Product image URL */
+    image?: string;
+    /** Whether the product is active. `false` means the merchant archived it — archiving a product cascades `active: false` to all of its catalog prices, so an archived product's prices will also surface `active: false`. Consumers should treat any line item with `price.product.active === false` as unavailable. */
+    active: boolean;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface PriceDto {
+    /** Price ID */
+    id: string;
+    /** Price amount in smallest currency unit */
+    unitAmount?: number;
+    /** Currency */
+    currency: PriceDtoCurrency;
+    /** Price type */
+    type: PriceDtoType;
+    /** Recurring configuration (for recurring prices) */
+    recurring?: RecurringDto;
+    /** Custom unit amount configuration — present for CUSTOM-type prices */
+    customUnitAmount?: CustomUnitAmountDto;
+    /** Creation timestamp (ISO 8601) */
+    createdAt: string;
+    /** Whether the price is active. `false` means the merchant archived it. */
+    active: boolean;
+    /**
+     * Remaining stock. `null` means unlimited. Decremented on PaymentIntent success. May go negative under race conditions (oversold).
+     * @nullable
+     */
+    stock?: number | null;
+    /**
+     * Start date (before which the price is not usable in checkout), ISO 8601
+     * @nullable
+     */
+    startDate?: string | null;
+    /**
+     * Expiration date (at/after which the price is not usable in checkout), ISO 8601
+     * @nullable
+     */
+    expirationDate?: string | null;
+    /** Product associated with this price */
+    product: ProductDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Currency for the amounts (ISO 4217)
+ */
+type LineItemDtoCurrency = typeof LineItemDtoCurrency[keyof typeof LineItemDtoCurrency];
+declare const LineItemDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Presentment currency for this line — matches session.presentmentDetails.currency
+ */
+type LineItemPresentmentDetailsDtoCurrency = typeof LineItemPresentmentDetailsDtoCurrency[keyof typeof LineItemPresentmentDetailsDtoCurrency];
+declare const LineItemPresentmentDetailsDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface LineItemPresentmentDetailsDto {
+    /** Unit amount in presentment smallest unit */
+    unitAmount: number;
+    /** Line subtotal (unitAmount × quantity) in presentment smallest unit */
+    amountSubtotal: number;
+    /** Line discount allocated to this item, in presentment smallest unit */
+    amountDiscount: number;
+    /** Line total after discount + tax, in presentment smallest unit */
+    amountTotal: number;
+    /** Presentment currency for this line — matches session.presentmentDetails.currency */
+    currency: LineItemPresentmentDetailsDtoCurrency;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface LineItemDto {
+    /** Line item ID */
+    id: string;
+    /** Quantity */
+    quantity: number;
+    /** Price information */
+    price: PriceDto;
+    /** Adjustable quantity settings */
+    adjustableQuantity?: AdjustableQuantityDto;
+    /** Total before any discounts or taxes (unitAmount × quantity) */
+    amountSubtotal?: number;
+    /** Total after discounts and taxes */
+    amountTotal?: number;
+    /** Discount amount applied to this item */
+    amountDiscount?: number;
+    /** Tax amount applied to this item */
+    amountTax?: number;
+    /** Currency for the amounts (ISO 4217) */
+    currency?: LineItemDtoCurrency;
+    /** Description from price/product */
+    description?: string;
+    /** Customer-facing view of this line item. Populated on checkout-session snapshots when the merchant prices in a currency different from processing. Uses the session's locked exchange rate. */
+    presentmentDetails?: LineItemPresentmentDetailsDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Field type
+ */
+type CustomFieldResponseDtoType = typeof CustomFieldResponseDtoType[keyof typeof CustomFieldResponseDtoType];
+declare const CustomFieldResponseDtoType: {
+    readonly TEXT: "TEXT";
+    readonly NUMBER: "NUMBER";
+    readonly DROPDOWN: "DROPDOWN";
+    readonly CHECKBOX: "CHECKBOX";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Type of validation limit
+ */
+type CustomFieldResponseDtoLimitType = typeof CustomFieldResponseDtoLimitType[keyof typeof CustomFieldResponseDtoLimitType];
+declare const CustomFieldResponseDtoLimitType: {
+    readonly AT_MOST: "AT_MOST";
+    readonly BETWEEN: "BETWEEN";
+    readonly AT_LEAST: "AT_LEAST";
+    readonly EXACTLY: "EXACTLY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface DropdownOptionResponseDto {
+    /** Option label */
+    label: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface CustomFieldTextValueDto {
+    /** Text value */
+    value: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface CustomFieldNumericValueDto {
+    /** Numeric value */
+    value: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface CustomFieldDropdownValueDto {
+    /** Selected dropdown value */
+    value: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface CustomFieldResponseDto {
+    /** Unique key for the field */
+    key: string;
+    /** Field label */
+    label: string;
+    /** Field type */
+    type: CustomFieldResponseDtoType;
+    /** Whether the field is optional */
+    isOptional: boolean;
+    /** Whether validation limits are enabled */
+    hasLimits?: boolean;
+    /** Type of validation limit */
+    limitType?: CustomFieldResponseDtoLimitType;
+    /** Minimum number of characters */
+    minCharacters?: number;
+    /** Maximum number of characters */
+    maxCharacters?: number;
+    /** Dropdown options */
+    dropdownOptions?: DropdownOptionResponseDto[];
+    /** Text value (populated after collection) */
+    text?: CustomFieldTextValueDto;
+    /** Numeric value (populated after collection) */
+    numeric?: CustomFieldNumericValueDto;
+    /** Dropdown value (populated after collection) */
+    dropdown?: CustomFieldDropdownValueDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Discount type
+ */
+type CouponResponseDtoDiscountType = typeof CouponResponseDtoDiscountType[keyof typeof CouponResponseDtoDiscountType];
+declare const CouponResponseDtoDiscountType: {
+    readonly percentage: "percentage";
+    readonly fixed_amount: "fixed_amount";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Currency for amountOff
+ */
+type CouponResponseDtoCurrency = typeof CouponResponseDtoCurrency[keyof typeof CouponResponseDtoCurrency];
+declare const CouponResponseDtoCurrency: {
+    readonly EGP: "EGP";
+    readonly USD: "USD";
+    readonly EUR: "EUR";
+    readonly GBP: "GBP";
+    readonly SAR: "SAR";
+    readonly AED: "AED";
+    readonly QAR: "QAR";
+    readonly KWD: "KWD";
+    readonly JOD: "JOD";
+    readonly OMR: "OMR";
+    readonly BHD: "BHD";
+    readonly LYD: "LYD";
+    readonly AUD: "AUD";
+    readonly CAD: "CAD";
+    readonly CNY: "CNY";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Duration
+ */
+type CouponResponseDtoDuration = typeof CouponResponseDtoDuration[keyof typeof CouponResponseDtoDuration];
+declare const CouponResponseDtoDuration: {
+    readonly once: "once";
+    readonly repeating: "repeating";
+    readonly forever: "forever";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Custom metadata
+ */
+type CouponResponseDtoMetadata = {
+    [key: string]: unknown;
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * A Coupon defines a reusable discount you can apply to Checkout Sessions and PaymentIntents. Coupons can grant either a percentage off (`percentOff`) or a fixed amount off (`amountOff`), and can apply once, forever, or repeating for a number of billing cycles. You can also cap how many times a Coupon may be redeemed and when it expires.
+
+Coupons are the reusable template. Each concrete application of a Coupon to a customer's purchase is recorded as a Discount. To give customers a redeemable code (e.g. `SUMMER25`) instead of applying the Coupon directly, create one or more Promotion Codes that map to this Coupon — a single Coupon can have many Promotion Codes, each with its own per-code restrictions. You receive `coupon.*` and `promotion_code.*` webhook events for each as they are created or changed.
+ */
+interface CouponResponseDto {
+    /** Coupon ID */
+    id: string;
+    /** Object type */
+    object: string;
+    /** Created timestamp (ISO 8601) */
+    createdAt: string;
+    /** Discount type */
+    discountType: CouponResponseDtoDiscountType;
+    /** Percentage off (0.01-100) */
+    percentOff?: number;
+    /** Fixed amount off in smallest currency unit */
+    amountOff?: number;
+    /** Currency for amountOff */
+    currency?: CouponResponseDtoCurrency;
+    /** Duration */
+    duration: CouponResponseDtoDuration;
+    /** Number of months for repeating duration */
+    durationInMonths?: number;
+    /** Display name */
+    name?: string;
+    /** Maximum discount amount for percentage coupons (caps the discount) */
+    maxDiscountAmount?: number;
+    /** Minimum order subtotal required to use this coupon */
+    minValue?: number;
+    /** Maximum total redemptions */
+    maxRedemptions?: number;
+    /** Maximum times a single customer can redeem */
+    customerMaxRedemptions?: number;
+    /** Number of times redeemed */
+    timesRedeemed: number;
+    /** Redemption deadline (ISO 8601) */
+    redeemBy?: string;
+    /** Whether the coupon is currently valid (computed) */
+    valid: boolean;
+    /** Whether the coupon is active */
+    active: boolean;
+    /** Product IDs this coupon applies to */
+    appliesToProductIds?: string[];
+    /** Custom metadata */
+    metadata?: CouponResponseDtoMetadata;
+    /** Merchant ID */
+    merchantId: string;
+    /** Whether this is live mode */
+    livemode: boolean;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * A Discount records a single application of a Coupon to a specific Checkout Session, PaymentIntent, or Customer. Where a Coupon is the reusable template, a Discount captures the concrete redemption: which Coupon was applied, when it became active, when it expires, and (when applicable) which Promotion Code the customer entered to claim it.
+ */
+interface DiscountResponseDto {
+    /** Discount ID */
+    id: string;
+    /** Object type */
+    object: string;
+    /** The coupon that was applied */
+    coupon: CouponResponseDto;
+    /** Promotion code ID used (null if direct coupon application) */
+    promotionCodeId?: string;
+    /** Customer-facing promotion code string (e.g. SUMMER25) */
+    promotionCodeCode?: string;
+    /** Checkout session this discount was applied to */
+    checkoutSessionId: string;
+    /** Customer who received the discount */
+    customerId?: string;
+    /** When the discount became active (ISO 8601) */
+    start: string;
+    /** When the discount ends (ISO 8601) */
+    end?: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Where this config came from
+ */
+type FeeConfigResponseDtoSource = typeof FeeConfigResponseDtoSource[keyof typeof FeeConfigResponseDtoSource];
+declare const FeeConfigResponseDtoSource: {
+    readonly session: "session";
+    readonly merchant: "merchant";
+    readonly system: "system";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface FeeConfigResponseDto {
+    /** Whether customer pays platform fee (false = merchant pays) */
+    feesPassThrough: boolean;
+    /** Whether to collect VAT from customer */
+    vatCollectionEnabled: boolean;
+    /** VAT collection rate in basis points (e.g., 1400 = 14%) */
+    vatCollectionRate?: number;
+    /** Where this config came from */
+    source: FeeConfigResponseDtoSource;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Language the checkout page is displayed in. Resolved from `session.locale`, falling back to your account's `defaultLocale`, then to `en`.
+ */
+type CheckoutSessionResponseDtoLocale = typeof CheckoutSessionResponseDtoLocale[keyof typeof CheckoutSessionResponseDtoLocale];
+declare const CheckoutSessionResponseDtoLocale: {
+    readonly en: "en";
+    readonly ar: "ar";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+interface PaymentMethodTypeResponseDto {
+    /** Concrete payment method type (e.g., 'card', 'fawry', 'valu') */
+    type: string;
+    /** Display name for the payment method */
+    displayName: string;
+    /** UI grouping category (e.g., 'card', 'bnpl', 'kiosk') */
+    category?: string;
+    /**
+     * Minimum transaction amount in piasters
+     * @nullable
+     */
+    minTransactionAmount?: string | null;
+    /**
+     * Maximum transaction amount in piasters
+     * @nullable
+     */
+    maxTransactionAmount?: string | null;
+    /**
+     * Required customer fields for this payment method
+     * @nullable
+     */
+    requiredCustomerFields?: string[] | null;
+    /** Whether this payment method supports refunds */
+    supportsRefund?: boolean;
+    /** Whether partial refunds are supported */
+    supportsPartialRefund?: boolean;
+    /** Whether partial capture is supported */
+    supportsPartialCapture?: boolean;
+    /** Whether payment resolves immediately or asynchronously */
+    paymentConfirmation?: string;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface FeesResponseDto {
+    /** Payment method type (e.g., card, fawry, valu) */
+    paymentMethodType: string;
+    /** Platform fee amount (only if feesPassThrough is true) */
+    feeAmount: number;
+    /** Fee percentage */
+    feePercentage: number;
+    /** VAT amount (only if vatCollectionEnabled is true) */
+    vatAmount?: number;
+    /** Total amount customer will pay */
+    totalAmount: number;
+    /** Card info (only for card payments with BIN) */
+    cardInfo?: CardInfoResponseDto;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Whether to save address to customer.address
+ */
+type CustomerUpdateResponseDtoAddress = typeof CustomerUpdateResponseDtoAddress[keyof typeof CustomerUpdateResponseDtoAddress];
+declare const CustomerUpdateResponseDtoAddress: {
+    readonly auto: "auto";
+    readonly never: "never";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Whether to save name to customer.name
+ */
+type CustomerUpdateResponseDtoName = typeof CustomerUpdateResponseDtoName[keyof typeof CustomerUpdateResponseDtoName];
+declare const CustomerUpdateResponseDtoName: {
+    readonly auto: "auto";
+    readonly never: "never";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Whether to save shipping to customer.shipping
+ */
+type CustomerUpdateResponseDtoShipping = typeof CustomerUpdateResponseDtoShipping[keyof typeof CustomerUpdateResponseDtoShipping];
+declare const CustomerUpdateResponseDtoShipping: {
+    readonly auto: "auto";
+    readonly never: "never";
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+interface CustomerUpdateResponseDto {
+    /** Whether to save address to customer.address */
+    address?: CustomerUpdateResponseDtoAddress;
+    /** Whether to save name to customer.name */
+    name?: CustomerUpdateResponseDtoName;
+    /** Whether to save shipping to customer.shipping */
+    shipping?: CustomerUpdateResponseDtoShipping;
+}
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+/**
+ * Custom metadata
+ */
+type CheckoutSessionResponseDtoMetadata = {
+    [key: string]: unknown;
+};
+
+/**
+ * Generated by orval v7.21.0 🍺
+ * Do not edit manually.
+ * XPay Checkout API
+ * API for the XPay checkout flow — client endpoints and SSR
+ * OpenAPI spec version: 1.0
+ */
+
+/**
+ * A Checkout Session represents your customer's session as they pay on an xpay-hosted checkout page. Create a new Session each time a customer begins a checkout: attach line items, customer details, or a PaymentIntent, then redirect the customer to the Session's `url` to begin payment. As the customer progresses, the Session's `status` and `paymentStatus` update; once payment succeeds, the Session contains references to the resulting Customer and PaymentIntent. Sessions expire 24 hours after creation if not completed.
+ */
+interface CheckoutSessionResponseDto {
+    /** Checkout session ID. Absent on the SSR hosted-view payload derived from a payment link (before the first mutation materializes the session). */
+    id?: string;
+    /** Object type */
+    object: string;
+    /** Created timestamp (ISO 8601) */
+    createdAt: string;
+    /** Updated timestamp (ISO 8601) */
+    updatedAt?: string;
+    /** Session mode */
+    mode: CheckoutSessionResponseDtoMode;
+    /** UI mode */
+    uiMode: CheckoutSessionResponseDtoUiMode;
+    /** Submit type */
+    submitType: CheckoutSessionResponseDtoSubmitType;
+    /** Customer creation mode */
+    customerCreation: CheckoutSessionResponseDtoCustomerCreation;
+    /** Session status */
+    status: CheckoutSessionResponseDtoStatus;
+    /** Payment status */
+    paymentStatus: CheckoutSessionResponseDtoPaymentStatus;
+    /** Currency code (ISO 4217) */
+    currency?: CheckoutSessionResponseDtoCurrency;
+    /** Subtotal before discounts/taxes */
+    amountSubtotal?: number;
+    /** Total amount due */
+    amountTotal?: number;
+    /** Amount breakdown */
+    totalDetails?: TotalDetailsResponseDto;
+    /** Customer-facing view of the session — full mirror of subtotal/total/discount/VAT/fees in the presentment currency. Populated only when the merchant prices in a currency different from processing. Uses a rate locked at session creation. */
+    presentmentDetails?: SessionPresentmentDetailsDto;
+    /** What happens after payment: redirect to merchant URL or show hosted confirmation page */
+    afterCompletion: CheckoutSessionResponseDtoAfterCompletion;
+    /** Cancel redirect URL (back button during checkout) */
+    cancelUrl?: string;
+    /** Checkout page URL (hosted mode) */
+    url?: string;
+    /** Client secret for frontend access */
+    clientSecret?: string;
+    /** Expiration timestamp (ISO 8601) */
+    expiresAt?: string;
+    /** Customer ID (when existing customer linked) */
+    customerId?: string;
+    /** Customer object (when customerId is provided). Contains existing customer data for prefill. */
+    customer?: CheckoutSessionCustomerDto;
+    /** CustomerDetails - unified prefill/collection object. Contains name, email, phone, address (billing), shipping. */
+    customerDetails?: CustomerDetailsResponseDto;
+    /** Payment Intent ID */
+    paymentIntentId?: string;
+    /**
+     * The PaymentIntent for this session, or `null` if no payment has been started yet. The PaymentIntent's own `checkoutSession` field is not included here to keep the response self-contained.
+     * @nullable
+     */
+    paymentIntent: CheckoutSessionResponseDtoPaymentIntent;
+    /** Line items with full price and product details */
+    lineItems?: LineItemDto[];
+    /** Custom fields with configuration and collected values (Stripe-aligned). Values are populated after customer submits. */
+    customFields?: CustomFieldResponseDto[];
+    /** Applied discounts on this session */
+    discounts?: DiscountResponseDto[];
+    /** Allow promotion codes */
+    allowPromotionCodes: boolean;
+    /** Collect customer name */
+    nameCollection: boolean;
+    /** Collect billing address */
+    billingAddressCollection: boolean;
+    /** Collect shipping address */
+    shippingAddressCollection: boolean;
+    /** Collect phone number */
+    phoneNumberCollection: boolean;
+    /** Fee configuration (tells checkout whether to track BIN and display fees) */
+    feeConfig?: FeeConfigResponseDto;
+    /** UI customization settings for checkout (colors, spacing, borders, etc.). Fully resolved: merchant defaults merged with session-level overrides. Callers can apply this object directly — no client-side merging required. */
+    brandingSettings?: BrandingSettingsResponseDto;
+    /** Language the checkout page is displayed in. Resolved from `session.locale`, falling back to your account's `defaultLocale`, then to `en`. */
+    locale?: CheckoutSessionResponseDtoLocale;
+    /** Available payment method types with fee estimates */
+    paymentMethodTypes?: PaymentMethodTypeResponseDto[];
+    /** ID of the PaymentMethodConfiguration used for this session */
+    paymentMethodConfigurationId?: string;
+    /** Fee breakdown (only populated when feesPassThrough or vatCollectionEnabled, and after /update with BIN for cards) */
+    fees?: FeesResponseDto;
+    /** Controls which customer fields to update when customerId is provided */
+    customerUpdate?: CustomerUpdateResponseDto;
+    /** Custom metadata */
+    metadata?: CheckoutSessionResponseDtoMetadata;
+    /** Merchant ID */
+    merchantId: string;
+    /** Merchant display name */
+    merchantName?: string;
+    /** Merchant logo URL */
+    merchantLogo?: string;
+    /** Payment Link ID (if created from link) */
+    paymentLinkId?: string;
+    /** Whether this is a live mode session */
+    livemode: boolean;
+}
+
+/**
+ * XPay SDK Public API Types
+ *
+ * SDK-specific interfaces (XPayInstance, Elements, etc.) are defined here.
+ * Data types (session fields, payment methods, etc.) are derived from
+ * the Orval-generated @xpay/checkout-api package — the source of truth.
+ * If the API changes a field, TypeScript catches it at compile time.
+ */
+
+/**
+ * Information about an available payment method.
+ *
+ * @example
+ * ```ts
+ * checkout.paymentMethods.forEach(pm => {
+ *   console.log(pm.type);        // "card", "valu", "fawry"
+ *   console.log(pm.displayName); // "Card", "ValU", "Fawry"
+ *   console.log(pm.category);    // "card", "bnpl", "kiosk", "wallet"
+ * });
+ * ```
+ */
+type PaymentMethodInfo = Required<Pick<PaymentMethodTypeResponseDto, "type" | "displayName">> & {
+    /** Payment method category for grouping in UI */
+    category: "card" | "bnpl" | "kiosk" | "wallet";
+    /** Icon URL for the payment method */
+    icon?: string;
+    /** Description of the next step (e.g., "You will be redirected to complete payment") */
+    nextActionText?: string;
+};
+/**
+ * Appearance overrides for the checkout UI.
+ * Merged with the session's server-side `brandingSettings`.
+ *
+ * @example
+ * ```ts
+ * const elements = xpay.elements({
+ *   clientSecret,
+ *   appearance: {
+ *     colorMode: "dark",
+ *     borderStyle: "rounded",
+ *     inputStyle: "outlined",
+ *   },
+ * });
+ * ```
+ */
+type Appearance = Pick<BrandingSettingsResponseDto, "colorMode" | "borderStyle" | "spacing" | "inputSize" | "inputStyle" | "formLayout" | "colors" | "fontFamily">;
+/**
+ * Structured session status — tagged union for exhaustive checking.
+ *
+ * @example
+ * ```ts
+ * switch (checkout.status.type) {
+ *   case "open":     // ready for payment
+ *   case "expired":  // session timed out
+ *   case "complete": // payment completed — check paymentStatus
+ * }
+ * ```
+ */
+type SessionStatus = {
+    type: "open";
+} | {
+    type: "expired";
+} | {
+    type: "complete";
+    paymentStatus: CheckoutSessionResponseDtoPaymentStatus;
+};
+/**
+ * Checkout session data exposed to merchants.
+ *
+ * Contains everything needed to render a checkout UI: amounts, currency,
+ * available payment methods, line items, fees, and discounts.
+ *
+ * @example
+ * ```ts
+ * const state = useCheckout();
+ * if (state.type === "success") {
+ *   const { checkout } = state;
+ *   console.log(checkout.amountTotal);   // "10000" (in minor units)
+ *   console.log(checkout.currency);      // "EGP"
+ *   console.log(checkout.status.type);   // "open"
+ *   console.log(checkout.paymentMethods); // [{type: "card", ...}, ...]
+ * }
+ * ```
+ */
+type CheckoutSession = Pick<CheckoutSessionResponseDto, "id" | "amountSubtotal" | "amountTotal" | "currency" | "merchantName" | "livemode" | "expiresAt"> & {
+    /** Structured session status */
+    status: SessionStatus;
+    /** Whether the session is ready for confirmation */
+    canConfirm: boolean;
+    /** Available payment methods */
+    paymentMethods: PaymentMethodInfo[];
+    /** Line items in the session */
+    lineItems?: CheckoutSessionResponseDto["lineItems"];
+    /** Totals breakdown (subtotal, tax, shipping, etc.) */
+    totalDetails?: CheckoutSessionResponseDto["totalDetails"];
+    /** Fee breakdown (when feesPassThrough is enabled) */
+    fees?: CheckoutSessionResponseDto["fees"];
+    /** Applied discounts / promotion codes */
+    discounts?: CheckoutSessionResponseDto["discounts"];
+};
+
+/**
+ * Result of an action (confirm, promo, quantity update, etc.).
+ * Tagged union — check `result.type` to determine success or failure.
+ *
+ * @example
+ * ```ts
+ * const result = await checkout.applyPromotionCode("SAVE10");
+ * if (result.type === "success") {
+ *   console.log(result.session.amountTotal); // updated amount
+ * } else {
+ *   console.log(result.error.message); // "Invalid promotion code"
+ * }
+ * ```
+ */
+type ActionResult<E = XPayError> = {
+    type: "success";
+    session: CheckoutSession;
+} | {
+    type: "error";
+    error: E;
+};
+/**
+ * Unified error type for ALL SDK operations (Stripe-style).
+ *
+ * Same type for `confirm()`, `applyPromotionCode()`, `updateLineItemQuantity()`, etc.
+ * Payment-specific fields (`declineCode`, `adviceCode`, `chargeId`, `paymentMethod`) are
+ * `null` for non-payment errors.
+ *
+ * @example Payment decline:
+ * ```ts
+ * const result = await checkout.confirm({ customerDetails: { email } });
+ * if (result.type === "error") {
+ *   console.log(result.error.type);        // "card_error"
+ *   console.log(result.error.code);        // "card_declined"
+ *   console.log(result.error.declineCode); // "insufficient_funds"
+ *   console.log(result.error.adviceCode);  // "try_again_later"
+ *   console.log(result.error.message);     // "Your card has insufficient funds."
+ * }
+ * ```
+ *
+ * @example API error (promo code, quantity, session):
+ * ```ts
+ * const result = await checkout.applyPromotionCode("INVALID");
+ * if (result.type === "error") {
+ *   console.log(result.error.type);    // "invalid_request_error"
+ *   console.log(result.error.code);    // "promotion_code_not_found"
+ *   console.log(result.error.param);   // "promotionCode"
+ *   console.log(result.error.docUrl);  // "https://docs.xpay.app/api/errors#promotion_code_not_found"
+ *   console.log(result.error.message); // "No promotion code found for 'INVALID'"
+ * }
+ * ```
+ */
+interface XPayError {
+    /** Error category: "card_error" | "payment_method_error" | "invalid_request_error" | "api_error" | ... */
+    type: string;
+    /** Machine-readable error code: "card_declined" | "checkout_session_expired" | "promotion_code_not_found" | ... */
+    code: string | null;
+    /** Human-readable error message */
+    message: string;
+    /** Parameter that caused the error (e.g., "promotionCode", "quantity") — null for payment errors */
+    param?: string | null;
+    /** Documentation URL for this error code */
+    docUrl?: string | null;
+    /** Decline code — WHY it failed specifically ("insufficient_funds", "generic_decline") — null for non-payment errors */
+    declineCode?: string | null;
+    /** Retry advice ("try_again_later" | "do_not_try_again" | "confirm_card_data") — null for non-payment errors */
+    adviceCode?: string | null;
+    /** Failed charge ID — null for non-payment errors */
+    chargeId?: string | null;
+    /** Failed payment method ID — null for non-payment errors */
+    paymentMethodId?: string | null;
+    /** Payment method type ("card" | "valu" | "fawry") — null for non-payment errors */
+    paymentMethodType?: string | null;
+    /** Payment method snapshot at time of failure — null for non-payment errors */
+    paymentMethod?: Record<string, unknown> | null;
+}
+/**
+ * The XPay SDK instance returned by `loadXPay()`.
+ *
+ * @example
+ * ```ts
+ * import { loadXPay } from "@xpayeg/sdk";
+ *
+ * const xpay = await loadXPay("pk_test_xxx");
+ * const elements = xpay.elements({ clientSecret: "cs_test_abc_secret_xyz" });
+ * ```
+ */
+interface XPayInstance {
+    /**
+     * Create an Elements instance for custom checkout UI.
+     * Use with `PaymentElement` or `CardElement` to render payment forms.
+     *
+     * @param options - Must include `clientSecret` from a checkout session
+     * @returns An Elements instance for creating and managing payment elements
+     */
+    elements(options: ElementsOptions): Elements;
+    /**
+     * Create a drop-in checkout modal or inline embed.
+     *
+     * @param options - Configuration including `clientSecret` and event handlers
+     * @returns A checkout instance with `open()`, `close()`, and `destroy()` methods
+     */
+    checkout(options: CheckoutOptions): CheckoutInstance;
+    /**
+     * Confirm a payment using the data collected by Elements.
+     *
+     * @param options - Must include `elements` and optionally `customerDetails`
+     * @returns Action result with the updated session on success, or an error
+     */
+    confirmPayment(options: ConfirmPaymentOptions): Promise<ActionResult>;
+    /**
+     * Initialize a checkout session — combines `elements()` with session data.
+     * Returns session data + action methods in a single call.
+     *
+     * @param options - Must include `clientSecret`
+     * @returns Session data merged with checkout action methods
+     */
+    initCheckout(options: InitCheckoutOptions): Promise<InitCheckoutResult>;
+}
+/**
+ * Options for creating an Elements instance.
+ *
+ * @example
+ * ```ts
+ * const elements = xpay.elements({
+ *   clientSecret: "cs_test_abc_secret_xyz",
+ *   appearance: { colorMode: "dark" },
+ *   locale: "ar",
+ * });
+ * ```
+ */
+interface ElementsOptions {
+    /** The client secret from a checkout session. Can be a string or a Promise. */
+    clientSecret: string | Promise<string>;
+    /** Appearance overrides for the checkout UI */
+    appearance?: Appearance;
+    /** Locale for the payment form — `"en"` (default) or `"ar"` */
+    locale?: "en" | "ar";
+}
+/**
+ * Manages the lifecycle of payment elements (PaymentElement, CardElement).
+ *
+ * A single Elements instance manages one embed iframe shared by all elements.
+ * Provides session management methods (promo codes, quantities, etc.) and
+ * element creation.
+ */
+interface Elements {
+    /** Create a PaymentElement (full payment method selector + card form) */
+    create(type: "payment", options?: PaymentElementOptions): PaymentElement;
+    /** Create a CardElement (card form only — merchant handles method selection) */
+    create(type: "card", options?: CardElementOptions): CardElement;
+    /** Get an existing element by type, or null if not created */
+    getElement(type: "payment"): PaymentElement | null;
+    /** Get an existing element by type, or null if not created */
+    getElement(type: "card"): CardElement | null;
+    /** Fetch available payment methods for this session */
+    fetchPaymentMethods(): Promise<PaymentMethodInfo[]>;
+    /**
+     * Listen for the `ready` event — fires when the session is loaded and elements can render.
+     * If the session is already loaded, the handler fires immediately.
+     */
+    on(event: "ready", handler: (data: ElementsReadyEvent) => void): void;
+    /** Listen for session data changes (payment method selection, promo codes, fee updates, etc.) */
+    on(event: "change", handler: (session: CheckoutSession) => void): void;
+    /** Listen for session load failures (network errors, invalid client secret, API errors) */
+    on(event: "loaderror", handler: (data: ElementsLoadErrorEvent) => void): void;
+    /** Listen for unsolicited errors not triggered by a merchant action (e.g. session expired during fee recalculation, BIN detection failure) */
+    on(event: "error", handler: (error: XPayError) => void): void;
+    /** Listen for a custom event */
+    on(event: string, handler: (...args: unknown[]) => void): void;
+    /** Remove an event handler */
+    off(event: string, handler: (...args: unknown[]) => void): void;
+    /** Apply a promotion code to the session */
+    applyPromotionCode(code: string): Promise<ActionResult>;
+    /** Remove the applied promotion code */
+    removePromotionCode(): Promise<ActionResult>;
+    /** Update a line item's quantity */
+    updateLineItemQuantity(args: {
+        lineItem: string;
+        quantity: number;
+    }): Promise<ActionResult>;
+    /** Validate all element fields before confirming — returns the selected payment method on success */
+    submit(): Promise<{
+        error?: XPayError;
+        selectedPaymentMethod?: string;
+    }>;
+    /** Re-fetch the session from the server to get the latest data */
+    fetchUpdates(): Promise<ActionResult>;
+    /** Update the appearance at runtime without recreating elements */
+    changeAppearance(appearance: Appearance): void;
+    /** Destroy the Elements instance and clean up all resources */
+    destroy(): void;
+}
+/** Fired when the session is loaded and elements are ready to render */
+interface ElementsReadyEvent {
+    /** The loaded checkout session data */
+    session: CheckoutSession;
+}
+/** Fired when the session fails to load */
+interface ElementsLoadErrorEvent {
+    /** Error category */
+    type: "invalid_request_error" | "api_error" | "network_error";
+    /** Human-readable error message */
+    message: string;
+    /** Machine-readable error code */
+    code?: string;
+    /** The parameter that caused the error */
+    param?: string;
+    /** Link to documentation about this error */
+    docUrl?: string;
+}
+/** Options for creating a PaymentElement */
+interface PaymentElementOptions {
+    /** Layout style for the payment method selector — `"accordion"` (default) or `"tabs"` */
+    layout?: "accordion" | "tabs";
+    /** Pre-select a specific payment method by type */
+    defaultPaymentMethod?: string;
+    /** Custom ordering of payment methods by type */
+    paymentMethodOrder?: string[];
+}
+/** Options for creating a CardElement */
+interface CardElementOptions {
+    /** Whether to show the cardholder name input */
+    showCardholderName?: boolean;
+}
+/**
+ * Change event from a PaymentElement.
+ * Fires on payment method selection, card field changes, and session updates.
+ *
+ * @example
+ * ```tsx
+ * <PaymentElement
+ *   onChange={(event) => {
+ *     setPaymentReady(event.complete);
+ *     console.log("Selected method:", event.value.type);
+ *   }}
+ * />
+ * ```
+ */
+interface PaymentElementChangeEvent {
+    elementType: "payment";
+    /** Whether all card fields are empty (no user input yet) */
+    empty: boolean;
+    /** Whether the form is complete and ready for submission */
+    complete: boolean;
+    /** Whether the payment method selector is collapsed (no method selected) */
+    collapsed: boolean;
+    /** The currently selected payment method */
+    value: {
+        type: string;
+    };
+    /** Full session data including updated amounts, fees, and discounts */
+    session: CheckoutSession;
+}
+/**
+ * Change event from a CardElement.
+ * Fires when card fields change (input, validation, completion).
+ */
+interface CardElementChangeEvent {
+    elementType: "card";
+    /** Whether all card fields are empty */
+    empty: boolean;
+    /** Whether all card fields are filled and valid */
+    complete: boolean;
+    /** Detected card details (available as user types) */
+    value: {
+        /** Card brand (e.g., "visa", "mastercard") — null until detected */
+        brand: string | null;
+    };
+}
+/** Base interface shared by all element types */
+interface BaseElement {
+    /** Mount the element into a DOM container (CSS selector or HTMLElement) */
+    mount(container: string | HTMLElement): void;
+    /** Unmount the element from the DOM (can be re-mounted later) */
+    unmount(): void;
+    /** Destroy the element and release all resources */
+    destroy(): void;
+    /** Programmatically focus the element's iframe */
+    focus(): void;
+    /** Programmatically blur the element's iframe */
+    blur(): void;
+    /** Fired when the element is mounted and the iframe content is ready */
+    on(event: "ready", handler: () => void): void;
+    /** Fired when the element's iframe starts loading */
+    on(event: "loaderstart", handler: () => void): void;
+    /** Fired when the element fails to load */
+    on(event: "loaderror", handler: (event: ElementsLoadErrorEvent) => void): void;
+    on(event: string, handler: (...args: unknown[]) => void): void;
+    off(event: string, handler: (...args: unknown[]) => void): void;
+}
+/** PaymentElement — full payment method selector with card form */
+interface PaymentElement extends BaseElement {
+    /** Collapse the payment method selector (deselect all methods) */
+    collapse(): void;
+    /** Update element options at runtime */
+    update(options: Partial<PaymentElementOptions>): void;
+}
+/** CardElement — card-only form (merchant handles payment method selection) */
+interface CardElement extends BaseElement {
+    /** Update element options at runtime */
+    update(options: Partial<CardElementOptions>): void;
+}
+/**
+ * Options for `confirmPayment()` or `checkout.confirm()`.
+ *
+ * The `redirect` option controls what happens after a successful payment:
+ * - `"if_required"` (default) — returns the result to your code
+ * - `"always"` — always redirects to `returnUrl` after payment
+ *
+ * @example
+ * ```ts
+ * // Default: get the result back in code
+ * const result = await checkout.confirm({
+ *   customerDetails: { email: "user@example.com" },
+ * });
+ *
+ * // Always redirect after payment
+ * await checkout.confirm({
+ *   redirect: "always",
+ *   returnUrl: "https://merchant.com/success",
+ * });
+ * ```
+ */
+interface ConfirmPaymentOptions {
+    /** The Elements instance managing the payment form */
+    elements: Elements;
+    /** Customer details collected by the merchant's form */
+    customerDetails?: CustomerDetails;
+    /** Custom field values for the session */
+    customFields?: Record<string, string | number | boolean>;
+    /** Device fingerprint for fraud detection */
+    deviceFingerprint?: {
+        visitorId: string;
+        confidence?: number;
+    };
+    /** Override the selected payment method type */
+    paymentMethod?: string;
+    /**
+     * Redirect behavior after payment.
+     * - `"if_required"` (default) — returns the result to your code; only redirects if the payment method requires it
+     * - `"always"` — always redirects to `returnUrl` after payment. The page navigates away and the function never returns on success.
+     */
+    redirect?: "if_required" | "always";
+    /** URL to redirect to after payment. Overrides the session's `afterCompletion.redirect.url`. Only needed if you want a different URL than the one set server-side. */
+    returnUrl?: string;
+}
+/**
+ * Options for creating a drop-in checkout instance.
+ *
+ * @example
+ * ```ts
+ * const checkout = xpay.checkout({
+ *   clientSecret: "cs_test_abc_secret_xyz",
+ *   mode: "modal",
+ *   onComplete: (result) => console.log("Paid!", result.paymentIntentId),
+ * });
+ * checkout.open();
+ * ```
+ */
+interface CheckoutOptions {
+    /** Client secret from a checkout session */
+    clientSecret: string;
+    /** Display mode — `"modal"` (overlay) or `"inline"` (embedded in page) */
+    mode?: "modal" | "inline";
+    /** Container for inline mode (CSS selector or HTMLElement) */
+    container?: string | HTMLElement;
+    /** Called when the payment completes successfully */
+    onComplete?: (result: CheckoutCompleteResult) => void;
+    /** Called when the checkout UI is closed */
+    onClose?: () => void;
+    /** Called when the session is loaded and the checkout is ready */
+    onReady?: (session: CheckoutSession) => void;
+    /** Called when the payment is confirmed (before final result) */
+    onConfirmed?: () => void;
+    /** Called when an error occurs */
+    onError?: (error: CheckoutError) => void;
+    /** Appearance overrides */
+    appearance?: Appearance;
+    /** Locale for the checkout UI */
+    locale?: "en" | "ar";
+}
+/** Drop-in checkout instance with lifecycle control */
+interface CheckoutInstance {
+    /** Open the checkout modal (only for `mode: "modal"`) */
+    open(): void;
+    /** Close the checkout UI */
+    close(): void;
+    /** Destroy the checkout instance and clean up resources */
+    destroy(): void;
+    on(event: "complete", handler: (result: CheckoutCompleteResult) => void): void;
+    on(event: "close", handler: () => void): void;
+    on(event: "ready", handler: (session: CheckoutSession) => void): void;
+    on(event: "confirmed", handler: () => void): void;
+    on(event: "error", handler: (error: CheckoutError) => void): void;
+    off(event: string, handler: (...args: unknown[]) => void): void;
+}
+/** Result of a successful payment via drop-in checkout */
+interface CheckoutCompleteResult {
+    status: "succeeded";
+    /** The payment intent ID for server-side verification */
+    paymentIntentId: string;
+    /** The charge ID (if available) */
+    chargeId?: string;
+    /** Redirect URL from the session's afterCompletion settings */
+    redirectUrl?: string;
+}
+/** Error from the drop-in checkout */
+interface CheckoutError {
+    /** Human-readable error message */
+    message: string;
+    /** Machine-readable error code */
+    code?: string;
+}
+/**
+ * Options for `initCheckout()` — the modern single-call API.
+ *
+ * @example
+ * ```ts
+ * const checkout = await xpay.initCheckout({
+ *   clientSecret: "cs_test_abc_secret_xyz",
+ * });
+ * console.log(checkout.amountTotal);
+ * await checkout.confirm({ customerDetails: { email: "..." } });
+ * ```
+ */
+interface InitCheckoutOptions {
+    /** Client secret from a checkout session (string or Promise) */
+    clientSecret: string | Promise<string>;
+    /** Appearance overrides */
+    appearance?: Appearance;
+    /** Locale for the payment form */
+    locale?: "en" | "ar";
+}
+/** Result of `initCheckout()` — session data merged with action methods */
+type InitCheckoutResult = CheckoutSession & CheckoutActions;
+/**
+ * Action methods available on the checkout object.
+ * These are merged with `CheckoutSession` to form the `Checkout` type.
+ */
+interface CheckoutActions {
+    /**
+     * Confirm the payment.
+     *
+     * @param options - Customer details and redirect behavior
+     * @returns Action result with updated session on success, or an `XPayError`.
+     *   With `redirect: "always"`, the page navigates away on success (never returns).
+     *
+     * @example
+     * ```ts
+     * const result = await checkout.confirm({
+     *   customerDetails: { email: "user@example.com" },
+     * });
+     * if (result.type === "error") {
+     *   console.error(result.error.message);
+     * }
+     * ```
+     */
+    confirm(options?: Omit<ConfirmPaymentOptions, "elements">): Promise<ActionResult>;
+    /** Apply a promotion code to the session */
+    applyPromotionCode(code: string): Promise<ActionResult>;
+    /** Remove the applied promotion code */
+    removePromotionCode(): Promise<ActionResult>;
+    /** Update a line item's quantity */
+    updateLineItemQuantity(args: {
+        lineItem: string;
+        quantity: number;
+    }): Promise<ActionResult>;
+    /** Validate all fields before confirming — returns the selected payment method on success */
+    submit(): Promise<{
+        error?: XPayError;
+        selectedPaymentMethod?: string;
+    }>;
+    /** Re-fetch the session from the server */
+    fetchUpdates(): Promise<ActionResult>;
+    /** Update the appearance at runtime */
+    changeAppearance(appearance: Appearance): void;
+    /** Listen for session data changes */
+    on(event: "change", handler: (session: CheckoutSession) => void): void;
+    /** Listen for unsolicited errors (e.g. session expired during internal updates) */
+    on(event: "error", handler: (error: XPayError) => void): void;
+    /** Listen for a custom event */
+    on(event: string, handler: (...args: unknown[]) => void): void;
+    /** Access the underlying Elements instance for element creation */
+    getElements(): Elements;
+}
+/** Customer details collected by the merchant's form */
+interface CustomerDetails {
+    /** Customer email address */
+    email?: string;
+    /** Customer full name */
+    name?: string;
+    /** Customer phone number */
+    phone?: string;
+    /** Billing details for the payment */
+    billingDetails?: {
+        name?: string;
+        email?: string;
+        phone?: string;
+        address?: Address;
+    };
+    /** Shipping details */
+    shipping?: {
+        name?: string;
+        phone?: string;
+        address?: Address;
+    };
+}
+/** Physical address */
+interface Address {
+    line1?: string;
+    line2?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+}
+
+/**
+ * @xpayeg/sdk — XPay JavaScript SDK Loader
+ *
+ * Loads the XPay SDK runtime from CDN and provides TypeScript types.
+ *
+ * Usage:
+ *   import { loadXPay } from '@xpayeg/sdk';
+ *
+ *   const xpay = await loadXPay('pk_test_xxx');
+ *   const elements = xpay.elements({ clientSecret: '...' });
+ */
+
+type XPayFactory = (publishableKey: string) => XPayInstance;
+declare global {
+    interface Window {
+        XPay?: XPayFactory;
+    }
+}
+/**
+ * Load the XPay SDK from CDN.
+ *
+ * Returns a promise that resolves to an XPayInstance with full TypeScript support.
+ * The SDK script is loaded once and cached — subsequent calls return the same instance.
+ *
+ * @param publishableKey - Your publishable API key (pk_test_... or pk_live_...)
+ *
+ * @example
+ * ```typescript
+ * import { loadXPay } from '@xpayeg/sdk';
+ *
+ * const xpay = await loadXPay('pk_test_xxx');
+ * const elements = xpay.elements({ clientSecret: 'cs_test_abc_secret_xyz' });
+ * ```
+ */
+declare function loadXPay(publishableKey: string): Promise<XPayInstance | null>;
+
+export { loadXPay };
+export type { ActionResult, Address, Appearance, BaseElement, CardElement, CardElementChangeEvent, CardElementOptions, CheckoutActions, CheckoutCompleteResult, DiscountResponseDto as CheckoutDiscount, CheckoutError, FeesResponseDto as CheckoutFees, CheckoutInstance, LineItemDto as CheckoutLineItem, CheckoutOptions, CheckoutSession, TotalDetailsResponseDto as CheckoutTotalDetails, ConfirmPaymentOptions, CustomerDetails, Elements, ElementsLoadErrorEvent, ElementsOptions, ElementsReadyEvent, InitCheckoutOptions, InitCheckoutResult, PaymentElement, PaymentElementChangeEvent, PaymentElementOptions, PaymentMethodInfo, SessionStatus, XPayError, XPayInstance };