Skip to content

提现 ​

提现:发起、查询

状态:REQUESTING(待审核)→ PENDING(已审核,签名 / 广播中)→ BROADCASTED(已广播,确认中)→ CONFIRMED; 终态还有 REJECTED(审核拒绝)、FAILED(失败)。每次进入 BROADCASTED / CONFIRMED / FAILED / REJECTED 发一条事件 (withdraw.broadcasted / confirmed / failed / rejected),data 与 GET /v1/withdraws/{withdraw_id} 相同

提现记录 ​

http
GET /v1/withdraws

API key 权限范围: read

提现记录:按 withdraw_id 倒序,游标分页;按 biz_id 查商户自己的单号

请求参数

参数位置类型必填说明
user_id查询string否用户ID:可选
biz_id查询string否商户单号:可选
chain_code查询string否链代码:可选
token_code查询string否币种代码:可选
status查询string否状态:可选
tx_hash查询string否交易哈希:可选
start_time查询string否开始时间:按创建时间,Unix 毫秒,含
end_time查询string否结束时间:按创建时间,Unix 毫秒,含
page_size查询integer否每页条数:默认 20,最大 100(超过按 100)
page_token查询string否分页令牌:上一页返回的 next_page_token,第一页不传;不透明,原样回传

响应 (200, WithdrawPage)

字段类型说明
next_page_tokenstring下一页的 page_token;为空表示没有更多
withdrawsobject (Withdraw)[]
withdraws[].amountstring金额(主单位),链上实际转出的金额
withdraws[].amount_rawstring金额(最小单位整数)
withdraws[].biz_idstring商户单号
withdraws[].block_numberstring
withdraws[].broadcast_timestring广播时间(Unix 毫秒),未广播为 0
withdraws[].chain_codestring
withdraws[].confirm_timestring确认时间(Unix 毫秒),未确认为 0
withdraws[].confirmationsinteger
withdraws[].create_timestring创建时间(Unix 毫秒)
withdraws[].decimalsinteger
withdraws[].feestring手续费(主单位),不上链
withdraws[].from_addressstring出账热钱包地址:审核通过后才有;池内转账为空
withdraws[].internalboolean是否池内转账(双方都是资金池商户,不上链、即时完成)
withdraws[].reasonstring失败或拒绝原因(FAILED / REJECTED 时有值)
withdraws[].statusstringREQUESTING / PENDING / BROADCASTED / CONFIRMED / REJECTED / FAILED
withdraws[].to_addressstring
withdraws[].token_codestring
withdraws[].tx_hashstring链上交易哈希:签名后才有;池内转账为空
withdraws[].user_idstring
withdraws[].withdraw_idstring

响应示例:

json
{
  "next_page_token": "",
  "withdraws": [
    {
      "amount": "12.5",
      "amount_raw": "12500000",
      "biz_id": "order-20261109-0001",
      "block_number": "77123456",
      "broadcast_time": "1762650000000",
      "chain_code": "TRON",
      "confirm_time": "1762650000000",
      "confirmations": 0,
      "create_time": "1762650000000",
      "decimals": 6,
      "fee": "",
      "from_address": "TJRabPrwbZy45sbavfcjinPJC18kjpRTv8",
      "internal": false,
      "reason": "AMOUNT_BELOW_MIN",
      "status": "REQUESTING",
      "to_address": "TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf",
      "token_code": "USDT",
      "tx_hash": "3f1c0e…(交易哈希)",
      "user_id": "u_10001",
      "withdraw_id": "1987654321098753"
    }
  ]
}

失败时返回统一错误体,见 错误处理。

发起提现 ​

http
POST /v1/withdraws

API key 权限范围: withdraw

发起提现:外部地址进入人工审核;双方都是资金池商户时池内转账(即时完成、不上链)

请求体

字段类型说明
amountstring金额:主单位,如 12.5
biz_idstring业务单号:商户侧幂等键,同一商户内唯一
chain_codestring链代码:如 TRON / ETH / BSC
force_onchainboolean强制上链:目标是平台资金池内另一个地址时,默认池内转账(即时、不耗 gas、不收手续费);true 则按普通提现上链
to_addressstring目标地址
token_codestring币种:如 USDT
user_idstring用户ID:商户侧用户标识

请求示例:

json
{
  "amount": "12.5",
  "biz_id": "order-20261109-0001",
  "chain_code": "TRON",
  "force_onchain": false,
  "to_address": "TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf",
  "token_code": "USDT",
  "user_id": "u_10001"
}

响应 (200, Withdraw)

字段类型说明
amountstring金额(主单位),链上实际转出的金额
amount_rawstring金额(最小单位整数)
biz_idstring商户单号
block_numberstring
broadcast_timestring广播时间(Unix 毫秒),未广播为 0
chain_codestring
confirm_timestring确认时间(Unix 毫秒),未确认为 0
confirmationsinteger
create_timestring创建时间(Unix 毫秒)
decimalsinteger
feestring手续费(主单位),不上链
from_addressstring出账热钱包地址:审核通过后才有;池内转账为空
internalboolean是否池内转账(双方都是资金池商户,不上链、即时完成)
reasonstring失败或拒绝原因(FAILED / REJECTED 时有值)
statusstringREQUESTING / PENDING / BROADCASTED / CONFIRMED / REJECTED / FAILED
to_addressstring
token_codestring
tx_hashstring链上交易哈希:签名后才有;池内转账为空
user_idstring
withdraw_idstring

响应示例:

json
{
  "amount": "12.5",
  "amount_raw": "12500000",
  "biz_id": "order-20261109-0001",
  "block_number": "77123456",
  "broadcast_time": "1762650000000",
  "chain_code": "TRON",
  "confirm_time": "1762650000000",
  "confirmations": 0,
  "create_time": "1762650000000",
  "decimals": 6,
  "fee": "",
  "from_address": "TJRabPrwbZy45sbavfcjinPJC18kjpRTv8",
  "internal": false,
  "reason": "AMOUNT_BELOW_MIN",
  "status": "REQUESTING",
  "to_address": "TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf",
  "token_code": "USDT",
  "tx_hash": "3f1c0e…(交易哈希)",
  "user_id": "u_10001",
  "withdraw_id": "1987654321098753"
}

失败时返回统一错误体,见 错误处理。

单笔提现 ​

http
GET /v1/withdraws/{withdraw_id}

API key 权限范围: read

单笔提现

请求参数

参数位置类型必填说明
withdraw_id路径string是提现ID

响应 (200, Withdraw)

字段类型说明
amountstring金额(主单位),链上实际转出的金额
amount_rawstring金额(最小单位整数)
biz_idstring商户单号
block_numberstring
broadcast_timestring广播时间(Unix 毫秒),未广播为 0
chain_codestring
confirm_timestring确认时间(Unix 毫秒),未确认为 0
confirmationsinteger
create_timestring创建时间(Unix 毫秒)
decimalsinteger
feestring手续费(主单位),不上链
from_addressstring出账热钱包地址:审核通过后才有;池内转账为空
internalboolean是否池内转账(双方都是资金池商户,不上链、即时完成)
reasonstring失败或拒绝原因(FAILED / REJECTED 时有值)
statusstringREQUESTING / PENDING / BROADCASTED / CONFIRMED / REJECTED / FAILED
to_addressstring
token_codestring
tx_hashstring链上交易哈希:签名后才有;池内转账为空
user_idstring
withdraw_idstring

响应示例:

json
{
  "amount": "12.5",
  "amount_raw": "12500000",
  "biz_id": "order-20261109-0001",
  "block_number": "77123456",
  "broadcast_time": "1762650000000",
  "chain_code": "TRON",
  "confirm_time": "1762650000000",
  "confirmations": 0,
  "create_time": "1762650000000",
  "decimals": 6,
  "fee": "",
  "from_address": "TJRabPrwbZy45sbavfcjinPJC18kjpRTv8",
  "internal": false,
  "reason": "AMOUNT_BELOW_MIN",
  "status": "REQUESTING",
  "to_address": "TXYZopYRdj2D9XRtbG411XZZ3kM5VkAeBf",
  "token_code": "USDT",
  "tx_hash": "3f1c0e…(交易哈希)",
  "user_id": "u_10001",
  "withdraw_id": "1987654321098753"
}

失败时返回统一错误体,见 错误处理。