POST
/
v1-alpha1
/
wallets
/
transfer

This is an alpha API and subject to change.

This API enables you to initiate a transfer request. Wallets that are created with email can be logged into via Crossmint.com by the user who owns that email address.

Requests to transfer NFTs within wallets created with email must be approved by the user. Upon calling this API an email will be sent to the user enabling them to approve or decline the transfer.

Authorizations

X-API-KEY
string
headerrequired

Obtained in the Crossmint developer console

Body

application/json
chain
enum<string>
default: ethereum

Specify the name of the blockchain

Available options:
arbitrum,
arbitrumnova,
arbitrum-sepolia,
base,
base-sepolia,
bsc,
ethereum,
ethereum-sepolia,
optimism,
optimism-sepolia,
polygon,
polygon-amoy,
shape,
shape-sepolia,
skale-nebula,
skale-nebula-testnet,
solana,
soneium-minato-testnet,
zkyoto,
zora,
zora-sepolia
from
string

The wallet address for the current owner

to
string

The wallet address the token should be transferred to

contractAddress
string

The contract address of the token to transfer

tokenId
string

The numeric tokenId of the token to be transferred

quantity
string

Required for ERC-1155 only, not relevant for ERC-721 tokens

Response

202 - application/json
message
string

A message indicating the result.

actionId
string

An ID that can be used to poll the actions API.