Advanced Topics
Component Properties
Understand the properties available on the Checkout
If you are using our previous version of embedded checkout, please refer to the old component properties
guide
Common Properties
These properties are shared between both the Embedded and Hosted checkout components.
Specifies the NFTs to purchase. Can be a single item or array of items.
lineItems properties
lineItems properties
Collection identifier in one of these formats:
crossmint:<_YOUR_COLLECTION_ID_>[:_TEMPLATE_ID_]- For collections created in Crossmint Console- Template ID is optional and requires template minting to be enabled
- If template minting is disabled and a template ID is provided, the mint will fail with an error
<blockchain>:<contract-address>- For collections using direct contract addresses (e.g.,polygon-amoy:0xF3d2d7b5666f579DcE385b2d53c54AB1b09Ef563)
When using template minting, append the templateId to the collection locator:
crossmint:collectionId:templateId.
Template minting must be enabled in the Crossmint Console or the mint will fail with an error.
See the Mint to Specific Template guide for details on enabling template minting and error handling.For secondary sales (buying existing NFTs). Token identifier in one of these formats:
- EVM chains:
<blockchain>:<contractAddress>:<tokenId> - Solana:
<blockchain>:<tokenAddress>
Using
tokenLocator doesn’t require registering the collection in Crossmint Console.Use either
collectionLocator (for primary sales) or tokenLocator (for secondary sales), not both.Arguments passed to your contract’s mint function:
Solidity
Parameter names must match your contract’s function arguments exactly.
Do not pass the recipient argument (e.g.
to) in callData. Crossmint handles this automatically.Configuration for payment methods.
payment properties
payment properties
Crypto payment settings:
Card & wallet payment settings:
Embedded Checkout supports additional payment method customization. See our Embedded Checkout payment methods guide for details.
Optional email address where purchase receipt will be sent
Sets the default payment tab:
fiat or cryptoDelivery details for the NFTs. You must specify either email OR wallet address, not both:
When not provided, user will be prompted during checkout.
recipient properties
recipient properties
Sets the checkout interface language.
en-US de-DE es-ES fr-FR it-IT ja-JP ko-KR pt-PT ru-RU th-TH tr-TR uk-UA vi-VN zh-CN zh-TW KlingonSpecific Properties & Hooks
The hosted checkout button is only available for React applications. For full customization options, please use our Headless Checkout.
CrossmintHostedCheckout component:Customization options for the hosted checkout. See our UI Customization guide for complete details.Notable appearance options:
- Display mode:
display: "popup" | "new-tab"(default: “popup”) - Background overlay:
overlay.enabled: falseto disable the gray background - Button theme:
theme.button: "light" | "dark" | "crossmint"(default: “light”) - Checkout theme:
theme.checkout: "light" | "dark"(default: “light”)