Sign in

Transfer Token

Changed on

Sends a token of any type from this wallet to a recipient

post/unstable/wallets/{walletLocator}/tokens/{tokenLocator}/transfers

Request

  • Base URL: https://staging.crossmint.com/api
  • URL: https://staging.crossmint.com/api/unstable/wallets/{walletLocator}/tokens/{tokenLocator}/transfers
  • Auth: none declared. Required headers: X-API-KEY

Path parameters

walletLocatorstring required

A wallet locator can be of the format:

  • <walletAddress>
  • email:<email>:<walletType>
  • userId:<userId>:<walletType>
  • userId:<userId>:<walletType> (white label user example)
  • phoneNumber:<phoneNumber>:<walletType>
  • twitter:<handle>:<walletType>
  • x:<handle>:<walletType>
  • me:<walletType> (Use when calling from the client side with a client API key)
tokenLocatorstring required

A token locator that supports native tokens, fungible tokens, and NFTs across different chains. It can be of the format:

  • chain:address[:tokenId]
  • chain:currency
  • chain:address

Headers

X-API-KEYstring required

API key required for authentication

x-idempotency-keystring

Unique key to prevent duplicate transaction creation

Request body

recipientstring required
signerstring

Optional signer locator. Defaults to admin signer

amountstring

Amount of tokens to transfer (in decimal format)

Example request

{
  "signer": "evm-keypair:0xdeadbeef",
  "amount": "42.69"
}

Response

The transaction has been successfully created.

OR
OR
OR

Example response

{
  "error": {
    "revert": {
      "type": "contract_call",
      "reason": "ERC20: transfer amount exceeds balance"
    }
  }
}

Changes

  • 3983c72e453aRevision changes
    • info

      removed the astar-zkevm enum value from the // response property for the response status

    • info

      removed the base-goerli enum value from the // response property for the response status

    • info

      removed the coti enum value from the // response property for the response status

    • info

      removed the coti-testnet enum value from the // response property for the response status

    • info

      removed the ethereum-goerli enum value from the // response property for the response status

    • info

      removed the hedera enum value from the // response property for the response status

    • info

      removed the hedera-testnet enum value from the // response property for the response status

    • info

      removed the lightlink enum value from the // response property for the response status

    • info

      removed the lightlink-pegasus enum value from the // response property for the response status

    • info

      removed the mode enum value from the // response property for the response status

    • info

      removed the mode-sepolia enum value from the // response property for the response status

    • info

      removed the optimism-goerli enum value from the // response property for the response status

    • info

      removed the plume enum value from the // response property for the response status

    • info

      removed the plume-testnet enum value from the // response property for the response status

    • info

      removed the polygon-mumbai enum value from the // response property for the response status

    • info

      removed the rari enum value from the // response property for the response status

    • info

      removed the rari-testnet enum value from the // response property for the response status

    • info

      removed the soneium enum value from the // response property for the response status

    • info

      removed the soneium-minato-testnet enum value from the // response property for the response status

    • info

      removed the u2u-nebulas enum value from the // response property for the response status

    • info

      removed the u2u-solaris enum value from the // response property for the response status

    • info

      removed the viction enum value from the // response property for the response status

    • info

      removed the viction-testnet enum value from the // response property for the response status

    • info

      removed the world-chain enum value from the // response property for the response status

    • info

      removed the world-chain-sepolia enum value from the // response property for the response status

    • info

      removed the xai enum value from the // response property for the response status

    • info

      removed the xai-sepolia-testnet enum value from the // response property for the response status

    • info

      removed the zenchain-testnet enum value from the // response property for the response status

    • info

      removed the zkatana enum value from the // response property for the response status

    • info

      removed the zkyoto enum value from the // response property for the response status

    • info

      removed the zora-goerli enum value from the // response property for the response status

  • 19493bf640a4Revision changes
    • warning

      added the new arc enum value to the // response property for the response status

    • warning

      added the new celo enum value to the // response property for the response status

    • warning

      added the new celo-sepolia enum value to the // response property for the response status