v1

latestOpenAPI 3.0.32026-07-26184851.6 MB

Gateway

Child Address Withdraw

This endpoint allows you to initiate a withdrawal from a specific wallet.

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.

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/addresses/{addressId}/gateway/withdraw

Request body

addressstring

amountstring

blockchainstring

codestring

metadatastring

notestring

referencestring

Example request

{
  "address": "ADDRESS_TO_WITHDRAW_FROM",
  "amount": "AMOUNT_TO_DEPOSIT",
  "blockchain": "BLOCKCHAIN_TO_WITHDRAW_FROM",
  "code": "OPTIONAL_2FA_CODE",
  "metadata": "OPTIONAL_META_DATA",
  "note": "OPTIONAL_NOTE",
  "reference": "OPTIONAL_REFERENCE_CODE"
}

Response

200

messagestring

statusCodenumber

Example response

{
  "data": {
    "amlScreening": {
      "message": "Address is not sanctioned",
      "provider": "ofac, fbi, tether, circle",
      "status": "success"
    },
    "amount": "1",
    "amountPaid": "1",
    "amountUSD": "1",
    "asset": {
      "address": "0x036CbD53842c5426634e7929541eC2318f3dCF7e",
      "createdAt": "2024-05-27T14:31:19.442Z",
      "currency": "USD",
      "decimals": 6,
      "id": "0927dc05-7d4e-4c0a-82c6-98ceb170ab84",
      "isActive": true,
      "name": "USD Coin",
      "network": "testnet",
      "symbol": "USDC",
      "updatedAt": "2025-04-17T04:50:20.019Z"
    },
    "blockchain": {
      "createdAt": "2024-05-27T14:31:14.966Z",
      "derivationPath": "m/44'/60'/0'/0",
      "id": "74733889-4ecd-403e-9840-94e87c043f24",
      "isActive": true,
      "isEvmCompatible": true,
      "isL2": true,
      "name": "base",
      "slug": "base",
      "symbol": "eth",
      "updatedAt": "2024-11-26T20:04:13.945Z"
    },
    "chainId": 84532,
    "createdAt": "2025-08-17T01:48:37.989Z",
    "currency": "USD",
    "id": "c5e9ec3c-c7b1-4d84-a76e-056b8246f461",
    "network": "testnet",
    "note": "Withdrawal of 1 USDC from gateway smart wallet 0x0077777d7EBA4688BDeF3E311b846F25870A19B9",
    "rateUSD": "1",
    "reason": "Balance Before: 9.749252 USDC | Network Fee: 2.005999 USDC | Gasless: false",
    "recipientAddress": "0x2455eC6700092991Ce0782365A89d5Cd89c8Fa22",
    "reference": "tcApNlezq",
    "senderAddress": "0x947514e4B803e312C312da0F1B41fEDdbe15ae7a",
    "status": "PENDING",
    "type": "GATEWAY_WITHDRAW",
    "updatedAt": "2025-08-17T01:48:37.989Z",
    "wallet": {
      "address": "0x947514e4B803e312C312da0F1B41fEDdbe15ae7a",
      "createdAt": "2024-08-22T16:05:46.167Z",
      "derivationPath": "m/44'/60'/0'/0/0",
      "description": "This is Base wallet",
      "id": "e17dea25-6c01-4b3a-a4ae-51f411bf69cd",
      "isActive": true,
      "name": "Base Wallet",
      "network": "testnet",
      "status": "ACTIVE",
      "updatedAt": "2024-08-22T16:05:46.167Z"
    }
  },
  "message": "Withdraw initiated successfully",
  "statusCode": 200
}