POST
/
2025-06-09
/
wallets
/
{walletLocator}
/
tokens
/
{tokenLocator}
/
transfers
Transfer Token
curl --request POST \
  --url https://staging.crossmint.com/api/2025-06-09/wallets/{walletLocator}/tokens/{tokenLocator}/transfers \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '{
  "recipient": "0x1234567890123456789012345678901234567890",
  "signer": "external-wallet:0xdeadbeef",
  "amount": "42.69",
  "memo": {
    "type": "text",
    "value": "Hello, world!"
  }
}'
{
  "chainType": "evm",
  "walletType": "smart",
  "params": {
    "calls": [
      {
        "address": "<string>",
        "functionName": "<string>",
        "abi": [
          {
            "type": "error",
            "inputs": [
              "<any>"
            ],
            "name": "<string>"
          }
        ],
        "args": [
          "<any>"
        ],
        "value": "0"
      }
    ],
    "chain": "abstract",
    "signer": {
      "type": "external-wallet",
      "address": "<string>",
      "locator": "<string>"
    }
  },
  "onChain": {
    "userOperation": {
      "sender": "<string>",
      "nonce": "<string>",
      "callData": "<string>",
      "callGasLimit": "<string>",
      "verificationGasLimit": "<string>",
      "preVerificationGas": "<string>",
      "maxFeePerGas": "<string>",
      "maxPriorityFeePerGas": "<string>",
      "paymaster": "<string>",
      "paymasterVerificationGasLimit": "<string>",
      "paymasterData": "<string>",
      "paymasterPostOpGasLimit": "<string>",
      "signature": "<string>",
      "factory": "<string>",
      "factoryData": "<string>"
    },
    "userOperationHash": "<string>",
    "txId": "<string>",
    "explorerLink": "<string>"
  },
  "id": "<string>",
  "status": "awaiting-approval",
  "approvals": {
    "pending": [
      {
        "signer": {
          "type": "external-wallet",
          "address": "<string>",
          "locator": "<string>"
        },
        "message": "<string>"
      }
    ],
    "submitted": [
      {
        "signature": "<string>",
        "submittedAt": "2024-01-01T00:00:00.000Z",
        "signer": {
          "type": "external-wallet",
          "address": "<string>",
          "locator": "<string>"
        },
        "message": "<string>",
        "metadata": {
          "deviceInfo": "<string>",
          "ipAddress": "<string>",
          "userAgent": "<string>"
        }
      }
    ],
    "required": 123
  },
  "createdAt": "2024-01-01T00:00:00.000Z",
  "completedAt": "2024-01-01T00:00:00.000Z",
  "error": {
    "reason": "build_failed",
    "message": "<string>"
  },
  "sendParams": {
    "token": "<string>",
    "params": {
      "amount": "<string>",
      "recipient": "<string>",
      "recipientAddress": "<string>"
    }
  }
}

Headers

​
X-API-KEY
string
required

API key required for authentication

​
x-idempotency-key
string

Unique key to prevent duplicate transaction creation

Path Parameters

​
walletLocator
string
required

A wallet locator can be of the format:

  • <walletAddress>
  • email:<email>:<chainType>[:<walletType>] (walletType defaults to 'smart')
  • userId:<userId>:<chainType>[:<walletType>] (white label user example)
  • phoneNumber:<phoneNumber>:<chainType>[:<walletType>]
  • twitter:<handle>:<chainType>[:<walletType>]
  • x:<handle>:<chainType>[:<walletType>]
  • me:<chainType>[:<walletType>] (Use when calling from the client side with a client API key)
​
tokenLocator
string
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

Body

application/json

Base fields for all token transfers

​
recipient
string
required

An address locator that supports different types of recipients. It can be of the format:

  • <address> (wallet address)
  • chain:address (e.g. ethereum:0x1234...)
  • address:<blockchain_address>[:chain]
  • email:<email_address>[:chain]
  • phoneNumber:<phone_number>[:chain]
  • twitter:<twitter_handle>[:chain]
  • x:<twitter_handle>[:chain]
  • userId:<user_id>[:chain]
Example:

"0x1234567890123456789012345678901234567890"

​
signer
string

Optional signer locator. Defaults to admin signer

Example:

"external-wallet:0xdeadbeef"

​
amount
string

Amount of tokens to transfer (in decimal value)

Example:

"42.69"

​
memo
object

Memo for the transaction. Only supported for Stellar

Example:
{ "type": "text", "value": "Hello, world!" }

Response

201 - application/json

The transaction has been successfully created.

Complete transaction response including status, signing requirements, and wallet type specific data

​
chainType
enum<string>
required

The blockchain type of the wallet

Available options:
evm,
solana,
aptos,
sui,
stellar
​
walletType
enum<string>
required

The wallet type (smart or mpc)

Available options:
smart,
mpc
​
params
object
required
​
onChain
object
required

Transaction data specific to EVM smart wallets

​
id
string
required

Unique identifier for the transaction

​
status
enum<string>
required

Current status of the transaction

Available options:
awaiting-approval,
pending,
failed,
success
​
createdAt
required

ISO timestamp when the transaction was created ISO 8601 formatted timestamp

Example:

"2024-01-01T00:00:00.000Z"

​
approvals
object

Complete approval data including requirements, pending and submitted signatures

​
completedAt

ISO timestamp when the transaction reached finality ISO 8601 formatted timestamp

Example:

"2024-01-01T00:00:00.000Z"

​
error
object

Error message if the transaction fails after submission

​
sendParams
object