Component Properties

General Properties

Basic Properties

string

required

GUID that identifies your project. Found in the developer console in the detail view for a registered collection.

string

required

Identifier for your collection. Found in the developer console on the detail view for a registered collection.

Previously named clientId.

string

required

Indicates whether you’re using the staging or production environment.staging production

string

Indicates the preferred currency for the checkout.USD AUD EUR GBP HKD INR JPY KRW SGD VND

string

Indicates the preferred language for the checkout.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, Klingon

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.

string

required

The total price of the digital assets being minted (excluding gas/network fees). If the user is buying multiple digital assets, this should be the total price of all assets 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.

string

erc-721 erc-1155

string

You must include this parameter if your contract has a quantity argument indicating how many digital assets 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.

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.

Webhook Pass Through Args

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

Hosted Checkout Button
Embedded Checkout

The following properties are specific to the CrossmintPayButton:

string

Indicates the wallet address where the digital assets should be delivered. It can be a standard ethereum address or a base58 Solana address.When left empty, the digital assets will be delivered to the buyer’s . If they don’t have one, one will be created on-the-fly.

string

Indicates the email address of the buyer. When provided, Crossmint will deliver the digital assets 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.

object

Subproperties

string

Instructs the digital asset checkout to display in a specific way.popup new-tab same-window

array

Indicates which payment methods will be available.fiat ETH SOL

The following properties are specific to the CrossmintPaymentElement:

object

required

Indicates where the digital asset, and purchase receipt will be delivered.

Subproperties

string

required

Indicates the email address of the buyer, where the purchase receipt will be sent. If no wallet address is provided, Crossmint will deliver the digital asset to the buyer’s , associated with that address. If they don’t have one, one will be created on-the-fly.If a wallet address is provided, the digital asset will be delivered there directly.If you’re using emailInputOptions, this will be set automatically.

string

Indicates the wallet address where the digital asset should be delivered. It can be a standard ethereum address or a base58 Solana address.When left empty, the digital asset will be delivered to the buyer’s . If they don’t have one, one will be created on-the-fly.

object

Renders an email input field or Stripe Link.

Subproperties

boolean

Renders an email input field above the credit card checkout form. If you set this to false you must set the recipient.email property above.

string | function

Sets up and manages events.

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

<script setup lang="ts">
  function onEvent(event: CrossmintEvent) {
  console.log(event.type, event);
  }
</script>
<template>
  <CrossmintPaymentElement
  // other properties removed for brevity
  @event="onEvent"
  />
</template>

<crossmint-payment-element
  // other properties removed for brevity
  onEvent="return function onEvent(event) {
  console.log('default', event);
  }"
/>

object

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

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

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

Authentication

Tokenization (Minting)

Verifiable Credentials

Checkout

General Properties

Optional Product Specific Properties

​General Properties

​Optional Product Specific Properties

General Properties

Optional Product Specific Properties