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

    Interface CheckoutProps

    Props for Checkout.

    orderId, timeout, and title identify the embedded experience. Changing one replaces the underlying controller. appearance and locale update the existing controller without discarding payer progress.

    interface CheckoutProps {
        appearance?: CheckoutAppearance;
        className?: string;
        locale?: string;
        onCompleted?: (event: CheckoutCompletedEvent) => void;
        onError?: (event: CheckoutErrorEvent | Error) => void;
        onEvent?: (event: CheckoutEvent) => void;
        onReady?: (event: CheckoutReadyEvent) => void;
        orderId: string;
        style?: CSSProperties;
        timeout?: number;
        title?: string;
    }

    Hierarchy

    • CheckoutOptions
      • CheckoutProps
    Index
    appearance? className? locale? onCompleted? onError? onEvent? onReady? orderId style? timeout? title?
    appearance?: CheckoutAppearance

    Initial color-scheme preferences for the hosted experience.

    className?: string

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

    locale?: string

    BCP 47 locale preference, such as en-GH. Unsupported translations may fall back to an Inttegro-supported locale.

    onCompleted?: (event: CheckoutCompletedEvent) => 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.

    onError?: (event: CheckoutErrorEvent | Error) => void

    Called for loader/mount errors and sanitized hosted errors. Use error instanceof InttegroCheckoutError or check for an event type before reading framework-independent details.

    onEvent?: (event: CheckoutEvent) => void

    Called for every sanitized lifecycle event, including events above.

    onReady?: (event: CheckoutReadyEvent) => void

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

    orderId: string

    Client-safe reference for the finalized Inttegro Order being paid.

    Create and finalize the Order on your server, then send only this reference to the browser. The payer may complete the Order but cannot use Checkout to change its commercial terms. Never place an Inttegro secret API key in this object or anywhere else in browser code.

    style?: CSSProperties

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

    timeout?: number

    Milliseconds to wait for the hosted checkout to emit CheckoutReadyEvent. Accepts 1,000–60,000 ms and defaults to 15,000 ms. A timeout rejects CheckoutController.mount and returns the controller to idle, so a deliberate retry can mount it again.

    title?: string

    Accessible title assigned to the hosted iframe. Defaults to Checkout. Describe the frame's purpose; this value is not visible payment-page copy.

    Settings
    Member Visibility

    On This Page
    Properties