Inttegro Web SDKs - v0.5.4
    Preparing search index...

    Type Alias CheckoutProps

    CheckoutProps: CheckoutOptions & {
        className?: string;
        onCanceled?: (event: Extract<CheckoutEvent, { type: "canceled" }>) => void;
        onCompleted?: (
            event: Extract<CheckoutEvent, { type: "completed" }>,
        ) => void;
        onError?: (error: Error) => void;
        onEvent?: (event: CheckoutEvent) => void;
        onFailed?: (event: Extract<CheckoutEvent, { type: "failed" }>) => void;
        onReady?: (event: Extract<CheckoutEvent, { type: "ready" }>) => void;
        presentation?: CheckoutPresentation;
        style?: CSSProperties;
    }

    Props for Checkout.

    features, the Checkout reference, presentation, timeout, and title identify the experience. Changing one replaces the underlying controller. appearance and locale update the existing controller without discarding payer progress.

    Type Declaration

    • OptionalclassName?: string

      CSS class applied to the outer container owned by your React application.

    • OptionalonCanceled?: (event: Extract<CheckoutEvent, { type: "canceled" }>) => void

      Called when a payer dismisses managed modal Checkout before completion.

    • OptionalonCompleted?: (event: Extract<CheckoutEvent, { type: "completed" }>) => void

      Called after Checkout reports its successful terminal state. Use this to navigate or refresh server-owned Order state, not as the sole signal for fulfillment.

    • OptionalonError?: (error: Error) => void

      Called for loader or mount errors.

    • OptionalonEvent?: (event: CheckoutEvent) => void

      Called for every sanitized lifecycle event, including events above.

    • OptionalonFailed?: (event: Extract<CheckoutEvent, { type: "failed" }>) => void

      Called when Checkout reaches a terminal failure state.

    • OptionalonReady?: (event: Extract<CheckoutEvent, { type: "ready" }>) => void

      Called once the iframe is interactive and its mount promise has resolved.

    • Optionalpresentation?: CheckoutPresentation

      Displays Checkout inline by default or in an Inttegro-managed modal.

    • Optionalstyle?: CSSProperties

      Inline styles applied to the outer container, never to controls inside Checkout.

    Settings
    Member Visibility