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

    Interface CheckoutOptions

    Immutable and initial configuration for one Checkout controller.

    Changing orderId, timeout, or title requires a new controller. Use CheckoutController.update for locale and theme changes after creation.

    interface CheckoutOptions {
        appearance?: CheckoutAppearance;
        locale?: string;
        orderId: string;
        timeout?: number;
        title?: string;
    }
    Index
    appearance?: CheckoutAppearance

    Initial color-scheme preferences for the hosted experience.

    locale?: string

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

    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.

    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.