Interface CreateOptions

Configuration used to create Checkout.

Checkout Session Private Preview

interface CreateOptions {
    clientSecret: string;
    returnURL: string;
    defaults?: Defaults;
    merchantDisplayName?: string;
    style?: UserInterfaceStyle;
    paymentElement?: PaymentElementConfiguration;
    currencySelectorElement?: CurrencySelectorElementConfiguration;
}

Properties

clientSecret returnURL defaults? merchantDisplayName? style? paymentElement? currencySelectorElement?

Properties

clientSecret

clientSecret: string

The Checkout Session client secret.

returnURL

returnURL: string

A URL that redirects back to your app after payment authentication.

Optionaldefaults

defaults?: Defaults

Customer information already known by your app.

OptionalmerchantDisplayName

merchantDisplayName?: string

Customer-facing business name.

Optionalstyle

style?: UserInterfaceStyle

Overrides the light or dark appearance.

OptionalpaymentElement

paymentElement?: PaymentElementConfiguration

Configuration for the Checkout-owned Payment Element.

OptionalcurrencySelectorElement

currencySelectorElement?: CurrencySelectorElementConfiguration

Configuration for Currency Selector Element. Provide this configuration to enable the element when Adaptive Pricing is available.

Settings

Member Visibility

On This Page

Properties