Component Properties

General Properties

mintConfig

object

required

The mintConfig object should not be included for Solana collections.

mintConfig Subproperties

You must include any custom arguments required by your contract, using the exact same name.

totalPrice

string

required

The total price of the NFTs being minted (excluding gas/network fees). If the user is buying multiple NFTs, this should be the total price of all NFTs combined (price * quantity).

If your collection is set up using an external platform charging additional fees, please add them to the price. For example, if you contract charges 0.01 ETH and the provider charges 0.002 ETH, then set the price at 0.012 ETH.

type

string

erc-721 erc-1155

Your Own Quantity Argument

string

You must include this parameter if your contract has a quantity argument indicating how many NFTs to mint.

The name of this property must match the name of the argument in your mint function.

For example, if your contract has a _mintAmount argument, you will use the property name _mintAmount in the mintConfig object.

Additional Arguments

Add any additional arguments required by your contract, using the exact same name. For example, the function below would require adding a _customNumber property to mintConfig.

Solidity
  function mint(
    address to,
    uint256 _mintAmount_,
    uint256 _customNumber) public payable {
    // ...
  }

Do not pass the recipient argument (e.g. to in the example above) in the mintConfig. Crossmint auto-fills this value with the user’s address. If you wish to configure a custom recipient address, follow the instructions on the section below.

webhookPassthroughData

string | object

These arguments will be passed through via webhooks. You can use this to add attribution to a purchase (e.g. a user ID or advertising cookie).

  <CrossmintEmbeddedCheckout
    // other properties removed for brevity
    webhookPassthroughData={{
      customId: "abc123",
      orderNumber: "789def"
    }}
  />

Optional Product Specific Properties

The following properties are specific to the CrossmintPayButton:

mintTo

string

Indicates the wallet address where the NFTs should be delivered. It can be a standard ethereum address or a base58 Solana address.

When left empty, the NFTs will be delivered to the buyer’s . If they don’t have one, one will be created on-the-fly.

emailTo

string

Indicates the email address of the buyer. When provided, Crossmint will deliver the NFTs to the buyer’s , associated with that address. If they don’t have one, one will be created on-the-fly.

When left empty, Crossmint will ask the buyer for their email address and do the same as above.

Indicates the email where the user will receive the purchase receipt. It pre-fills the email input field on the buyer’s UI, and freezes it so they can’t modify it.

When left empty, Crossmint will ask the buyer for their email address.

checkoutProps

object

The following properties are specific to the CrossmintPayButton:

mintTo

string

Indicates the wallet address where the NFTs should be delivered. It can be a standard ethereum address or a base58 Solana address.

When left empty, the NFTs will be delivered to the buyer’s . If they don’t have one, one will be created on-the-fly.

emailTo

string

Indicates the email address of the buyer. When provided, Crossmint will deliver the NFTs to the buyer’s , associated with that address. If they don’t have one, one will be created on-the-fly.

When left empty, Crossmint will ask the buyer for their email address and do the same as above.

Indicates the email where the user will receive the purchase receipt. It pre-fills the email input field on the buyer’s UI, and freezes it so they can’t modify it.

When left empty, Crossmint will ask the buyer for their email address.

checkoutProps

object

The following properties are specific to the CrossmintPaymentElement:

recipient

object

required

Indicates where the NFT, and purchase receipt will be delivered.

emailInputOptions

object

Renders an email input field or Stripe Link.

onEvent

string | function

Sets up and manages events.

<CrossmintPaymentElement
  // other properties removed for brevity
  onEvent={(event) => {
  console.log(event);
  }}
/>

uiConfig

object

Used to customize UI attributes of the checkout, such as colors, typography and more. Refer to the UI customization guide for more info.

cardWalletPaymentMethods

string

Used to enable Apple Pay and Google Pay. If this parameter is not set, all methods will be enabled by default.

apple-pay google-pay none

paymentMethod

string

Indicates which currencies should be enabled. Refer to the Pay with Crypto section for more information on how to use this property.

fiat ETH SOL

Introduction

Wallets

Minting Tools

Subscriptions

Verifiable Credentials

Payments

Authentication

General Properties

Optional Product Specific Properties

Introduction

Wallets

Minting Tools

Subscriptions

Verifiable Credentials

Payments

Authentication

​General Properties

​Optional Product Specific Properties

General Properties

Optional Product Specific Properties