@avvyr/storefront-sdk - v0.19.0
    Preparing search index...

    Interface InitCheckoutParams

    interface InitCheckoutParams {
        cartId: string;
        companyId?: string;
        customerType?: "private" | "business";
        email?: string;
        expectedTotalIncVat?: number;
        forceNewSession?: boolean;
        paymentMethodId: string;
        postalCode?: string;
        shippingOptionId?: string;
    }
    Index
    cartId companyId? customerType? email? expectedTotalIncVat? forceNewSession? paymentMethodId postalCode? shippingOptionId?
    cartId: string
    companyId?: string

    B2B company to attribute the order to. Required when the authenticated customer belongs to more than one company (otherwise checkout responds 400 COMPANY_SELECTION_REQUIRED); optional for single-company customers. The server verifies membership before attributing the cart.

    customerType?: "private" | "business"
    email?: string
    expectedTotalIncVat?: number

    Compare-and-set on the total the shopper is looking at. When supplied, the server reprices the cart authoritatively before creating the PSP session; if the fresh total differs, no session is created and the SDK returns { status: "repriced" } with the corrected cart. Omit it and checkout behaves exactly as before.

    forceNewSession?: boolean
    paymentMethodId: string
    postalCode?: string
    shippingOptionId?: string

    Settings
    Member Visibility

    On This Page
    Properties