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: <api-key>' \
  --data '
{
  "amount": "10",
  "recipient": "0x9fda6b2c3e4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f"
}
'

{
  "chainType": "aptos",
  "createdAt": 123,
  "id": "<string>",
  "onChain": {
    "call": {
      "data": "<unknown>",
      "to": "<string>"
    },
    "explorerLink": "<string>",
    "txId": "<string>"
  },
  "params": {
    "call": {
      "abi": [
        "<unknown>"
      ],
      "address": "<string>",
      "args": [
        "<unknown>"
      ],
      "functionName": "<string>"
    },
    "chain": "abstract"
  },
  "status": "awaiting-approval",
  "walletType": "mpc",
  "approvals": {
    "pending": [
      {
        "quorumApprovals": {
          "pending": [
            {
              "member": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              },
              "message": "<string>"
            }
          ],
          "remaining": 123,
          "submitted": [
            {
              "member": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              },
              "message": "<string>",
              "signature": "<string>",
              "submittedAt": 123
            }
          ],
          "threshold": 123
        },
        "signer": {
          "locator": "<string>",
          "type": "quorum"
        }
      }
    ],
    "submitted": [
      {
        "quorumApprovals": {
          "pending": [
            {
              "member": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              },
              "message": "<string>"
            }
          ],
          "remaining": 123,
          "submitted": [
            {
              "member": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              },
              "message": "<string>",
              "signature": "<string>",
              "submittedAt": 123
            }
          ],
          "threshold": 123
        },
        "signer": {
          "locator": "<string>",
          "type": "quorum"
        }
      }
    ],
    "required": 123
  },
  "completedAt": 123,
  "error": {
    "message": "<string>",
    "reason": "program_error",
    "logs": "<unknown>",
    "revertData": {}
  },
  "fees": {
    "mode": "project",
    "actual": "<unknown>",
    "billed": {
      "usd": 123
    },
    "billing": {
      "status": "failed"
    },
    "estimate": "<unknown>"
  },
  "sendParams": {
    "params": {
      "recipient": "<string>",
      "recipientAddress": "<string>",
      "amount": "<string>"
    },
    "token": "<string>"
  }
}

POST

2025-06-09

wallets

{walletLocator}

tokens

{tokenLocator}

transfers

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: <api-key>' \
  --data '
{
  "amount": "10",
  "recipient": "0x9fda6b2c3e4d5e6f7a8b9c0d1e2f3a4b5c6d7e8f"
}
'

{
  "chainType": "aptos",
  "createdAt": 123,
  "id": "<string>",
  "onChain": {
    "call": {
      "data": "<unknown>",
      "to": "<string>"
    },
    "explorerLink": "<string>",
    "txId": "<string>"
  },
  "params": {
    "call": {
      "abi": [
        "<unknown>"
      ],
      "address": "<string>",
      "args": [
        "<unknown>"
      ],
      "functionName": "<string>"
    },
    "chain": "abstract"
  },
  "status": "awaiting-approval",
  "walletType": "mpc",
  "approvals": {
    "pending": [
      {
        "quorumApprovals": {
          "pending": [
            {
              "member": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              },
              "message": "<string>"
            }
          ],
          "remaining": 123,
          "submitted": [
            {
              "member": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              },
              "message": "<string>",
              "signature": "<string>",
              "submittedAt": 123
            }
          ],
          "threshold": 123
        },
        "signer": {
          "locator": "<string>",
          "type": "quorum"
        }
      }
    ],
    "submitted": [
      {
        "quorumApprovals": {
          "pending": [
            {
              "member": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              },
              "message": "<string>"
            }
          ],
          "remaining": 123,
          "submitted": [
            {
              "member": {
                "address": "<string>",
                "locator": "<string>",
                "type": "api-key"
              },
              "message": "<string>",
              "signature": "<string>",
              "submittedAt": 123
            }
          ],
          "threshold": 123
        },
        "signer": {
          "locator": "<string>",
          "type": "quorum"
        }
      }
    ],
    "required": 123
  },
  "completedAt": 123,
  "error": {
    "message": "<string>",
    "reason": "program_error",
    "logs": "<unknown>",
    "revertData": {}
  },
  "fees": {
    "mode": "project",
    "actual": "<unknown>",
    "billed": {
      "usd": 123
    },
    "billing": {
      "status": "failed"
    },
    "estimate": "<unknown>"
  },
  "sendParams": {
    "params": {
      "recipient": "<string>",
      "recipientAddress": "<string>",
      "amount": "<string>"
    },
    "token": "<string>"
  }
}

Authorizations

X-API-KEY

string

header

required

API key required for authentication

Headers

x-idempotency-key

string

Unique string, such as a UUID, that identifies this request. It is not the transaction ID. To retry the request, send it again with the same key. If a transaction already exists for this key in the project, the API returns that transaction in its current status and ignores the new request body. Keys do not expire and are not returned in responses. See Transfer Tokens for details.

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

default:direct

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

Allowed value: "direct"

Response

201 - application/json

The transaction has been successfully created.

EVM MPC Wallet
EVM Smart Wallet
Stellar Smart Wallet
Solana Smart Wallet
Solana MPC 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

required

ISO timestamp when the transaction was created

string

required

Unique identifier for the transaction

onChain

EVM MPC wallet transaction data · object

required

Transaction data specific to EVM MPC wallets

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

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

Introduction

Quickstarts ⚡

Concepts

Guides

API Reference

Authorizations

Headers

Path Parameters

Body

Response