Transfer Token

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

POST /2025-06-09/wallets/{walletLocator}/tokens/{tokenLocator}/transfers

Transfer Token

cURL

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 '
{
  "amount": "42.69",
  "recipient": "CROSSMINT",
  "memo": {
    "type": "text",
    "value": "Hello, world!"
  },
  "signer": "external-wallet:0xdeadbeef",
  "transactionType": "direct"
}
'

201

{
  "createdAt": 123,
  "id": "<string>",
  "onChain": {
    "transaction": "<string>",
    "explorerLink": "<string>",
    "lastValidBlockHeight": 123,
    "proxiedTxId": "<string>",
    "txId": "<string>"
  },
  "params": {
    "feeConfig": {
      "amount": "<string>",
      "feePayer": "<string>"
    },
    "transaction": "<string>",
    "requiredSigners": [
      {
        "address": "<string>",
        "locator": "<string>",
        "type": "api-key"
      }
    ],
    "signer": {
      "address": "<string>",
      "locator": "<string>",
      "type": "api-key"
    }
  },
  "approvals": {
    "pending": [
      {
        "quorumApprovals": {
          "pending": [
            {
              "message": "<string>",
              "signer": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              }
            }
          ],
          "remaining": 123,
          "submitted": [
            {
              "message": "<string>",
              "signature": "<string>",
              "signer": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              },
              "submittedAt": 123
            }
          ],
          "threshold": 123
        },
        "signer": {
          "locator": "<string>",
          "type": "quorum"
        }
      }
    ],
    "submitted": [
      {
        "quorumApprovals": {
          "pending": [
            {
              "message": "<string>",
              "signer": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              }
            }
          ],
          "remaining": 123,
          "submitted": [
            {
              "message": "<string>",
              "signature": "<string>",
              "signer": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              },
              "submittedAt": 123
            }
          ],
          "threshold": 123
        },
        "signer": {
          "locator": "<string>",
          "type": "quorum"
        }
      }
    ],
    "required": 123
  },
  "completedAt": 123,
  "error": {
    "message": "<string>",
    "reason": "program_error",
    "logs": "<unknown>",
    "revertData": {}
  },
  "fees": {
    "actual": "<unknown>",
    "billed": {
      "usd": 123
    },
    "billing": {},
    "estimate": "<unknown>"
  },
  "sendParams": {
    "params": {
      "recipient": "<string>",
      "recipientAddress": "<string>",
      "amount": "<string>"
    },
    "token": "<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>][:alias:<alias>] (walletType defaults to 'smart')
• userId:<userId>:<chainType>[:<walletType>][:alias:<alias>] (white label user example)
• phoneNumber:<phoneNumber>:<chainType>[:<walletType>][:alias:<alias>]
• twitter:<handle>:<chainType>[:<walletType>][:alias:<alias>]
• x:<handle>:<chainType>[:<walletType>][:alias:<alias>]
• me:<chainType>[:<walletType>][:alias:<alias>] (Use when calling from the client side with a client API key)
• chainType[:<walletType>]:alias:<alias>

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

Option 1

Option 2

Base fields for all token deposits

amount · string · required

Amount of tokens to transfer (in decimal value)

Pattern: ^\d+(?:\.\d*)?$

Example:

"42.69"

recipient · string · required

Example:

"CROSSMINT"

fees · object

Optional per-transaction fee configuration override. When omitted, the project default is used.

Show child attributes

memo · object

Memo for the transaction. Only supported for Stellar

Option 1

Option 2

Option 3

Show child attributes

Example:

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

signer · string

Optional signer locator. Defaults to admin signer

Example:

"external-wallet:0xdeadbeef"

transactionType · Direct transaction · enum<string> Onramp transaction · enum<string> Regulated transfer transaction · enum<string> · default: direct

Specifies the type of transaction. Choose 'direct' for standard interactions or 'regulated-transfer' for operations requiring compliance checks.

Available options: direct

Response

201 - application/json

The transaction has been successfully created.

Solana Smart Wallet

Solana MPC Wallet

EVM MPC Wallet

EVM Smart Wallet

Stellar Smart Wallet

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

chainType · enum<string> · required

The blockchain type of the wallet

Available options: aptos, evm, solana, stellar, sui

createdAt · number string · required

ISO timestamp when the transaction was created

id · string · required

Unique identifier for the transaction

onChain · Solana custodial wallet transaction data · object · required

Solana custodial wallet transaction data including input parameters and chain specific details

Show child attributes

params · object · required

Show child attributes

status · enum<string> · required

Current status of the transaction

Available options: awaiting-approval, failed, pending, success

walletType · enum<string> · required

The wallet type (smart or mpc)

Available options: mpc, smart

approvals · object

Complete approval data including requirements, pending and submitted signatures

Show child attributes

completedAt · number string

ISO timestamp when the transaction reached finality

error · object

Error message if the transaction fails after submission

Option 1

Option 2

Option 3

Show child attributes

fees · object

Transaction fee information including actual transaction fees, billed amounts, and billing status

Show child attributes

sendParams · object

Show child attributes