**--- title: New Huo Trust API 文檔
language_tabs: # must be one of https://git.io/vQNgJ - json
toc_footers: - 創建 API Key includes:
search: true
更新日誌
生效時間(UTC +8) | 接口 | 變化 | 摘要 |
---|---|---|---|
2021.9.16 | - | - | - |
簡介
歡迎使用New Huo Trust API!
此文檔是New Huo Trust API的唯一官方文檔,New Huo Trust API提供的功能和服務會在此文檔持續更新。
以下是現貨API文檔各章節主要內容
第一部分是概要介紹:
- 快速入門:該章節對New Huo Trust API做了簡單且全方位的介紹,適合第一次使用New Huo Trust API的用戶。
- 常見問題:該章節列舉了使用New Huo Trust API時常見的、和具體API無關的通用問題。
- 聯系我們:該章節介紹了針對不同問題,如何聯系我們。
第二部分是每個接口類的詳細介紹,每個接口類一個章節,每個章節分為如下內容:
- 簡介:對該接口類進行簡單介紹,包括一些註意事項和說明。
- 具體接口:介紹每個接口的用途、限頻、請求、參數、返回等詳細信息。
- 常見錯誤碼:介紹該接口類下常見的錯誤碼及其說明。
- 常見問題:介紹該接口類下常見問題和解答。
快速入門
接入準備
如需使用API ,請先登錄網頁端,完成API key的申請和權限配置,再據此文檔詳情進行開發和交易。
您可以點擊 這裏 創建 API Key。
每個用戶可創建20組Api Key,每個Api Key可對應設置讀取權限。
權限說明如下:
- 讀取權限:讀取權限用於對數據的查詢接口,例如:資產列表查詢等。
創建成功後請務必記住以下信息:
Access Key
API 訪問密鑰Secret Key
簽名認證加密所使用的密鑰(僅申請時可見)
SDK與代碼示例
Java | Python3 | C++ | C# | Go
其它代碼示例
https://github.com/newhuo-tech?tab=repositories
接口類型
香港信托為用戶提供兩種接口,您可根據自己的使用場景和偏好來選擇適合的方式進行查詢資產。
REST API
REST,即Representational State Transfer的縮寫,是目前較為流行的基於HTTP的一種通信機製,每一個URL代表一種資源。
使用API進行資產查詢,建議開發者使用REST API進行操作。
WebSocket API
WebSocket是HTML5一種新的協議(Protocol)。它實現了客戶端與服務器全雙工通信,通過一次簡單的握手就可以建立客戶端和服務器連接,服務器可以根據業務規則主動推送信息給客戶端。
市場行情和買賣深度等信息,建議開發者使用WebSocket API進行獲取。
接口鑒權
以上兩種接口均包含公共接口和私有接口兩種類型。
公共接口可用於獲取基礎信息和行情數據。公共接口無需認證即可調用。
私有接口可用於交易管理和賬戶管理。每個私有請求必須使用您的API Key進行簽名驗證。
接入URLs
您可以使用api.trust.newhuotech.com域名。
REST API
https://api.trust.newhuotech.com
簽名認證
簽名說明
API 請求在通過 internet 傳輸的過程中極有可能被篡改,為了確保請求未被更改,除公共接口(基礎信息,行情數據)外的私有接口均必須使用您的 API Key 做簽名認證,以校驗參數或參數值在傳輸途中是否發生了更改。 每一個API Key需要有適當的權限才能訪問相應的接口,每個新創建的API Key都需要分配權限。在使用接口前,請查看每個接口的權限類型,並確認你的API Key有相應的權限。
一個合法的請求由以下幾部分組成:
- 方法請求地址:即訪問服務器地址 api.trust.newhuotech.com,比如 api.trust.newhuotech.com/v1/open/apiKeyDemo。
- API 訪問Id(AccessKeyId):您申請的 API Key 中的 Access Key。
- 簽名方法(SignatureMethod):用戶計算簽名的基於哈希的協議,此處使用 HmacSHA256。
- 簽名版本(SignatureVersion):簽名協議的版本,此處使用2。
- 時間戳(Timestamp):您發出請求的時間 (UTC 時間) 。如:2017-05-11T16:22:06。在查詢請求中包含此值有助於防止第三方截取您的請求。
- 必選和可選參數:每個方法都有一組用於定義 API 調用的必需參數和可選參數。可以在每個方法的說明中查看這些參數及其含義。
- 對於 GET 請求,每個方法自帶的參數都需要進行簽名運算。
- 對於 POST 請求,每個方法自帶的參數不進行簽名認證,並且需要放在 body 中。
- 簽名:簽名計算得出的值,用於確保簽名有效和未被篡改。
簽名步驟
規範要計算簽名的請求 因為使用 HMAC 進行簽名計算時,使用不同內容計算得到的結果會完全不同。所以在進行簽名計算前,請先對請求進行規範化處理。下面以查詢某訂單詳情請求為例進行說明:
查詢某訂單詳情時完整的請求URL
https://api.trust.newhuotech.com/v1/open/apiKeyDemo?
AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2017-05-11T15:19:30
&order-id=1234567890
1. 請求方法(GET 或 POST,WebSocket用GET),後面添加換行符 「\n」
例如:
GET\n
2. 添加小寫的訪問域名,後面添加換行符 「\n」
例如:
api.trust.newhuotech.com\n
3. 訪問方法的路徑,後面添加換行符 「\n」
例如apiKeyDemo:
/v1/open/apiKeyDemo\n
例如WebSocket v2
/ws/v2
4. 對參數進行URL編碼,並且按照ASCII碼順序進行排序
例如,下面是請求參數的原始順序,且進行URL編碼後
AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx
demo-id=1234567890
SignatureMethod=HmacSHA256
SignatureVersion=2
Timestamp=2017-05-11T15%3A19%3A30
經過排序之後
AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx
SignatureMethod=HmacSHA256
SignatureVersion=2
Timestamp=2017-05-11T15%3A19%3A30
demo-id=1234567890
5. 按照以上順序,將各參數使用字符 「&」 連接
AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2017-05-11T15%3A19%3A30&demo-id=1234567890
6. 組成最終的要進行簽名計算的字符串如下
GET\n
api.trust.newhuotech.com\n
v1/open/apiKeyDemo\n
AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2017-05-11T15%3A19%3A30&demo-id=1234567890
7. 用上一步裏生成的 「請求字符串」 和你的密鑰 (Secret Key) 生成一個數字簽名
- 將上一步得到的請求字符串和 API 私鑰作為兩個參數,調用HmacSHA256哈希函數來獲得哈希值。
- 將此哈希值用base-64編碼,得到的值作為此次接口調用的數字簽名。
4F65x5A2bLyMWVQj3Aqp+B4w+ivaA7n5Oi2SuYtCJ9o=
8. 將生成的數字簽名加入到請求裏
對於Rest接口:
- 把所有必須的認證參數添加到接口調用的路徑參數裏
- 把數字簽名在URL編碼後加入到路徑參數裏,參數名為「Signature」。
最終,發送到服務器的 API 請求應該為
https://api.trust.newhuotech.com/v1/open/apiKeyDemo?AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&demo-id=1234567890&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2017-05-11T15%3A19%3A30&Signature=4F65x5A2bLyMWVQj3Aqp%2BB4w%2BivaA7n5Oi2SuYtCJ9o%3D
接入說明
接口概覽
接口分類 | 分類鏈接 | 概述 |
---|---|---|
測試類 | /v1/open/apiKeyDemo/* | apiKey測試相關接口 |
賬戶類 | /v1/open/account/* | 賬戶相關接口 |
該分類為大類整理,部分接口未遵循此規則,請根據需求查看有關接口文檔。
新限頻規則
當前,新限頻規則正在逐步上線中,已單獨標註限頻值的接口且該限頻值被標註為NEW的接口適用新限頻規則。
新限頻規則采用基於UID的限頻機製,即,同一UID下各API Key同時對某單個節點請求的頻率不能超出單位時間內該節點最大允許訪問次數的限製。
用戶可根據Http Header中的"X-HB-RateLimit-Requests-Remain"(限頻剩余次數)及"X-HB-RateLimit-Requests-Expire"(窗口過期時間)查看當前限頻使用情況,以及所在時間窗口的過期時間,根據該數值動態調整您的請求頻率。
限頻規則
除已單獨標註限頻值為NEW的接口外 -
* 每個API Key 在1秒之內限製10次
* 若接口不需要API Key,則每個IP在1秒內限製10次
比如:
- 資產訂單類接口調用根據API Key進行限頻:1秒10次
請求格式
所有的API請求都是restful,目前只有兩種方法:GET和POST
- GET請求:所有的參數都在路徑參數裏
- POST請求,所有參數以JSON格式發送在請求主體(body)裏
返回格式
所有的接口都是JSON格式。其中v1和v2接口的JSON定義略有區別。
接口返回格式:最上層有三個字段:code
, message
和 data
。前兩個字段表示返回碼和錯誤消息,實際的業務數據在data
字段裏。
以下是一個返回格式的樣例:
{
"code": 200,
"message": "",
"data": // per API response data in nested JSON object
}
參數名稱 | 數據類型 | 描述 |
---|---|---|
code | int | API接口返回碼 |
message | string | 錯誤消息(如果有) |
data | object | 接口返回數據主體 |
數據類型
本文檔對JSON格式中數據類型的描述做如下約定:
string
: 字符串類型,用雙引號(")引用int
: 32位整數,主要涉及到狀態碼、大小、次數等long
: 64位整數,主要涉及到Id和時間戳float
: 浮點數,主要涉及到金額和價格,建議程序中使用高精度浮點型object
: 對象,包含一個子對象{}array
: 數組,包含多個對象
最佳實踐
安全類
- 強烈建議:不要將API Key暴露給任何人(包括第三方軟件或機構),API Key代表了您的賬戶權限,API Key的暴露可能會對您的信息、資金造成損失,若API Key泄露,請盡快刪除並重新創建。
公共類
API訪問建議
- 不建議在中國大陸境內使用臨時域名以及代理的方式訪問New Huo Trust API,此類方式訪問API連接的穩定性很難保證。
- 建議使用日本AWS雲服務器進行訪問。
- 官方域名api.trust.newhuotech.com。
新限頻規則
當前最新限頻規則正在逐步上線中,已單獨標註限頻值的接口適用新限頻規則。
用戶可根據Http Header中「X-HB-RateLimit-Requests-Remain(限頻剩余次數)」,「X-HB-RateLimit-Requests-Expire(窗口過期時間)」查看當前限頻使用情況,以及所在時間窗口的過期時間,根據該數值動態調整您的請求頻率。
同一UID下各API Key同時對某單個節點請求的頻率不能超出單位時間內該節點最大允許訪問次數的限製。
常見問題
本章列舉了和具體API無關的通用常見問題,如網絡、簽名或通用錯誤等。
針對某類或某個API的問題,請查看每章API的錯誤碼和常見問題。
Q1:一個用戶可以申請多少個API Key?
每個用戶可創建20組API Key,每個API Key可對應設置讀取權限。
以下是權限的說明:
- 讀取權限:讀取權限用於對數據的查詢接口,例如:資產查詢等。
Q2:為什麼經常出現斷線、超時的情況?
請檢查是否屬於以下情況:
- 客戶端服務器如在中國大陸境內,連接的穩定性很難保證,建議使用日本AWS雲服務器進行訪問。
Q3:為什麼簽名認證總返回失敗?
請檢查如下可能的原因:
1、簽名參數應該按照ASCII碼排序。比如下面是原始的參數:
AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx
order-id=1234567890
SignatureMethod=HmacSHA256
SignatureVersion=2
Timestamp=2017-05-11T15%3A19%3A30
排序之後應該為:
AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx
SignatureMethod=HmacSHA256
SignatureVersion=2
Timestamp=2017-05-11T15%3A19%3A30
order-id=1234567890
2、簽名串需進行URL編碼。比如:
- 冒號
:
會被編碼為%3A
,空格會被編碼為%20
- 時間戳需要格式化為
YYYY-MM-DDThh:mm:ss
,經過URL編碼之後為2017-05-11T15%3A19%3A30
3、簽名需進行 base64 編碼
4、Get請求參數需在簽名串中
5、時間為UTC時間轉換為YYYY-MM-DDTHH:mm:ss
6、檢查本機時間與標準時間是否存在偏差(偏差應小於1分鐘)
7、簽名時所帶Host應與請求接口時Host相同
如果您使用了代理,代理可能會改變請求Host,可以嘗試去掉代理;
或者,您使用的網絡連接庫可能會把端口包含在Host內,可以嘗試在簽名用到的Host中包含端口,如「api.trust.newhuotech.com:443"
8、Access Key 與 Secret Key中是否存在隱藏特殊字符,影響簽名
當前官方已支持多種語言的SDK,可以參考SDK的簽名實現,或者以下三種語言的簽名樣例代碼
JAVA簽名樣例代碼 | Python簽名樣例代碼 | C++簽名樣例代碼
Q4:調用接口返回Incorrect Access Key 錯誤是什麼原因?
請檢查URL請求中Access Key是否傳遞準確,例如:
- Access Key沒有傳遞
- Access Key位數不準確
- Access Key已經被刪除
- URL請求中參數拼接錯誤或者特殊字符沒有進行編碼導致服務端對AccessKey解析不正確
Q5:調用接口返回 gateway-internal-error 錯誤是什麼原因?
請檢查是否屬於以下情況:
- 可能為網絡原因或服務內部錯誤,請稍後進行重試。
- 發送數據格式是否正確(需要標準JSON格式)。
- POST請求頭header需要聲明為
Content-Type:application/json
。
Q6:調用接口返回 login-required 錯誤是什麼原因?
請檢查是否屬於以下情況:
- 未將AccessKey參數帶入URL中。
- 未將Signature參數帶入URL中。
Q7: 調用Rest接口返回HTTP 405錯誤 method-not-allowed 是什麼原因?
該錯誤表明調用了不存在的Rest接口,請檢查Rest接口路徑是否準確。由於Nginx的設置,請求路徑(Path)是大小寫敏感的,請嚴格按照文檔聲明的大小寫。
聯系我們
技術支持
使用過程中如有問題或者建議,您可選擇以下任一方式聯系我們:
- 通過官網的「幫助中心」或者發送郵件至[email protected]聯系客服。
如您遇到API錯誤,請按照如下模板向我們反饋問題。
1. 問題描述
2. 問題發生的用戶Id(UID),賬戶Id和訂單Id(如果和賬戶、訂單有關系)
3. 完整的URL請求
4. 完整的JSON格式的請求參數(如果有)
5. 完整的JSON格式的返回結果
6. 問題出現時間和頻率(如何時開始出現,是否可以重現)
7. 簽名前字符串(如果是簽名認證錯誤)
下方是一個應用了模版的例子:
1. 問題簡要說明:簽名錯誤
2. UID:123456
3. 完整的URL請求:GET https://api.trust.newhuotech.com/v1/open/apiKeyDemo/forRead?&SignatureVersion=2&SignatureMethod=HmacSHA256&Timestamp=2019-11-06T03%3A25%3A39&AccessKeyId=rfhxxxxx-950000847-boooooo3-432c0&Signature=HhJwApXKpaLPewiYLczwfLkoTPnFPHgyF61iq0iTFF8%3D
4. 完整的JSON格式的參數:無
5. 完整的JSON格式的返回:{"status":"error","err-code":"api-signature-not-valid","err-msg":"Signature not valid: Incorrect Access key [Access key錯誤]","data":null}
6. 問題出現頻率:每次都會出現
7. 簽名前字符串
GET\n
api.trust.newhuotech.com\n
/v1/open/apiKeyDemo/forRead\n
AccessKeyId=rfhxxxxx-950000847-boooooo3-432c0&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2019-11-06T03%3A26%3A13
註意:Access Key僅能證明您的身份,不會影響您賬戶的安全。切記不要將Secret Key信息分享給任何人,若您不小心將Secret Key暴露,請盡快刪除其對應的API Key,以免造成您的賬戶損失。
用戶相關
賬戶相關接口提供了用戶綁定、信息查詢等查詢轉等功能。
鑄幣商用戶鑒權
用戶綁定,暫時由信託根據簽名信息自主完成 簽名流程參照api key加簽流程(秘鑰由信託單獨生成同步給機構,與用戶個人的api key區分使用) 最終,登錄的地址應該為
${信託web頁面登錄url}?AccessKeyId=e2xxxxxx-99xxxxxx-84xxxxxx-7xxxx&outerUserId=1234567890&callBackUrl=${回調url}&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2017-05-11T15%3A19%3A30&Signature=4F65x5A2bLyMWVQj3Aqp%2BB4w%2BivaA7n5Oi2SuYtCJ9o%3D
HTTP 請求
- GET
信託web頁面登錄url
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
AccessKeyId | true | string | 外部系統鑒權access key(由信託服務生成,提供) | ||
outerUserId | true | string | 外部系統用戶唯一標識 | ||
callbackUrl | true | string | 回調url | ||
SignatureMethod | true | string | 簽名方法(HmacSHA256) | ||
SignatureVersion | true | string | 簽名版本(2) | ||
Timestamp | true | string | 時間戳(例如:2017-05-11T15%3A19%3A30) | ||
Signature | true | string | 簽名數據 |
用戶鑒權信息查詢
API Key 權限:讀取
限頻值(NEW):100次/s
HTTP 請求
- GET
/v1/open/merchant/user/getAuthInfo
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
outerUserId | true | string | (外部系統用戶id)外部系統用戶唯一標識 |
Request:
https://api.trust.newhuotech.com/v1/open/merchant/user/getAuthInfo?&SignatureVersion=2&x-b3-traceid=a9900d8e-4bcf-4066-9abf-8e0a3acf7d21&AccessKeyId=8f00e20e-vf25treb80-dcde4948-e5067&Signature=N70oF0Jrsi1v4Fhs92xhxTG0sNkwHFVGNOsexRKcMOI%3D&outerUserId=testzy5&SignatureMethod=HmacSHA256&Timestamp=2022-06-29T03%3A44%3A20
Response:
{
"code": 200,
"data": {
"outerUserId": "testzy5",
"outerUid": "1457228443811871"
},
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | object | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
outerUserId | string | 外部系統用戶標識 | |
outerUid | string | 外部uid |
新增子賬號
API Key 權限:交易
限頻值(NEW):100次/s
HTTP 請求
- POST
/v1/open/uc/user/create
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
loginName | true | string | 用戶名,郵箱格式 | ||
password | true | string | 密码(32位md5) | ||
repeatPassword | true | string | 重复密码(32位md5) | ||
fingerprint | true | string | 指纹(32位唯一值) |
Request:
{
"loginName": "[email protected]",
"password": "7fa8282ad93047a4d6fe6111c93b308a",
"repeatPassword": "7fa8282ad93047a4d6fe6111c93b308a",
"fingerprint": "7fa8282ad93047a4d6fe6111c93b308a"
}
Response:
{
"code": 200,
"data": 121849591,
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | long | 用户uid |
获取子賬號列表
API Key 權限:读取
限頻值(NEW):100次/s
HTTP 請求
- POST
/v1/open/uc/user/queryChildList
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
loginName | false | string | 用戶名,郵箱格式 | ||
size | false | int | 每页显示条数 | ||
current | false | int | 页码 |
Request:
{
"size": 1,
"current": 1
}
Response:
{
"code": 200,
"data": {
"records": [
{
"id": 4585,
"uid": 115461860,
"loginName": "[email protected]",
"sumBalance": "2544198.45889661",
"status": 1,
"remark": "1Qaz2wsx@",
"bindGa": true,
"rank": 2,
"deep": 1,
"createdAt": 1652956563000,
"updatedAt": 1656315932000,
"hasChild": true,
"source": "custody",
"userType": 1
}
],
"total": 18,
"size": 1,
"current": 1,
"pages": 18
},
"success": true
}
響應數據
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
code | int | 狀態碼 | |
message | string | 錯誤描述(如有) | |
data | object | 业务数据 |
data数据描述:
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
total | integer | 总记录 | |
size | int | 每页记录数 | |
current | int | 当前页码 | |
pages | int | 总页数 | |
records | object | 业务数据 |
records数据描述:
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
uid | long | 用户uid | |
loginName | string | 登录名 | |
rank | int | 用户等级 | |
status | int | 状态 | 1:正常 2:冻结 |
hasChild | object | 是否有下级账号 |
賬戶相關
簡介
賬戶相關接口提供了賬戶、余額等查詢轉等功能。
賬戶信息查詢(當前賬號)
API Key 權限:讀取
限頻值(NEW):100次/s
查詢指定類型賬戶,支持以下賬戶類型:
hbt-custody:资金賬戶,hb-spot:交易賬戶
HTTP 請求
- GET
/v1/open/account/get
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
source | true | string | hbt-custody(資金賬戶),hb-spot(交易賬戶) , |
Request:
https://api.trust.newhuotech.com/v1/open/account/get?&SignatureVersion=2&x-b3-traceid=13aff565a1054ba39267d7f4ac17be96&AccessKeyId=8f00e20e-vf25treb80-dcde4948-e5067&Signature=5%2FfzwQQhT9hwOfqYvsK06iAjARpWlNSGycMh1CWxYis%3D&SignatureMethod=HmacSHA256&source=hbt-custody&Timestamp=2022-06-29T07%3A46%3A19
Response:
{
"code": 200,
"data": [
{
"currencyDisplayName": "BTC(BTC)",
"currency": "btc",
"state": "normal",
"balance": "57226.000000000000000000",
"suspense": "0.000000000000000000",
"price": {
"symbol": "btcusd",
"high": 20855.367948511263,
"close": 20853.889169664755,
"open": 20855.367948511263,
"amount": 15.724957,
"vol": 332714.20416247,
"count": 64
}
},
{
"currencyDisplayName": "USDT(ERC20)",
"currency": "usdt",
"state": "normal",
"balance": "69952.000000000000000000",
"suspense": "0.000000000000000000",
"price": {
"symbol": "usdtusd",
"high": 0.9991748962879672,
"close": 0.9991748962879672,
"open": 0.9991748962879672,
"amount": 0,
"vol": 0,
"count": 0
}
}
],
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | object | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
currency | string | 幣種 | |
balance | string | 余額 | |
suspense | string | 凍結金額 | |
price | object | 折合usdt行情 |
price字段說明(數據來源火幣 Global)
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
currency | string | 幣種 | |
symbol | string | 交易對 | |
high | number | 24小時最高價 | |
close | number | 最新價 | |
open | number | 24小時開盤價 | |
amount | number | 24小時成交量 | |
vol | number | 24小時成交額 | |
count | number | 24小時成交筆數 |
查询信托账户资产币种明细(支持子賬號)
API Key 權限:讀取
限頻值(NEW):100次/s
HTTP 請求
- GET
/v1/open/account/getByUserId
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
uid | ture | long | 用户uid | ||
source | ture | string | 账户类型 | 资金账户:hbt-custody | |
currency | false | string | 幣種 |
Request:
https://api.trust.newhuotech.com/v1/open/account/getByUserId?&uid=115460188&SignatureVersion=2&x-b3-traceid=ee9b49e213ef47468ea51add1d99b479&AccessKeyId=8f00e20e-vf25treb80-dcde4948-e5067&Signature=D64r4rrYUXQhPMhNX3y9WHExBVID7wPpSVYud3V0f%2B0%3D&SignatureMethod=HmacSHA256&source=hbt-custody&Timestamp=2022-06-29T07%3A50%3A51
Response:
{
"code": 200,
"data": [
{
"currencyDisplayName": "BTC(BTC)",
"currency": "btc",
"state": "normal",
"balance": "57226.000000000000000000",
"suspense": "0.000000000000000000",
"price": {
"symbol": "btcusd",
"high": 20855.367948511263,
"close": 20853.889169664755,
"open": 20855.367948511263,
"amount": 15.724957,
"vol": 332714.20416247,
"count": 64
}
},
{
"currencyDisplayName": "USDT(ERC20)",
"currency": "usdt",
"state": "normal",
"balance": "69952.000000000000000000",
"suspense": "0.000000000000000000",
"price": {
"symbol": "usdtusd",
"high": 0.9991748962879672,
"close": 0.9991748962879672,
"open": 0.9991748962879672,
"amount": 0,
"vol": 0,
"count": 0
}
}
],
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | list | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
currency | string | 幣種 | |
chain | string | 鏈 | |
state | string | 賬號狀態 | normal |
balance | string | 餘額 | |
suspense | string | 凍結金額 |
資產記錄
簡介
資產記錄相關接口提供了充幣、提幣、劃轉記錄等查詢轉等功能。
充幣記錄查詢(不推薦使用,請使用【充幣相關】 -> 【充幣記錄查詢/v1/open/deposit/list】)
API Key 權限:讀取
限頻值(NEW):100次/s
HTTP 請求
- GET
/v2/external/deposit/finance/history
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
currency | false | string | 幣種 | ||
startTime | false | long | 查詢起始時間(毫秒) | ||
endTime | false | long | 查詢結束時間(毫秒) | ||
from | false | long | 查詢起始ID | ||
direct | false | string | 方向:"prev", "next"(prev 時間由近及遠, next時間由遠及近) | ||
size | false | int | 分頁查詢查詢結果條數(如不傳,默認每頁展示10條記錄,取值區間[1,500]) | ||
state | false | int | 提幣狀態代碼集合(多個用英文逗號分隔) 提幣單狀態:(1, "pre-submitted"),(2, "invalid"),(3, "submitted"),(4, "reexamine"),(5, "canceled"),(6, "pass"),(7, "reject"),(8, "pre-transfer"),(9, "wallet-transfer"),(10, "wallet-reject"),(11, "confirmed"),(12, "confirm-error"),(13, "repealed"),(14, "normal-account-frozen"),(20, "created-without-risk-action"),(21, "account-frozen"),(22, "risk-action-assign"),(23, "risk-action-success"),(24, "risk-action-fail"),(25, "risk-action-timeout"),(30, "pre-withdraw-created"),(31, "pre-withdraw-confirmed"),(32, "pre-withdraw-launch-begin"),(33, "pre-withdraw-launch-success"),(34, "pre-withdraw-launch-failed"),(35, "pre-withdraw-canceled"),(40, "settlement-withdraw-processing"),(41, "settlement-withdraw-partially-completed"),(42, "settlement-withdraw-failed"),(43, "reexamine-reject"),(44, "reexamine-dismissed") |
Response:
{
"code": 200,
"data": [
{
"currency": "usdt",
"state": "normal",
"balance": "10120.558300000000000000",
"suspense": "19.000000000000000000",
"price": {
"symbol": "usdtusdt",
"high": 1,
"close": 1,
"open": 1,
"amount": 0,
"vol": 0,
"count": 0
}
},
{
"currency": "btc",
"state": "normal",
"balance": "0",
"suspense": "0",
"price": {
"symbol": "btcusdt",
"high": 47815,
"close": 47815,
"open": 47815,
"amount": 0,
"vol": 0,
"count": 0
}
}
],
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | list | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
currency | string | 幣種 | |
amount | string | 余額 | |
chain | string | 凍結金額 | |
errorCode | object | 錯誤碼 | |
errorMsg | object | 錯誤信息 | |
fees | object | 手續費 | |
id | object | id | |
label | object | 標籤 | |
state | object | 狀態 | |
toAddress | object | 地址 | |
toAddressTag | object | 地址標簽 | |
txHash | object | txHash | |
type | string | 類型 | |
createAt | long | 創建時間 | |
updateAt | long | 更新時間 |
| |
提幣記錄查詢 (不推薦使用,請使用【提幣相關】 -> 【提幣記錄查詢/v1/open/withdraw/allList】)
API Key 權限:讀取
限頻值(NEW):100次/s
HTTP 請求
- GET
/v2/external/withdraw/list
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
currency | false | string | 幣種 | ||
startTime | false | long | 查詢起始時間(毫秒) | ||
endTime | false | long | 查詢結束時間(毫秒) | ||
from | false | long | 查詢起始ID | ||
direct | false | string | 方向:"prev", "next"(prev 時間由近及遠, next時間由遠及近) | ||
size | false | int | 分頁查詢查詢結果條數(如不傳,默認每頁展示10條記錄,取值區間[1,500]) | ||
state | false | int | 提幣狀態代碼集合(多個用英文逗號分隔) 提幣單狀態:(1, "pre-submitted"),(2, "invalid"),(3, "submitted"),(4, "reexamine"),(5, "canceled"),(6, "pass"),(7, "reject"),(8, "pre-transfer"),(9, "wallet-transfer"),(10, "wallet-reject"),(11, "confirmed"),(12, "confirm-error"),(13, "repealed"),(14, "normal-account-frozen"),(20, "created-without-risk-action"),(21, "account-frozen"),(22, "risk-action-assign"),(23, "risk-action-success"),(24, "risk-action-fail"),(25, "risk-action-timeout"),(30, "pre-withdraw-created"),(31, "pre-withdraw-confirmed"),(32, "pre-withdraw-launch-begin"),(33, "pre-withdraw-launch-success"),(34, "pre-withdraw-launch-failed"),(35, "pre-withdraw-canceled"),(40, "settlement-withdraw-processing"),(41, "settlement-withdraw-partially-completed"),(42, "settlement-withdraw-failed"),(43, "reexamine-reject"),(44, "reexamine-dismissed") |
Response:
{
"code": 200,
"data": [
{
"currency": "usdt",
"state": "normal",
"balance": "10120.558300000000000000",
"suspense": "19.000000000000000000",
"price": {
"symbol": "usdtusdt",
"high": 1,
"close": 1,
"open": 1,
"amount": 0,
"vol": 0,
"count": 0
}
},
{
"currency": "btc",
"state": "normal",
"balance": "0",
"suspense": "0",
"price": {
"symbol": "btcusdt",
"high": 47815,
"close": 47815,
"open": 47815,
"amount": 0,
"vol": 0,
"count": 0
}
}
],
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | list | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
currency | string | 幣種 | |
amount | string | 余額 | |
blockchainConfirm | integer | 確認次數 | |
depositSafeConfirms | integer | 安全確認次數 | |
errorCode | object | 錯誤碼 | |
errorMsg | object | 錯誤信息 | |
id | object | id | |
state | object | 狀態 | |
txHash | object | txHash | |
type | string | 類型 | |
createAt | long | 創建時間 | |
updateAt | long | 更新時間 |
劃轉相關
簡介
劃轉相關接口提供了賬戶劃轉、查詢等功能。
UID劃轉記錄分頁查詢
API Key 權限:讀取
限頻值(NEW):100次/s
HTTP 請求
- POST
/v1/open/api/uid-transfer/page
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
currency | false | string | 幣種 | ||
clientOrderId | false | string | 劃轉訂單 | ||
status | false | string | 訂單狀態 | 狀態 枚舉: jumio,audit,audit_refuse,multi_audit_refuse,multi_audit_fail,success,fail 枚舉備註: jumio :人臉識別驗證 audit :人工審核中 audit_refuse :人工審核拒絕 multi_audit_refuse :多人審批驗證中 multi_audit_fail :多人審批驗證失敗 success :劃轉成功 fail :劃轉失敗 | |
createTime | false | object | 申請時間开始时间 | ||
updateTime | false | object | 申請時間结束时间 | ||
current | false | integer | 當前頁碼 | ||
size | false | string | 分頁大小 |
createTime/updateTime 字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
start | integer | 開始時間 | 精確到毫秒 閉 |
end | integer | 結束時間 | 精確到毫秒 開 |
Request:
{
"size": 1,
"current": 1
}
Response:
{
"code": 200,
"data": {
"records": [
{
"id": 1300,
"fromUid": 1457228443811871,
"phone": "1001",
"email": "",
"toUserName": "924****1001",
"currency": "btc",
"amount": 12.0,
"clientOrderId": "1540976534049787904",
"status": "success",
"refuse": "",
"createdAt": 1656232410334,
"updatedAt": 1656232410559
}
],
"total": 1,
"size": 1,
"current": 1,
"pages": 1
},
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | object | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
id | number | 數據id | |
clientOrderId | string | 劃轉訂單id | |
fromUid | string | 劃轉方uid | |
toUid | string | 收款方uid | |
toUserName | string | 收款方註冊賬號 | |
state | string | 狀態 枚舉: jumio,audit,audit_refuse,multi_audit_refuse,multi_audit_fail,success,fail 枚舉備註: jumio :人臉識別驗證 audit :人工審核中 audit_refuse :人工審核拒絕 multi_audit_refuse :多人審批驗證中 multi_audit_fail :多人審批驗證失敗 success :劃轉成功 fail :劃轉失敗 | |
state | string | 狀態 | |
amount | number | 金額 | |
refuse | string | 拒絕原因 | |
createdTime | integer | 創建時間 | |
updatedTime | integer | 更新時間 |
UID劃轉
API Key 權限:寫權限
限頻值(NEW):100次/s
HTTP 請求
- POST
/v1/open/api/uid-transfer
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
toUid | true | integer | 收款方用戶uid | ||
phone | false | string | 收款方手機號後四位 | ||
currency | true | string | 幣種 | ||
amount | true | number | 金額 | ||
clientOrderId | true | string | 请求方唯一流水号 | ||
source | true | string | 来源 |
Request:
{
"amount": 1,
"currency": "btc",
"toUid": "1457228443811871",
"phone": "2346"
}
Response:
{
"code": 200,
"data": {
"clientOrderId": "1542076280883056640",
"status": "multi_audit"
},
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | object | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
clientOrderId | string | 劃轉訂單id |
賬號間劃轉
API Key 權限:寫權限
限頻值(NEW):100次/s
備註:用於母子賬號互相劃轉
HTTP 請求
- POST
/v2/account/account-transfer
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
fromUser | true | long | 付款方用戶id(非uid, uid 去掉最后一位) | ||
toUser | true | long | 收款方用戶id(非uid, uid 去掉最后一位) | ||
fromAccountType | true | string | 付款賬號類型 | custody | |
toAccountType | true | string | 收款賬號類型 | custody | |
currency | true | string | 幣種 | ||
amount | true | string | 金額 | ||
direction | true | int | 劃轉方向 | 1:母向子劃轉 2:子向母劃轉 | |
source | true | string | 客户标识 | 示例:custody | |
sourceOrderId | true | string | 客户订单id | 需要唯一 ,長度小於等於64 |
Request:
{
"fromAccountType": "custody",
"toUser": 11546800,
"sourceOrderId": "1488386774794272",
"amount": "100.000000000000000000",
"toAccountType": "custody",
"fromUser": 11582367,
"currency": "btc",
"source": "brokerage",
"direction": "2"
}
Response:
{
"code": 200,
"data": null
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) |
充幣相關
簡介
充幣相關接口提供了充幣地址查詢,充幣記錄查詢等功能。
充幣地址查詢
API Key 權限:讀取
限頻值(NEW):100次/s
HTTP 請求
- GET
/v1/open/address/get
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
uid | true | long | 用戶uid | ||
currency | true | string | 幣種 | ||
chain | true | string | 鏈 | ||
businessType | true | string | 賬號類型 | custody | custody(普通託管), dedicated(專戶託管) |
Request:
https://api.trust.newhuotech.com/v1/open/address/get?&uid=115460188&SignatureVersion=2&chain=btc&x-b3-traceid=3506b8c7ea7042bbbfd97092a12103cf&AccessKeyId=8f00e20e-vf25treb80-dcde4948-e5067&Signature=wYyL3cvYnL8uH63gf4C3xw798k0wSAmqVpWX4hjnt%2Bc%3D¤cy=btc&SignatureMethod=HmacSHA256&businessType=custody&Timestamp=2022-06-29T08%3A35%3A00
Response:
{
"code": 200,
"data": {
"address": "1CV37JenquEVC1Mu96X5aggV8g3uRmTveJ",
"businessType": "custody",
"tag": ""
},
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | object | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
id | long | 主鍵 | |
currency | string | 幣種 | |
chain | string | 鏈 | |
address | string | 地址 | |
businessType | string | 賬戶類型 | |
weight | integer | 權重 |
充幣記錄查詢
API Key 權限:讀取
限頻值(NEW):100次/s
HTTP 請求
- GET
/v1/open/deposit/list
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
currency | false | string | 幣種 | ||
startTime | false | long | 查詢起始時間(毫秒) | ||
endTime | false | long | 查詢結束時間(毫秒) | ||
updatedAtStartTime | false | long | 查詢起始時間(毫秒) | ||
updatedAtEndTime | false | long | 查詢結束時間(毫秒) | ||
type | false | string | |||
pagenum | false | int | 第幾頁 | 1 | |
pagesize | false | int | 每頁記錄數 | 10 | 0-200 |
state | false | int | 提幣狀態代碼集合(多個用英文逗號分隔) 提幣單狀態:(1, "pre-submitted"),(2, "invalid"),(3, "submitted"),(4, "reexamine"),(5, "canceled"),(6, "pass"),(7, "reject"),(8, "pre-transfer"),(9, "wallet-transfer"),(10, "wallet-reject"),(11, "confirmed"),(12, "confirm-error"),(13, "repealed"),(14, "normal-account-frozen"),(20, "created-without-risk-action"),(21, "account-frozen"),(22, "risk-action-assign"),(23, "risk-action-success"),(24, "risk-action-fail"),(25, "risk-action-timeout"),(30, "pre-withdraw-created"),(31, "pre-withdraw-confirmed"),(32, "pre-withdraw-launch-begin"),(33, "pre-withdraw-launch-success"),(34, "pre-withdraw-launch-failed"),(35, "pre-withdraw-canceled"),(40, "settlement-withdraw-processing"),(41, "settlement-withdraw-partially-completed"),(42, "settlement-withdraw-failed"),(43, "reexamine-reject"),(44, "reexamine-dismissed") |
Request:
https://api.trust.newhuotech.com/v1/open/deposit/list?&SignatureVersion=2&AccessKeyId=8f00e20e-vf25treb80-dcde4948-e5067&Signature=GRSQMbCet%2Br%2Bdib16hyFuafeS4WwC%2BC2vJm2mtzc4KA%3D&pagesize=1&SignatureMethod=HmacSHA256&pagenum=1&Timestamp=2022-06-29T08%3A38%3A22
Response:
{
"code": 200,
"data": {
"pagenum": 1,
"pagesize": 1,
"rows": 4,
"list": [
{
"currencyDisplayName": "USDT(ERC20)",
"amount": "60000.000000000000000000",
"blockchainConfirm": 99999999,
"createdAt": 1656301933428,
"currency": "usdt",
"depositSafeConfirms": 12,
"id": 1189,
"state": "safe",
"businessType": "custody",
"txHash": "JenquEVC1Mu96X12",
"userId": 11546018,
"type": "normal deposit"
}
]
},
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | object | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
pagenum | int | 第幾頁 | |
pagesize | int | 每頁記錄數 | |
rows | int | 總記錄數 | |
list | list | 數據列表 |
list字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
id | long | 訂單id | |
userId | long | 用戶id | |
currency | string | 幣種 | |
amount | string | 金額 | |
txHash | string | 交易Hash | |
depositSafeConfirms | int | 安全確認次數 | |
state | string | 狀態 | confirming(确认中),orphan(已孤立),orphan-confirming(孤立确认中),rphan-confirmed(孤立确认),rollback-orphan(上账后孤立),rollback-confirming(上账后孤立在确认),rollback-confirmed(上账后孤立在快速上账),orphan-safe(孤立安全), rollback-safe(上账后被孤立在安全上账),waiting-tiny-amount(等待小额上账),large-amount-examine(大额等待审核),confirmed(已确认),safe(已完成:安全上账) |
businessType | string | 賬戶類型 |
提幣相關
簡介
提幣相關接口提供了增加提幣地址,提幣地址列表,提幣手續費查詢,提幣,提幣記錄查詢,幣種查詢,鏈查詢等功能。
添加提幣地址
API Key 權限:劃轉
限頻值(NEW):100次/s
HTTP 請求
- POST
/v1/open/withdraw/address/add
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
currency | true | string | 幣種 | ||
chain | true | string | 鏈 | ||
address | true | string | 地址 | 長度小於等於100 | |
label | true | string | 地址標識 | 唯一,長度小於等於20 | |
withdrawTo | true | int | 是否用於提幣 | 1:是 0:否 | |
depositFrom | true | int | 是否用於充幣 | 1:是 0:否 | |
extra | true | string | 受益人信息 | 可填寫用戶的uid |
Request:
{
"chain": "usdterc20",
"address": "1CZ3AXtAcHLZJ9bnBN9df3KgkWWz8Mh4LW",
"authToken": "133aec05c3844356800bce6a53ac8e28",
"extra": "[email protected]",
"depositFrom": "0",
"currency": "usdt",
"label": "1488557514424352",
"withdrawTo": "1"
}
Response:
{
"code": 200,
"data": {
"orderId": 815,
"addressId": 11235,
"state": "DONE",
"riskActionV2Data": {
"orderId": 815,
"orderState": "DONE",
"actionToken": "3738414007889960960",
"actions": null,
"handlerDown": 0
}
}
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | object | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
orderId | long | 订单id | |
addressId | long | 地址id | |
state | string | 地址状态 | DONE(提交成功) FAIL(提交失败) |
提幣地址列表分頁查询
API Key 權限:讀取
限頻值(NEW):100次/s
HTTP 請求
- POST
/v1/open/withdraw/address/list
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
uid | false | long | 用户uid | ||
label | false | string | 地址標識 | ||
currency | false | string | 幣種 | ||
chain | false | string | 鏈 | ||
startTime | false | long | 查詢起始時間(毫秒) | ||
endTime | false | long | 查詢結束時間(毫秒) | ||
from | false | long | 查詢起始ID | ||
direct | false | string | 方向:prev 上一页, next下一页 | ||
size | false | int | 分頁查詢查詢結果條數(如不傳,默認每頁展示10條記錄,取值區間[1,20]) | ||
status | false | string | new 新建,failed 认证失败,whitelisted 认证成功 |
Request:
{
"from": 11171,
"direct": "next",
"size": 1
}
Response:
{
"code": 200,
"data": [
{
"currencyDisplayName": "ETH(ETH)",
"address": "bBcab6404e9f58E76eed6a0d09d6fbf3451a416F",
"chain": "eth",
"extra": "{\"addrProofFile\":[],\"authType\":30}",
"label": "ETH",
"tag": "",
"currency": "eth",
"createdAt": "1654509708456",
"updatedAt": "1654509708485",
"id": 11171,
"userId": 11546018,
"status": "whitelisted",
"withdrawTo": 1,
"organizationId": 0,
"depositFrom": 0,
"auditStatus": 2
}
],
"success": true
}
響應數據
參數名稱 | 是否必須 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|---|
code | true | integer | 狀態碼 | |
message | false | string | 錯誤描述(如有) | |
data | false | list | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
id | long | 地址id | |
currency | string | 幣種 | |
chain | string | 鏈 | |
address | string | 地址 | |
label | string | 地址標識 | |
status | string | new 新建,failed 认证失败,whitelisted 认证成功 | |
auditStatus | int | 上級審核狀態 1、审核中 2、通过 3、拒绝 | |
createdAt | long | 創建時間(時間戳) | |
updatedAt | long | 更新時間(時間戳) |
提幣費查詢
API Key 權限:讀取
限頻值(NEW):100次/s
使用場景:提幣時先查詢手續費,實際提幣金額=提幣金額-手續費
HTTP 請求
- GET
/v1/open/withdraw/getWithdrawFee
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
amount | true | string | 提幣金額(精度為幣種精度) | ||
currency | true | string | 幣種 | ||
chain | false | string | 鏈 |
Request:
https://api.trust.newhuotech.com/v1/open/withdraw/getWithdrawFee?&SignatureVersion=2&amount=1&chain=btc&AccessKeyId=8f00e20e-vf25treb80-dcde4948-e5067&Signature=NW6%2FA5RvHjT8lDZri3fimLhEtBTSaAeKKxj%2FBr9fyOg%3D¤cy=btc&SignatureMethod=HmacSHA256&Timestamp=2022-06-29T08%3A49%3A39
Response:
{
"code": 200,
"data": "0.11111111",
"success": true
}
響應數據
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
code | integer | 狀態碼 | |
message | string | 錯誤描述(如有) | |
data | string | 業務數據: 手續費值 |
提幣
API Key 權限:提幣
限頻值(NEW):100次/s
注意事項:實際提幣金額=提幣金額-手續費
HTTP 請求
- POST
/v1/open/withdraw/doWithdraw
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
amount | true | string | 實際提幣金額(精度為幣種精度) | ||
currency | true | string | 幣種 | ||
chain | true | string | 鏈 | ||
toAddressId | true | string | 地址id | ||
toAddress | true | string | 地址 | ||
toAddressLabel | false | string | 地址標識 | ||
withdrawType | false | string | 提幣類型 | fast(快速提幣),normal(普通提幣) | |
sourceOrderId | true | string | 客戶訂單id(不能重複) | 長度<=64 | |
source | true | string | 客戶方標識(一個客戶固定一個值) | 示例:custody | |
uid | true | string | 用戶uid | ||
fees | false | string | 手續費(調用手續費接口獲取) |
Request:
{
"sourceOrderId": "1488574459412512",
"uid": 115468007,
"amount": "169999.000000000000000000",
"chain": "usdterc20",
"fees": "1.000000000000000000",
"withdrawType": "fast",
"currency": "usdt",
"source": "brokerage",
"toAddress": "1EgLXFgzx9K6o6uvsP6BxB7V8iEuLEiWqQ",
"toAddressLabel": "1488560116989984",
"toAddressId": 11236
}
Response:
{
"code": 200,
"data": {
"withdrawOrderId": "55476840"
}
}
響應數據
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
code | integer | 狀態碼 | |
message | string | 錯誤描述(如有) | |
data | object | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
withdrawOrderId | long | 訂單id | |
withdrawCreateResponse | object | 訂單信息 |
withdrawCreateResponse字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
orderId | long | 訂單id | |
riskActionV2Data | object | 風控信息 |
riskActionV2Data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
orderState | string | 訂單狀態 |
提幣記錄查詢
API Key 權限:讀取
限頻值(NEW):100次/s
HTTP 請求
- GET
/v1/open/withdraw/allList
請求參數
參數名稱 | 是否必須 | 類型 | 描述 | 默認值 | 取值範圍 |
---|---|---|---|---|---|
uid | false | long | 用戶uid | ||
currency | false | string | 幣種 | ||
startTime | false | long | 時間戳 | ||
endTime | false | long | 時間戳 | ||
updatedAtStartTime | false | long | 查詢起始時間(毫秒) | ||
updatedAtEndTime | false | long | 查詢結束時間(毫秒) | ||
pagesize | false | int | 每页显示条数 | 10 | 0-200 |
pagenum | false | int | 第几页 | ||
ids | false | string | 提幣訂單id,多個用,分割 |
Request:
https://api.trust.newhuotech.com/v1/open/withdraw/allList?&SignatureVersion=2&AccessKeyId=8f00e20e-vf25treb80-dcde4948-e5067&Signature=zoc5DtPgKrBJV0adV%2Fq%2Fsi38YE5XtZQqon6Pr9ZDUpA%3D&pagesize=1&SignatureMethod=HmacSHA256&pagenum=1&Timestamp=2022-06-29T08%3A52%3A34
Response:
{
"code": 200,
"data": {
"pagenum": 1,
"pagesize": 1,
"rows": 1,
"list": [
{
"currencyDisplayName": "BTC(BTC)",
"id": 55473740,
"type": "fast withdraw",
"userId": 11546018,
"currency": "btc",
"amount": "10.000000000000000000",
"fees": "0.000000000000000000",
"state": "4",
"dwState": "confirmed",
"txHash": "",
"chain": "btc",
"toAddress": "1F5XbLksc33XrzdYAxACgGDWF9jAHeA7Hq",
"toAddrTag": "",
"createAt": 1656232131197,
"updateAt": 1656492721745,
"errorCode": "",
"errorMsg": "",
"walletUpdateAt": 1656232131321,
"withdrawType": 1,
"amlResult": "{\"process-status\":null,\"id\":null,\"error\":null,\"risk-score\":null,\"aml-support\":true,\"new-address\":null,\"error-msg\":\"\"}",
"basicAuditState": "2",
"gas": "0",
"gasCurrency": "",
"businessType": "custody",
"safeConfirms": 0,
"walletConfirms": 0
}
]
},
"success": true
}
響應數據
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
code | integer | 狀態碼 | |
message | string | 錯誤描述(如有) | |
data | object | 業務數據 |
data字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
pagesize | int | 每页显示条数 | |
pagenum | int | 第几页 | |
rows | int | 總記錄數 | |
list | list | 業務數據 |
list字段說明
參數名稱 | 數據類型 | 描述 | 取值範圍 |
---|---|---|---|
id | long | 訂單id | |
type | sting | 提幣類型 | |
currency | string | 幣種 | |
chain | string | 鏈 | |
toAddress | string | 地址 | |
amount | string | 金額 | |
feee | string | 手續費 | |
createAt | long | 創建時間(時間戳) | |
upateAt | long | 更新時間(時間戳) | |
state | string | 狀態 | -1(初始化),1(待審核),2(初審通過),3(初審拒絕),4(複審通過),5(複審拒絕),6(複審駁回),11(自動審核),99(無效記錄) |
dwState | string | 提幣狀態 | pre-submitted(待提交),submitted(已提交),reexamine(等待再次确认),canceled(已撤销),pass(审批通过),pre-transfer(钱包转账中),wallet-transfer(钱包已转账), normal-account-frozen(普通冻结),created-without-risk-action(提币触发风控),account-frozen(冻结成功),risk-action-assign(风控验证), risk-action-success(风控验证成功),risk-action-fail(风控验证失败),risk-action-timeout(风控动作超时), settlement-withdraw-processing(结算进行中),settlement-withdraw-partially-completed(结算部分完成), invalid(错误),reject(审批拒绝),wallet-reject(钱包拒绝),confirm-error(区块确认失败),repealed(人工撤销),settlement-withdraw-failed(结算失败), reexamine-reject(复审拒绝),reexamine-dismissed(复审驳回),confirmed(区块已确认) |