Skip to main content
POST
/
v1-alpha1
/
checkout
/
mint
Generate Checkout Link
curl --request POST \
  --url https://staging.crossmint.com/api/v1-alpha1/checkout/mint \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "clientId": "<string>",
  "userId": "<string>",
  "emailTo": "<string>",
  "mintTo": "<string>",
  "paymentMethod": "<string>",
  "listingId": "<string>",
  "collection": {
    "title": "<string>",
    "description": "<string>",
    "photo": "<string>"
  },
  "redirect": {
    "continue": "<string>",
    "cancel": "<string>"
  },
  "mintConfig": {
    "totalPrice": "<string>"
  },
  "whPassThroughArgs": "<string>"
}
'
{
  "checkoutURL": "<string>"
}
This is an alpha API and subject to change.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
clientId
string
required

The clientId of a previously created collection

​
userId
string
required

The userId of a previously created wallet

​
emailTo
string

Target email

​
mintTo
string

Crypto address to mint the NFT to

​
paymentMethod
string

Payment method

​
listingId
string
​
collection
object
​
redirect
object
​
mintConfig
object
​
whPassThroughArgs
string

Any arguments to included in the webhook status updates

Response

Checkout url generated

​
checkoutURL
string

A URL to send the user to in order to capture payment and start the minting process