注册商户

GET · /api/v1/wallet/balance/withdrawable

可提现余额

按（链 × 代币）维度汇总当前应用热钱包、归集钱包等地址类型的可用余额，供发起提现前核对额度使用。

发起提现前请先核对本接口

availableBalance 是系统快照口径，不代表链上即时余额。 实际提现是否成功取决于链上实时余额与 Gas 费储备；若余额不足，提现任务会进入失败状态。
GET/api/v1/wallet/balance/withdrawable HMAC

Header 参数

X-Api-Key
string required
应用 apiKey。沙箱前缀 pk_test_，正式 pk_live_。
例： pk_test_4f9d8ab1c0e74...
X-Timestamp
integer (UNIX 毫秒) required
请求发起时刻的 UNIX 毫秒时间戳（13 位整数）。与服务端时差不能超过 ±300000ms（5 分钟）。
例： 1746450000000
X-Nonce
string required
本次请求的随机串，建议 UUID v4 或 16 字节 hex。同一 (apiKey, nonce) 在 10 分钟窗口内不可重复。
例： 8e3a1c2f7b6d4a90
X-Signature
string required
HMAC-SHA256 签名（小写 hex，64 字符）。算法：HMAC(secret, METHOD + "\n" + PATH + "\n" + ts + "\n" + nonce + "\n" + SHA256(body))。详见 鉴权章节。
例： 6e4a8c1f...（64 字符）

请求示例

# 签名算法（stringToSign / 4 个 header）见 /docs/api/auth
API_KEY=pk_live_xxx
SECRET=sk_live_xxx
METHOD=GET
REQ_PATH=/api/v1/wallet/balance/withdrawable
TS=$(( $(date +%s) * 1000 ))
NONCE=$(uuidgen | tr -d '-' | tr '[:upper:]' '[:lower:]')
BODY_SHA=e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
SIG=$(printf "%s\n%s\n%s\n%s\n%s" "$METHOD" "$REQ_PATH" "$TS" "$NONCE" "$BODY_SHA" \
  | openssl dgst -sha256 -hmac "$SECRET" -hex | awk '{print $2}')

curl "https://api.pqpa.com$REQ_PATH" \
  -H "X-Api-Key:    $API_KEY" \
  -H "X-Timestamp:  $TS" \
  -H "X-Nonce:      $NONCE" \
  -H "X-Signature:  $SIG"

响应

Response
200OK
{
  "code": 0,
  "data": [
    {
      "chainCode": "ETH",
      "chainName": "Ethereum",
      "chainTokenId": 19,
      "tokenSymbol": "USDT",
      "contractAddress": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
      "decimals": 6,
      "availableBalance": "98000.000000",
      "scopeAddressTypes": ["HOT", "WITHDRAW", "COLLECT"],
      "balanceByAddressType": {
        "HOT": "60000.000000",
        "COLLECT": "38000.000000"
      },
      "sourceAddressCount": 15
    }
  ],
  "msg": ""
}

data[] 字段说明

chainCode
string required
公链 code。
例： ETH
chainName
string required
公链名称。
例： Ethereum
chainTokenId
integer required
链上代币 id。
例： 19
tokenSymbol
string required
代币符号。
例： USDT
contractAddress
string | null required
合约地址；原生币为 null。
decimals
integer required
代币小数位。
例： 6
availableBalance
string required
可提现余额合计（字符串金额）。
例： "98000.000000"
scopeAddressTypes
string[] required
该余额口径所包含的地址类型，如 HOT、WITHDRAW、COLLECT。
例： ["HOT","WITHDRAW","COLLECT"]
balanceByAddressType
object required
按地址类型分组的余额映射，key 为地址类型字符串，value 为金额字符串。
例： {"HOT":"60000.000000","COLLECT":"38000.000000"}
sourceAddressCount
integer required
纳入统计口径的地址总数。
例： 15

下一步