Sample App
View a complete working example
Why Use Checkout?
Fast Integration
Fast Integration
Mount pre-built widgets instead of building complex transaction UIs. Handle swaps, bridges, and payments with a few lines of code.
Abstracts Complexity
Abstracts Complexity
Users don’t need to understand gas, bridges, or DEXs. The widget guides them through each flow with clear UI.
Customizable
Customizable
Match your app’s theme with built-in dark/light modes and language localization.
Passport + External Wallets
Passport + External Wallets
Works with Passport, MetaMask, WalletConnect, and any EIP-1193 compatible wallet.
Prerequisites: Checkout requires wallet authentication. We recommend Passport for seamless wallet creation and login, but you can also use MetaMask, WalletConnect, or any EIP-1193 compatible wallet.
Wallet Funding: Which Flow to Use?
Choose the right funding method based on your users’ starting point:Need help choosing? See individual flow pages for detailed “when to use” guidance and platform-specific examples (TypeScript, Unity, Unreal).
Available Flows
| Flow | Description | Platforms |
|---|---|---|
| Connect | Connect wallets (Passport, MetaMask, WalletConnect) | TypeScript |
| Wallet | View balances, access other flows | TypeScript |
| Onramp | Buy crypto with fiat currency | TypeScript, Unity, Unreal |
| Swap | Exchange tokens on Immutable Chain | TypeScript, Unity, Unreal |
| Bridge | Move tokens between Ethereum and Immutable Chain | TypeScript, Unity, Unreal |
| Fund | Smart token acquisition with automatic routing | TypeScript |
| Sale | Sell NFTs with integrated payment handling | TypeScript |
Platform-Specific Implementation
- TypeScript
- Unity
- Unreal
TypeScript Quick Start
Installation
- npm
- yarn
Initialize Checkout
For complete examples with event handling and configuration options, see individual flow pages.
Configuration Options
Widget Configuration
| Option | Values | Description |
|---|---|---|
theme | 'dark', 'light' | Widget color theme |
language | 'en', 'ja', 'ko', 'zh' | UI language |
version | { major, minor, patch } | Pin to specific SDK version |
Widget Methods
All commerce widgets share these methods:| Method | Description |
|---|---|
mount(elementId, params) | Mount widget to DOM element |
update(config) | Update widget configuration |
addListener(event, callback) | Listen to events |
removeListener(event) | Remove event listener |
unmount() | Clean up widget |
Common Events
All flows emit these events:| Event | Description | Payload |
|---|---|---|
INITIALISED | Widget loaded and ready | — |
CLOSE | User clicked close button | — |
SUCCESS | Flow completed successfully | Flow-specific data |
FAILURE | Error occurred | { error } |
PROVIDER_UPDATED | Wallet provider changed | { provider } |
Integration Guides
Build a Marketplace
Complete marketplace with wallet funding
Build a Game
Start with game basics first
Passport Integration
Wallet creation and authentication
Get API Keys
Setup Hub credentials