Skip to content

Main Navigation Guide Packages npm API Demo UI Gallery

English

English

Appearance

Sidebar Navigation

API reference

The checkout

@checkout-kit/core

Interfaces

ActionRunner

CallOptions

CardBrandRule

CheckoutEngine

CheckoutEngineConfig

CheckoutSnapshot

CheckoutTelemetryEvent

CreateIntentInput

FormatMoneyOptions

LoadedProvider

Logger

Money

MountHandle

ParseExpiryOptions

PaymentError

PaymentIntent

PaymentProvider

PaymentProviderInstance

PayRequest

PendingCheckout

ProviderCapabilities

ProviderConfigRegistry

ProviderContext

ProviderRegistration

ProviderRegistry

ProviderRegistryConfig

ReadonlyStore

RunActionOptions

RunnerContext

RunnerRegistry

StorageAdapter

Store

ValidateCardNumberOptions

Type Aliases

ActionEvidence

ActionSurface

AnyActionRunner

AuthenticationKind

Branded

CardBrand

CardExpiration

CardholderIssue

CardholderResult

CardNumber

CardNumberIssue

CardNumberResult

CheckoutPhase

CompletionSpec

ConfigOf

CvcCode

CvcIssue

CvcResult

EngineEvent

EngineEventOf

EngineEventType

ExpiryIssue

ExpiryResult

KnownProviderId

MachineEvent

PaymentAction

PaymentActionKind

PaymentInstrument

PaymentInstrumentKind

PaymentResult

PaymentStatus

PaymentUiState

ProviderModule

Variables

CARD_BRANDS

clearPendingCheckout

createCheckout

createProviderRegistry

createRunnerRegistry

createStore

cvcLengthsFor

defineProvider

detectCardBrand

formatCardNumber

formatExpiry

formatMoney

isBusyPhase

isSettledPhase

isTerminalResult

last4

luhn

maskCardNumber

maxCardNumberLength

memoryStorage

minorUnitsPerMajor

nextPhase

observeCheckout

onlyDigits

parseExpiry

PENDING_CHECKOUT_KEY

PHASE_TO_UI_STATE

readPendingCheckout

silentLogger

toCheckoutTelemetryEvent

UNKNOWN_CARD_BRAND

validateCardholder

validateCardNumber

validateCvc

writePendingCheckout

Functions

createBranded

@checkout-kit/react

Interfaces

CheckoutProviderProps

CheckoutRootProps

PaymentActionHostProps

PaymentStateInput

UseCheckoutResult

Variables

CheckoutProvider

CheckoutRoot

PaymentActionHost

useCheckout

useCheckoutEngine

useCheckoutSelector

useCheckoutSnapshot

usePaymentState

@checkout-kit/ui

Interfaces

ActionFrameProps

AddressFieldsProps

AddressLabels

AddressValue

AuthenticationStateProps

BadgeProps

ButtonProps

CardBrandIndicatorProps

CardFieldsProps

CardFieldsRowProps

CardholderInputProps

CardNumberInputProps

CheckboxProps

CheckoutAppearance

CheckoutFormProps

CheckoutLayoutProps

ContactFieldsProps

ContactLabels

ContactValue

CopyButtonProps

CountdownProps

CvcInputProps

DetailItemProps

DetailListProps

DialogProps

DisclosureProps

DividerProps

ErrorTextProps

ExpressCheckoutProps

FailureStateProps

FieldControlProps

FieldGroupProps

FieldProps

FieldRowProps

IconButtonProps

InputGroupProps

InputProps

MoneyProps

MoneyValue

OptionCardGroupProps

OptionCardProps

OrderLine

OrderSummaryProps

PanelProps

PaymentButtonProps

PaymentMethodOption

PaymentMethodSelectorProps

PaymentStatusMessages

PaymentStatusProps

ProcessingStateProps

PromoCodeInputProps

PromoCodeLabels

ReceiptProps

SavedInstrument

SavedInstrumentLabels

SavedInstrumentListProps

SectionHeadingProps

SectionProps

SelectOption

SelectProps

SkeletonProps

SkeletonTextProps

SpinnerProps

StateIconProps

StatusTextProps

Step

StepsProps

StickyActionsProps

SuccessStateProps

TabProps

TabsProps

TextareaProps

TrustStripProps

ValidationProblem

ValidationSummaryProps

VisuallyHiddenProps

Type Aliases

ActionFrameVariant

AddressErrors

AddressFieldName

ButtonVariant

ContactErrors

ContactFieldName

FailureTone

HeadingLevel

Variables

ActionFrame

ADDRESS_LABELS

AddressFields

appearanceToAttributes

appearanceToStyle

AuthenticationState

Badge

Button

CardBrandIndicator

CardFields

CardFieldsRow

CardholderInput

CardNumberInput

Checkbox

CheckoutForm

CheckoutLayout

CONTACT_LABELS

ContactFields

CopyButton

Countdown

CvcInput

cx

DetailItem

DetailList

Dialog

Disclosure

Divider

ErrorText

ExpiryInput

ExpressCheckout

FailureIcon

FailureState

Field

FieldGroup

FieldRow

IconButton

Input

InputGroup

Money

NeutralIcon

NEW_INSTRUMENT_ID

OptionCard

OptionCardGroup

OrderSummary

Panel

PAYMENT_STATUS_MESSAGES

PaymentButton

PaymentMethodSelector

PaymentStatus

ProcessingState

PROMO_CODE_LABELS

PromoCodeInput

Receipt

SAVED_INSTRUMENT_LABELS

SavedInstrumentList

Section

SectionHeading

Select

SILENT_STATES

Skeleton

SkeletonText

Spinner

StatusText

Steps

StickyActions

SuccessIcon

SuccessState

Tab

Tabs

Textarea

TrustStrip

ValidationSummary

VisuallyHidden

@checkout-kit/runtime-browser

Interfaces

BrowserRuntime

BrowserRuntimeOptions

CollectFieldsRunnerOptions

DisplayRunnerOptions

DisplayRunnerText

PaymentUrlPolicy

PostMessageExpectation

RedirectRunnerOptions

SdkAdapter

SdkHandoffRunnerOptions

Type Aliases

PaymentUrlUse

Platform

Variables

applyPlatform

awaitPostMessage

createBrowserRuntime

createCollectFieldsRunner

createDisplayRunner

createMount

createRedirectRunner

createSdkHandoffRunner

detectPlatform

sessionStorageAdapter

validateMessageOrigin

validatePaymentUrl

Provider integrations

@checkout-kit/provider-stripe

Interfaces

StripeClient

StripeConfig

StripePaymentIntent

StripeSdkAdapter

Type Aliases

StripeStatus

Variables

createStripeProvider

createStripeSdkAdapter

PROVIDER_ID

stripeProvider

@checkout-kit/provider-adyen

Interfaces

AdyenAction

AdyenConfig

AdyenPayment

Variables

adyenProvider

createAdyenProvider

PROVIDER_ID

@checkout-kit/provider-paypal

Interfaces

PayPalConfig

PayPalOrder

Type Aliases

PayPalCaptureStatus

PayPalOrderStatus

Variables

createPayPalProvider

payPalProvider

PROVIDER_ID

Payment plugins

@checkout-kit/provider-psp

Interfaces

PspConfig

Variables

createPspProvider

PROVIDER_ID

pspProvider

@checkout-kit/provider-acquiring

Interfaces

AcquiringConfig

Variables

acquiringProvider

createAcquiringProvider

PROVIDER_ID

@checkout-kit/provider-hpp

Interfaces

HostedPageConfig

Variables

createHostedPageProvider

hostedPageProvider

PROVIDER_ID

@checkout-kit/provider-hosted-fields

Interfaces

HostedFieldsConfig

Variables

createHostedFieldsProvider

hostedFieldsProvider

PROVIDER_ID

@checkout-kit/provider-wallet

Interfaces

WalletConfig

Variables

createWalletProvider

PROVIDER_ID

walletProvider

@checkout-kit/provider-bank-transfer

Interfaces

BankTransferConfig

Variables

bankTransferProvider

createBankTransferProvider

PROVIDER_ID

Native apps

@checkout-kit/webview-bridge

Interfaces

BridgeEnvelope

BridgeTarget

PaymentActionPayload

PaymentCanceledPayload

PaymentDeclinedPayload

PaymentFailedPayload

PaymentHeightPayload

PaymentIntentCreatedPayload

PaymentReadyPayload

PaymentStateChangedPayload

PaymentSucceededPayload

WebViewBridge

WebViewBridgeOptions

Type Aliases

BridgeCommand

BridgeCommandType

BridgeEvent

BridgeEventType

ParseResult

Variables

BRIDGE_VERSION

createWebViewBridge

parseBridgeCommand

parseBridgeEvent

For plugin authors

@checkout-kit/testing

Type Aliases

CardOutcome

CardScenario

DeclineCode

Variables

declineMessage

DEFAULT_OUTCOME

outcomeOf

SCENARIO_CARDS

TEST_CARDS

@checkout-kit/conformance

Interfaces

ConformanceSuite

Type Aliases

ConformanceCase

Variables

describeProviderContract

On this page

@checkout-kit/core / createCheckout

Variable: createCheckout

ts

const createCheckout: (config) => CheckoutEngine;

Parameters

Parameter	Type
`config`	`CheckoutEngineConfig`

Returns

CheckoutEngine

Edit this page on GitHub

Pager

Previous pageclearPendingCheckout

Next pagecreateProviderRegistry

Apache-2.0 · Headless engine, provider adapters and runnable examples.

© 2026 pavel-labs