Class StripeSdkProvider

Handles the loading and initialization of the Stripe SDK. It's loaded and initialized only when required and re-initialized when its configuration options change.

Index

Constructors

Properties

hasError radarSession? radarSessionPromise? stripe

Accessors

configureOptions isRadarEnabled isSdkRequired

Methods

dispose init initRadarSession

Constructors

constructor

new StripeSdkProvider(args: { api: WidgetApi }): StripeSdkProvider
Parameters
- args: { api: WidgetApi }
Returns StripeSdkProvider

Properties

hasError

hasError: boolean = false

`Optional`radarSession

radarSession?: StripeRadarSession

`Optional`radarSessionPromise

radarSessionPromise?: Promise<void>

stripe

stripe: Stripe | undefined

Accessors

configureOptions

get configureOptions(): {
    stripeAccount: string
    | undefined;
    stripePublicKey: string | undefined;
}
Computed getter which returns all options required to initialize the Stripe SDK instance. If it changes, Stripe SDK instance must be re-initialized.

Returns { stripeAccount: string | undefined; stripePublicKey: string | undefined }

isRadarEnabled

get isRadarEnabled(): boolean
Returns whether Stripe Radar is enabled. It may be enabled only for those payment methods, which are handled by Stripe provider.

Returns boolean

isSdkRequired

get isSdkRequired(): boolean
Returns whether Stripe SDK is required to be loaded and (re)initialized.

Returns boolean

Methods

dispose

dispose(): void
Returns void

init

init(): void
Returns void

initRadarSession

initRadarSession(): Promise<void>
Returns Promise<void>