Skip to main content
POST
/
v1-alpha2
/
wallets
/
{walletLocator}
/
balances
Fund Wallet
curl --request POST \
  --url https://staging.crossmint.com/api/v1-alpha2/wallets/{walletLocator}/balances \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <x-api-key>' \
  --data '
{
  "amount": 10,
  "token": "usdxm",
  "chain": "base-sepolia"
}
'
[
  {
    "token": "usdc",
    "decimals": 6,
    "balances": {
      "base": "121000000",
      "ethereum": "121000000",
      "total": "242000000"
    }
  },
  {
    "token": "eth",
    "decimals": 18,
    "balances": {
      "ethereum": "1000000000000000000",
      "total": "1000000000000000000"
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.crossmint.com/llms.txt

Use this file to discover all available pages before exploring further.

This is an alpha API and subject to change.
This endpoint is only available in staging and only supports USDXM.

Headers

​
X-API-KEY
string
required

API key required for authentication

Path Parameters

​
walletLocator
string
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)

Body

application/json

Parameters required to fund a wallet

​
amount
number
required

The amount of currency to fund the wallet with. Between 1 and 100

Required range: 1 <= x <= 100
Example:

10

​
token
enum<string>
required

The currency to fund the wallet with. Only USDXM is supported.

Available options:
usdxm
Example:

"usdxm"

​
chain
enum<string>
required

The chain to fund the wallet with

Available options:
arbitrum-sepolia,
avalanche-fuji,
base-sepolia,
ethereum-sepolia,
optimism-sepolia,
polygon-amoy,
sei-atlantic-2-testnet,
skale-nebula-testnet,
soneium-minato-testnet,
viction-testnet,
solana,
stellar
Example:

"base-sepolia"

Response

Funds sent successfully.

​
token
enum<string>
required

The token

Available options:
ape,
bnb,
coti,
eth,
pathusd,
matic,
mnt,
pol,
plume,
sei,
chz,
avax,
xai,
fuel,
hbar,
vic,
ip,
zcx,
u2u,
flow,
usdc,
usdce,
busd,
usdxm,
usdt,
credit,
usdf,
eurc,
weth,
degen,
superverse,
pirate,
wld,
xmeme,
alphausd,
betausd,
thetausd,
bonk,
xlm,
usdm0,
usdm1,
sol,
sui,
apt,
sfuel,
xion
Example:

"eth"

​
decimals
number
required

The number of decimals of the token

Example:

18

​
balances
object
required

The balance of the wallet in different chains

Example:
[
  {
    "token": "usdc",
    "decimals": 6,
    "balances": {
      "base": "121000000",
      "ethereum": "121000000",
      "total": "242000000"
    }
  },
  {
    "token": "eth",
    "decimals": 18,
    "balances": {
      "ethereum": "1000000000000000000",
      "total": "1000000000000000000"
    }
  }
]