showCheckout

Function to show the cryptocurrency checkout modal, allowing users to select their local currency and specify the token to top up their wallet.

note

This is a paid feature and the minimum pricing plan to use this SDK in a production environment is the Scale Plan. You can use this feature in Web3Auth Sapphire Devnet network for free.

info

Please note that this function doesn't work for external wallet logins. It only works for social login embedded wallets.

Usage

await web3auth.showCheckout({
  show: true,
}) // Opens the TopUp modal

Parameters

Name	Description
receiveWalletAddress?	Specifies the recipient's address. By default, it is set to the currently connected address.
tokenList?	Specifies the tokens to display in the list. By default, all tokens are shown. Use the ticker name to specify which tokens to display, such as [USDC, USDT, ETH]. Please checkout the coverage details for full list of supported networks and tokens.
fiatList?	Specifies the available fiat currencies enabled for purchase. Use the currency acronym to define which fiat currencies to display, such as [USD, SGD, INR, JPY]. Please checkout the coverage details for full list of supported currencies.
show	Determines whether the checkout UI is displayed. This can be used to programmatically control its visibility.

Supported cryptocurrencies

To checkout the supported cryptocurrencies and networks, checkout the coverage documentation.