Sign in

Fund Wallet

Changed on

Send funds to a wallet.

API scope required: wallets.fund

post/2024-09-26/wallets/{walletLocator}/balances

Request

  • Base URL: https://staging.crossmint.com/api
  • URL: https://staging.crossmint.com/api/2024-09-26/wallets/{walletLocator}/balances
  • 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)

Headers

X-API-KEYstring required

API key required for authentication

Request body

amountnumber required

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

token'usdxm' required

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

chain'arbitrum-sepolia' | 'avalanche-fuji' | 'base-sepolia' | 'ethereum-sepolia' | 'optimism-sepolia' | 'polygon-amoy' | 'sei-atlantic-2-testnet' | 'skale-nebula-testnet' | 'solana' | 'stellar' required

The chain to fund the wallet with

Example request

{
  "amount": 10,
  "token": "usdxm",
  "chain": "base-sepolia"
}

Response

Funds sent successfully.

token'ape' | 'bnb' | 'eth' | 'pathusd' | 'matic' | 'mnt' | 'pol' | 'sei' | 'chz' | 'avax' | 'fuel' | 'hbar' | 'vic' | 'ip' | 'zcx' | 'u2u' | 'flow' | 'usdc' | 'usdce' | 'busd' | 'usdxm' | 'usdt' | 'credit' | 'usdf' | 'pyusd0' | 'eurc' | 'usdg' | 'weth' | 'degen' | 'superverse' | 'pirate' | 'wld' | 'xmeme' | 'alphausd' | 'betausd' | 'thetausd' | 'wirex-usdc' | 'bonk' | 'phantom-cash' | 'xlm' | 'usdm0' | 'usdm1' | 'mgusd' | 'wirex-usdc' | 'sol' | 'sui' | 'apt' | 'sfuel' | 'xion' required

The token

decimalsnumber required

The number of decimals of the token

balancesobject required

The balance of the wallet in different chains

Example response

[
  {
    "token": "eth",
    "decimals": 18
  }
]

Changes

  • 3983c72e453aRevision changes
    • breaking

      removed the enum value soneium-minato-testnet of the request property

    • breaking

      removed the enum value viction-testnet of the request property

    • info

      removed the coti 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 xai enum value from the / response property for the response status

  • 069b29584823Revision changes
    • warning

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

    • warning

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

    • warning

      added the new wirex-usdc enum value to the / response property for the response status

    • warning

      added the new wirex-usdc enum value to the / response property for the response status