v1

latestOpenAPI 3.0.32026-07-26184851.6 MB

Withdraw

Child Address

This endpoint allows you to initiate a withdrawal from a specific address

Body Parameters

Key	Required	Type	Description
assetId	true*	string (UUID)	The ID of the asset to withdraw. Required if assets array is not provided.
address	true*	string	The destination wallet address for the withdrawal. Required if assets array is not provided.
amount	true*	string	The withdrawal amount. Must be greater than 0. Required if assets array is not provided.
reference	false	string	An optional reference note for the withdrawal.
note	false	string	A short message or internal remark to associate with this withdrawal. Not visible on-chain.
metadata	false	object	Optional metadata (key-value pairs) for additional transaction details.
assets	false	array of Asset	Used for batch withdrawals. Required if assetId, amount, and address are not provided.

Asset (for Batch Withdrawals)

Key	Required	Type	Description
id	true	string (UUID)	The ID of the asset to withdraw.
amount	true	string	The withdrawal amount. Must be greater than 0.
address	true	string	The destination wallet address for the withdrawal.
reference	false	string	Optional reference note for this asset withdrawal.
note	false	string	A short message or internal remark for this asset withdrawal. Not visible on-chain.
metadata	false	object	Optional metadata (key-value pairs) for this asset withdrawal.

Notes

Single withdrawal: Provide assetId, amount, and address at the top level.
Batch withdrawal: Omit top-level assetId, amount, and address, and instead provide an array of assets (each following Asset).

post/v1/wallets/{walletId}/addresses/{addressId}/withdraw

Request body

Example request

{
  "assets": [
    {
      "address": "0xRecipient1Address",
      "amount": "10.5",
      "id": "{{assetId1}}",
      "reference": "addr-payout-001"
    },
    {
      "address": "0xRecipient2Address",
      "amount": "25.0",
      "id": "{{assetId2}}",
      "reference": "addr-payout-002"
    }
  ]
}

Response

Withdraw / Withdraw (Batch)

messagestring

statusCodenumber

Example response

{
  "data": {
    "amount": "10",
    "amountPaid": "10",
    "asset": {
      "address": "0x1c7D4B196Cb0C7B01d743Fbc6116a902379C7238",
      "blockchain": {
        "createdAt": "2024-05-14T11:53:33.095Z",
        "derivationPath": "m/44'/60'/0'/0",
        "id": "85ffc132-3972-4c9e-99a5-5cf0ccb688bf",
        "isActive": true,
        "isEvmCompatible": true,
        "logoUrl": "https://res.cloudinary.com/blockradar/image/upload/v1716800081/crypto-assets/ethereum-eth-logo_idraq2.png",
        "name": "ethereum",
        "slug": "ethereum",
        "symbol": "eth",
        "tokenStandard": "ERC20",
        "updatedAt": "2024-06-14T22:32:11.983Z"
      },
      "createdAt": "2024-05-14T11:53:33.682Z",
      "decimals": 6,
      "id": "fe04a28c-c615-4e41-8eda-f84c862864f5",
      "isActive": true,
      "logoUrl": "https://res.cloudinary.com/blockradar/image/upload/v1716800083/crypto-assets/usd-coin-usdc-logo_fs9mhv.png",
      "name": "USDC Coin",
      "network": "testnet",
      "standard": "ERC20",
      "symbol": "USDC",
      "updatedAt": "2024-06-14T22:32:12.589Z"
    },
    "blockchain": {
      "createdAt": "2024-05-14T11:53:33.095Z",
      "derivationPath": "m/44'/60'/0'/0",
      "id": "85ffc132-3972-4c9e-99a5-5cf0ccb688bf",
      "isActive": true,
      "isEvmCompatible": true,
      "logoUrl": "https://res.cloudinary.com/blockradar/image/upload/v1716800081/crypto-assets/ethereum-eth-logo_idraq2.png",
      "name": "ethereum",
      "slug": "ethereum",
      "symbol": "eth",
      "tokenStandard": "ERC20",
      "updatedAt": "2024-06-14T22:32:11.983Z"
    },
    "createdAt": "2024-10-23T11:33:58.765Z",
    "currency": "USD",
    "errors": [],
    "hash": "0xded90bc7f3d98f5ff0c3a97f711717192e83e01d89ac1ff4483ae6fd9d229e6d",
    "id": "081d6315-159f-4c38-b02a-c4708836c5bd",
    "network": "testnet",
    "recipientAddress": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
    "senderAddress": "0x947514e4B803e312C312da0F1B41fEDdbe15ae7a",
    "status": "PENDING",
    "success": [
      {
        "amount": "10.5",
        "id": "tx-uuid-1",
        "recipientAddress": "0xRecipient1Address",
        "reference": "payout-001",
        "senderAddress": "0xWalletAddress",
        "status": "PENDING"
      },
      {
        "amount": "25.0",
        "id": "tx-uuid-2",
        "recipientAddress": "0xRecipient2Address",
        "reference": "payout-002",
        "senderAddress": "0xWalletAddress",
        "status": "PENDING"
      }
    ],
    "type": "WITHDRAW",
    "updatedAt": "2024-10-23T11:33:58.765Z",
    "wallet": {
      "id": "d236a191-c1d4-423c-a439-54ce6542ca41"
    }
  },
  "message": "Withdrawal request initiated successfully",
  "statusCode": 200
}