Checkout SDK
Type reference
The package ships TypeScript declarations. These are the names it exports.
Runtime
| Property | Type | Description |
|---|---|---|
| Coinfat | factory | Creates the client, the package entry point. |
| CheckoutApiError | class | The error passed to onError. |
| englishStrings | const | The base English string set to copy overrides from. |
Option types
| Property | Type | Description |
|---|---|---|
| CoinfatOptions | type | Options for Coinfat(). |
| Environment | type | "production" | "development". |
| CheckoutParams | type | Options for checkout(). |
| ButtonParams | type | Options for button(). |
| CheckoutCallbacks | type | The lifecycle callback set. |
| CheckoutTheme | type | Accent color and light/dark mode. |
| ThemeMode | type | "light" | "dark" | "auto". |
| WidgetDisplay | type | "inline" | "modal". |
| WidgetLayout | type | "wide" | "narrow". |
| CheckoutStrings | type | The full payer-facing string set. |
| CheckoutStringsOverride | type | A partial override of CheckoutStrings. |
Resource types
The invoice shapes callbacks receive.
| Property | Type | Description |
|---|---|---|
| Checkout | type | The invoice object callbacks receive. |
| CheckoutStore | type | The store's branding on a checkout. |
| StoreInvoicePayment | type | A single payment attempt. |
| StoreInvoiceStatus | type | The invoice status enum. |
| StoreInvoicePaymentStatus | type | The payment status enum. |
| Wallet | type | A payable coin. |
| WalletNetwork | type | A network for a coin. |
| Coin | type | A crypto amount. |
| Money | type | A fiat amount. |
| Currency | type | A settlement currency. |