@checkout-kit/core / CheckoutEngine

Interface: CheckoutEngine

Properties

Property	Modifier	Type
providerIds	readonly	readonly string[]

Methods

abort()

abort(reason?): Promise<PaymentResult>;

Parameters

Parameter	Type
reason?	"user" | "timeout"

Returns

Promise<PaymentResult>

---

fetchIntent()

fetchIntent(intentId, providerId?): Promise<PaymentIntent>;

Parameters

Parameter	Type
intentId	string
providerId?	string

Returns

Promise<PaymentIntent>

---

getSnapshot()

getSnapshot(): CheckoutSnapshot;

Returns

CheckoutSnapshot

---

hydrate()

hydrate(params?): Promise<PaymentResult | null>;

Pick up a payment left in flight by a full-page redirect.

Parameters

Parameter	Type
params?	Readonly<Record<string, string>>

Returns

Promise<PaymentResult | null>

---

on()

on<T>(type, handler): () => void;

Type Parameters

Type Parameter
T extends | "phase_changed" | "provider_changed" | "intent_created" | "action_required" | "action_started" | "action_finished" | "result" | "error"

Parameters

Parameter	Type
type	T
handler	(event) => void

Returns

() => void

---

pay()

pay(request): Promise<PaymentResult>;

Parameters

Parameter	Type
request	PayRequest

Returns

Promise<PaymentResult>

---

prepare()

prepare(input): Promise<void>;

Create the intent ahead of submission. A no-op for providers that do not need it.

Parameters

Parameter	Type
input	CreateIntentInput

Returns

Promise<void>

---

reset()

reset(): void;

Returns

void

---

resumeWith()

resumeWith(evidence): Promise<PaymentResult>;

Continue with evidence the host obtained itself (e.g. from a return URL).

Parameters

Parameter	Type
evidence	ActionEvidence

Returns

Promise<PaymentResult>

---

runPendingAction()

runPendingAction(options?): Promise<PaymentResult>;

Execute the pending action and hand its evidence to the provider.

Parameters

Parameter	Type
options?	RunActionOptions

Returns

Promise<PaymentResult>

---

subscribe()

subscribe(listener): () => void;

Parameters

Parameter	Type
listener	() => void

Returns

() => void

---

useProvider()

useProvider(providerId): Promise<void>;

Parameters

Parameter	Type
providerId	string

Returns

Promise<void>