API reference

Generated from the packages’ published type declarations, so this is exactly the surface you get when you install one. It is a lookup table: the why lives in the guides, and each package below links to the one that explains it.

Only in English

The guides are kept as English and Russian pairs. This reference is generated from the source and is English only - a half-translated API reference would be worse than an honest monolingual one. / Справочник генерируется из исходников и существует только на английском.

The checkout

What an application integrating the checkout imports.

Provider integrations

Stripe, Adyen and PayPal adapters over merchant-owned APIs. See each package for its server contract and SDK setup.

Payment plugins

One package per integration shape. Each is a reference implementation against the mock backend - none has taken a real payment.

Native apps

The contract a React Native app talks to a hosted checkout through.

@checkout-kit/webview-bridge

For plugin authors

Not needed to integrate the checkout - these are what you test a plugin of your own against.

Two things the generator cannot show you

ProviderConfigRegistry looks empty, and KnownProviderId looks like never. They are: the interface ships empty on purpose and each plugin augments it, so a host gets its provider id and config checked without importing the plugin. See Writing a payment plugin.

Branded types cannot be constructed from what you see here. CardNumber is Branded<string, "CardNumber">, and the brand is a non-exported unique symbol. Build one with createBranded, which is the only way in. See Architecture.

API reference ​

The checkout ​

Provider integrations ​

Payment plugins ​

Native apps ​

For plugin authors ​

Two things the generator cannot show you ​