Create a fully customized checkout experience with crypto payments
polygon-amoy
testnet.
collectionId
ready.
orders.create
, orders.update
, and orders.read
scopes enabled. More info on creating API keys here.POST
https://staging.crossmint.com/api/2022-06-09/orders
Refer to the complete create order API reference here.
Example Response
payerAddress
has been included, however if your user has not yet connected their wallet
you may omit this field, allow them to connect their wallet after creating the order, and submit the payerAddress
at a later time.quote
phase and is awaiting a recipient
to be set. Setting a recipient does not mean that we are sending the NFT to them; it is merely used to verify that the intended recipient is a valid address, before beginning gathering payment info.
orderId
returned from your API response to find your incomplete order object and status.
recipient
is passed as an email, Crossmint will automatically create a custodial wallet associated with this email, that can be accessed by logging in to the (staging) Crossmint Wallet or from your website if you're using whitelabel wallets.
PATCH
https://staging.crossmint.com/api/2022-06-09/orders/<orderId>
recipient
. You can also update
multiple properties in the same call. Available properties for update include recipient
, locale
, and the
payment
object.Example Response
serializedTransaction
property. This is a unique identifier let’s Crossmint know exactly which order you are updating.
Anytime you update an order you must use the returned serializedTransaction
property.lineItems
array which contains the metadata and a quote for each line item. Within a quote, a detailed breakdown of its charges can be found.
serializedTransaction
returned in the purchase preview from the previous step. The serializedTransaction
needs to be structured into a transaction object, which can then be passed to a crypto payment prompter, like viem’s sendTransaction
or wagmi’s sendTransactionAsync
.
Whichever method you use, it should open the user’s default wallet extension in the browser and allow the user to complete the cross-chain payment.
serializedTransaction
property returned in your
previous API call into the app below. This will allow you to sign and send the transaction.GET
https://staging.crossmint.com/api/2022-06-09/orders/<orderId>