# CoinGet篇

## 获取收币地址 <a href="#huo-qu-shou-bi-di-zhi" id="huo-qu-shou-bi-di-zhi"></a>

通过CoinsDo API可快速获取海量收币地址，分发给用户完成收币，无需额外接入第三方支付系统。

<figure><img src="https://254105150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx1sJpsLJyJ12eTG1bUgP%2Fuploads%2FlAnpmK7dNvDpG9LGbWsn%2Fimage.png?alt=media&#x26;token=7d1884ed-f409-41a7-a000-73045bdf80e2" alt=""><figcaption></figcaption></figure>

1. 企业部署的归集钱包自动生成批量地址
2. 归集钱包客户端将签名后的地址提交给CoinsDo服务器
3. 企业透过CoinsDo API请求带有签名的地址
4. 企业业务服务器对地址进行验签保证地址来自企业归集钱包客户端

### **接口描述**

* 获取指定链、指定钱包的收币地址

### **请求地址**

* `{URL}/v1/addressGet`

### **请求方式**

* POST

### **请求参数**

* Body 参数

<table><thead><tr><th width="137">参数名</th><th width="81">必填</th><th width="95">类型</th><th>说明</th></tr></thead><tbody><tr><td>data</td><td>是</td><td>string</td><td>内容（JSON字符串，如下）</td></tr></tbody></table>

```json
{
    "apiKey": "cd384rt80f5575dc",
    "mainnet": "TRX",
    "targetDeviceUuid": "085C28EC-0BD6-442B-8232-D23BC8F4D58E",
    "timestamp": "1622775712229",
    "addressRemark": "trx address"
}
```

* data 参数

<table><thead><tr><th width="186">参数名</th><th width="73">必填</th><th width="105">类型</th><th>说明</th></tr></thead><tbody><tr><td>apiKey</td><td>是</td><td>String</td><td>API KEY</td></tr><tr><td>mainnet</td><td>是</td><td>String</td><td>主网络(参数见币种列表)</td></tr><tr><td>targetDeviceUuid</td><td>是</td><td>String</td><td>指定归集钱包</td></tr><tr><td>timestamp</td><td>是</td><td>String</td><td>时间戳(秒或毫秒)</td></tr><tr><td>addressRemark</td><td>否</td><td>String</td><td>地址的备注</td></tr><tr><td>isConvert</td><td>否</td><td>String</td><td>是否需要转换地址(0.否 1.是，默认为否，目前只有BCH会使用到，转换的地址为经典地址)</td></tr></tbody></table>

### **请求示例1**

```json
{
    "data": "{\"apiKey\":\"cd384rt80f5575dc\",\"mainnet\":\"TRX\",\"targetDeviceUuid\":\"085C28EC-0BD6-442B-8232-D23BC8F4D58E\",\"timestamp\":\"1622775712229\",\"addressRemark\":\"trx address\"}",
    "sign": "67355f9ad0db846edd05761462edfc1f8d396af2624e8998ee52c010c7a60dbd"
}
```

### **请求示例2**

```json
{
    "data":"{\"mainnet\":\"BCH\",\"targetDeviceUuid\":\"92E30E38-63A1-41DC-B95C-8E729DFDDE7A\",\"apiKey\":\"4c90b98cc97b45b2\",\"isConvert\":\"1\",\"timestamp\":2639477935817}",
    "sign":"7d9ae0b10068422ff30be92f45bdda0fe69bf405224564cefdc81775241d4081"
}
```

### **返回示例1**

```json
{
    "code": 200, // 状态码
    "msg": "成功", // 提示信息
    "data": {
        "address": "TKU69qcQPoR5jDEE7ertPpdaxoLGCTX4xR",
        "addrSign": "TESTTESTU4u0dj5xXEoZ9E4EXSes9WawqfpxrRfOIHgXV1BnPNM2tt0DLloCnJkzR7smC26+z6kuZb87s3hitZWgM3UaWWghB8/qNMQImvCZ6MREqChoNmEVyaqCnTbjorKsrU/V0=",
        "convertedAddr": null
    }
}
```

### **返回示例2**

```json
{
    "code": 200,
    "msg": "成功",
    "data": {
        "address": "bchtest:qzfr5996z72me99flf32jf6yfs38hshcwcp3dx8eja",
        "addrSign": "ZJA+/GJGNUXFw2soBGBaEbWFSOPtNMD8eRdVLTyZyuKHjnyklWvGe8SqkV8xxhwlFcT1+td9AbKstLD6b+lJ4jSCIqm5WbcMJjo0k1mCdihAagsbn5zVyTYEO7LQac341wP/76jopdYnH/yVvP5VtcNq8ZgkrcOi08ReLaQsMO8=",
        "convertedAddr": "mtr8XbbzhJVG2TYy3bYFxfV5TBw8PSEzkB"
    }
}

```

* data 参数

<table><thead><tr><th width="162">参数名</th><th width="66">必填</th><th width="91">类型</th><th>说明</th></tr></thead><tbody><tr><td>address</td><td>是</td><td>String</td><td>收币地址</td></tr><tr><td>addrSign</td><td>是</td><td>String</td><td>收币地址签名(可用钱包公钥对地址验签)</td></tr><tr><td>convertedAddr</td><td>否</td><td>String</td><td>转换后的地址(目前只有BCH会使用到，转换后地址为LegacyAddr/经典地址， 回调只会以address字段回调 )</td></tr></tbody></table>

### **返回状态码**

<table><thead><tr><th width="164">状态码</th><th>说明</th></tr></thead><tbody><tr><td>4042</td><td>查询归集钱包失败</td></tr><tr><td>4043</td><td>归集钱包不存在</td></tr><tr><td>4044</td><td>获取收币地址失败</td></tr><tr><td>4045</td><td>地址数量不足</td></tr><tr><td>4050</td><td>主网络暂不支持</td></tr><tr><td>4051</td><td>EOS链网络无需获取收币地址</td></tr><tr><td>4052</td><td>代币无需获取收币地址</td></tr><tr><td>4053</td><td>BCH地址转换失败</td></tr><tr><td>4061</td><td>查询关联链记录失败</td></tr><tr><td>4062</td><td>关联币种不能单独获取地址</td></tr><tr><td>4063</td><td>查询矿工费地址失败</td></tr><tr><td>4064</td><td>主网络不支持，请更新版本</td></tr><tr><td>4071</td><td>请指定主网络</td></tr><tr><td>4072</td><td>检查支持的主网络失败</td></tr></tbody></table>

***

## BCH地址转换 <a href="#bch" id="bch"></a>

BCH 地址格式：Legacy格式(经典地址)和CashAddr格式(标准地址)，CoinsDo提供此BCH地址转换API以兼容用户不同格式的地址

### **接口描述**

* 当BCH地址不被兼容时，可使用此接口进行转换

### **请求地址**

* `{URL}/v1/bchAddrConvert`

### **请求方式**

* POST
* Body 参数

<table><thead><tr><th width="153">参数名</th><th width="94">必填</th><th width="98">类型</th><th>说明</th></tr></thead><tbody><tr><td>data</td><td>是</td><td>string</td><td>内容（JSON字符串，如下）</td></tr></tbody></table>

```json
{
    "apiKey": "4c90b98cc97b45b2",
    "address": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
    "timestamp": "2639474345487"
}
```

* data 参数

<table><thead><tr><th width="156">参数名</th><th width="87">必填</th><th width="95">类型</th><th>说明</th></tr></thead><tbody><tr><td>apiKey</td><td>是</td><td>String</td><td>API KEY</td></tr><tr><td>address</td><td>是</td><td>String</td><td>BCH地址，Legacy格式(经典地址)或CashAddr格式(标准地址)</td></tr><tr><td>timestamp</td><td>是</td><td>String</td><td>时间戳(秒或毫秒)</td></tr></tbody></table>

### **请求示例1**

```json
{
    "data":"{\"apiKey\":\"4c90b98cc97b45b2\",\"address\":\"msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s\",\"timestamp\":\"2639474345487\"}",
    "sign":"fc2ed2d7713a499ff718e69507cb95b1a49ac00f4be1daf34187381b8afc43c9"
}
```

### **请求示例2**

```json
{
    "data":"{\"apiKey\":\"4c90b98cc97b45b2\",\"address\":\"bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca\",\"timestamp\":\"2639474345487\"}",
    "sign":"7acecc69f1b8c05be5ebfc8435d9fea0cf39aa9138af22084f3a9aa96b323844"
}
```

### **返回示例1**

```json
{
    "code": 200,
    "msg": "成功",
    "data": {
        "legacyAddr": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
        "cashAddr": "bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca"
    }
}
```

### **返回示例2**

```json
{
    "code": 200,
    "msg": "成功",
    "data": {
        "legacyAddr": "msGoSKtnZyyw5QSu53zerPmuT4wdnhXg3s",
        "cashAddr": "bchtest:qzq0gjkv2qmwe0ph25nuh28c2gxn7dezqgvc8c2aca"
    }
}
```

* data 参数

<table><thead><tr><th width="163">参数名</th><th width="86">必填</th><th width="104">类型</th><th>说明</th></tr></thead><tbody><tr><td>legacyAddr</td><td>是</td><td>String</td><td>Legacy格式(经典地址)</td></tr><tr><td>cashAddr</td><td>是</td><td>String</td><td>CashAddr格式(标准地址)</td></tr></tbody></table>

### **返回状态码**

<table><thead><tr><th width="166">状态码</th><th>说明</th></tr></thead><tbody><tr><td>4053</td><td>BCH地址转换失败</td></tr><tr><td>4054</td><td>BCH地址格式有误</td></tr><tr><td>4055</td><td>校验BCH地址失败</td></tr></tbody></table>

***

## **回调通知** <a href="#hui-tiao-tong-zhi" id="hui-tiao-tong-zhi"></a>

通过回调通知API将归集收币到账确认状态通知至商户后台设置的回调URL。

### **请求方式**

* POST

### **请求参数**

* Body 参数

<table><thead><tr><th width="165">参数名</th><th width="82">必填</th><th width="97">类型</th><th>说明</th></tr></thead><tbody><tr><td>data</td><td>是</td><td>String</td><td>内容（JSON字符串，如下）</td></tr></tbody></table>

### **收币通知**

<figure><img src="https://254105150-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2Fx1sJpsLJyJ12eTG1bUgP%2Fuploads%2Fli8hMAX0RPJErum4vCpE%2Fimage.png?alt=media&#x26;token=13d387eb-da94-4c0e-8628-c371ddca4da9" alt=""><figcaption></figcaption></figure>

1. CoinsDo的钱包节点检测到钱包地址有充值后通知企业部署的CoinGet客户端
2. 企业CoinGet客户端对地址进行验签保证地址是属于自己的钱包
3. 企业CoinGet客户端透过第三方区块链浏览器验证充值
4. 验证成功后通知企业CoinGet客户端
5. 当CoinGet钱包客户端收到验证成功后会对信息进行签名然后提交给CoinsDo服务器
6. 企业透过CoinsDo API接收带有签名的回调信息
7. 企业业务服务器对信息进行验签保证信息来自企业CoinGet客户端

***

#### 链上达到一个确认数通知

主币：

```json
{
    "coinType": "0",
    "deviceUuid": "B65EB9AC-75DB-4B08-A84A-1C70349E61E8",
    "blockConfirm": "1",
    "amount": "0.012",
    "flag": "BCH",
    "txTime": "1660604310",
    "mainnet": "BCH",
    "toAddress": "bchtest:qzc0k3j8a8gq3egaw4n7xxd6eanp9vehnuwcu4teup",
    "isReachedConfirm": "0",
    "tokenAddress": "",
    "protocol": "",
    "blockNumber": "1513202",
    "txFee": "0.00001",
    "coinsDoId": "9",
    "fromAddress": "bchtest:qpn3cx8vqd22ut5lpkd0xqzda65nlxphwgu3v7v4na",
    "currency": "BCH",
    "coinName": "BCH",
    "txHash": "e5223b3cce8c54514394e728972a0056ef487b3295026412e12a4bc47cfd659e",
    "txIndex": "0"
}

```

协议：

```json
{ 
    "coinType": "1",
    "deviceUuid": "B65EB9AC-75DB-4B08-A84A-1C70349E61E8",
    "blockConfirm": "1",
    "amount": "5",
    "flag": "TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3",
    "txTime": "1661336430",
    "mainnet": "TRX",
    "toAddress": "TKTBQ6zk8fQazY1r2vJys6VanoiWmJDXqh",
    "isReachedConfirm": "0",
    "txMemo": "0",
    "tokenAddress": "TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3",
    "protocol": "TRC20",
    "blockNumber": "29232059",
    "txFee": "8.34196",
    "coinsDoId": "38",
    "fromAddress": "TNX41cJ4Cy3WKd6NVkqtUp6nbrGLmT5Vy9",
    "currency": "TRC20",
    "coinName": "JST",
    "txHash": "b29e917066ed433b5d2753ae07a9b4bd71245509f8f9de51ec5a2e43425f91a8",
    "txIndex": "0"
}

```

#### 请求示例

主币：

```json
{
    "data": "{\"coinType\":\"0\",\"deviceUuid\":\"B65EB9AC-75DB-4B08-A84A-1C70349E61E8\",\"blockConfirm\":\"1\",\"amount\":\"0.012\",\"flag\":\"BCH\",\"txTime\":\"1660604310\",\"mainnet\":\"BCH\",\"toAddress\":\"bchtest:qzc0k3j8a8gq3egaw4n7xxd6eanp9vehnuwcu4teup\",\"isReachedConfirm\":\"0\",\"tokenAddress\":\"\",\"protocol\":\"\",\"blockNumber\":\"1513202\",\"txFee\":\"0.00001\",\"coinsDoId\":\"9\",\"fromAddress\":\"bchtest:qpn3cx8vqd22ut5lpkd0xqzda65nlxphwgu3v7v4na\",\"currency\":\"BCH\",\"coinName\":\"BCH\",\"txHash\":\"e5223b3cce8c54514394e728972a0056ef487b3295026412e12a4bc47cfd659e\",\"txIndex\":\"0\"}",
    "sign": "ef7a1fc9cebe9b135954c8a1a4263c06f9b05e5cb608bdeed45e1c64f4f67b26"
}
```

协议：

```json
{
    "data": "{\"coinType\":\"1\",\"deviceUuid\":\"B65EB9AC-75DB-4B08-A84A-1C70349E61E8\",\"blockConfirm\":\"1\",\"amount\":\"5\",\"flag\":\"TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3\",\"txTime\":\"1661336430\",\"mainnet\":\"TRX\",\"toAddress\":\"TKTBQ6zk8fQazY1r2vJys6VanoiWmJDXqh\",\"isReachedConfirm\":\"0\",\"txMemo\":\"0\",\"tokenAddress\":\"TF17BgPaZYbz8oxbjhriubPDsA7ArKoLX3\",\"protocol\":\"TRC20\",\"blockNumber\":\"29232059\",\"txFee\":\"8.34196\",\"coinsDoId\":\"38\",\"fromAddress\":\"TNX41cJ4Cy3WKd6NVkqtUp6nbrGLmT5Vy9\",\"currency\":\"TRC20\",\"coinName\":\"JST\",\"txHash\":\"b29e917066ed433b5d2753ae07a9b4bd71245509f8f9de51ec5a2e43425f91a8\",\"txIndex\":\"0\"}",
    "sign": "1ca1cf273bab9f63b5b1dcbbf72d1a56efab7ea4e3e7e2bbc1e7710e130c3f9f"
}
```

#### 达到指定链上确认数收币通知

主币：

```json
 {
    "coinType": "0",
    "deviceUuid": "85FE7308-A6B8-4D17-9849-1077FC082BA3",
    "blockConfirm": "250",
    "amount": "0.0501",
    "flag": "ETC",
    "checkSign": "aHo/lkSIgYqh76sK3DQi3HdPJJ1BcftunimAnub6ucl8rTnlj4HcXfczgIyhkr4HcOrFqF1PAentnEvRKGu8BzwoxmOyWyHMxjJjYSnLmO9/53MoQ/1Y/0+tS+7YQo0WWa3A2gdnRjGaHoIjLBn5WynM15zgXnEeCiN4qlHEu6o=",
    "txTime": "1673328422",
    "mainnet": "ETC",
    "toAddress": "0x9975843827d799262f2b4209489e9232d52b9a53",
    "isReachedConfirm": "1",
    "checkCode": "0",
    "feeSymbol": "ETC",
    "tokenAddress": "",
    "recordId": "4590533727417345",
    "protocol": "",
    "checkMode": "0",
    "blockNumber": "7954343",
    "txFee": "0.000105",
    "coinsDoId": "7",
    "fromAddress": "0x5e27188508a19e8884ab6a268a39964932301553",
    "currency": "ETC",
    "coinName": "ETC",
    "txHash": "0xb2377b314be008590b70d5ca81892e3d4169a567df7ac2cf810618f30ea68687",
    "txIndex": "null"
}
```

协议：

```json
{
    "coinType": "1",
    "deviceUuid": "85FE7308-A6B8-4D17-9849-1077FC082BA3",
    "blockConfirm": "15",
    "amount": "10.1",
    "flag": "0x378da755324ee4f1a5735a4f13499a410d82d122",
    "checkSign": "BLVMetTZSNEzI2apnOpSRIdhrwDjyAsOVpJprEHZeWsrL4CGq3t50G1L7MjIlVFknEaAmvlKFgLu22oEhD4NRZOUU7rIcfTldzWpYct8s+/Ais9LMqCu3Uw0mfhYXO7fB11BA3q+glaH0JEQ1Wnmcvt5OIfzlCW2rG9vethipxY=",
    "txTime": "1673328446",
    "mainnet": "BSC",
    "toAddress": "0x30a5c679978b8ab5bfb8b31123366d405d5efa62",
    "isReachedConfirm": "1",
    "checkCode": "0",
    "feeSymbol": "BNB",
    "tokenAddress": "0x378da755324ee4f1a5735a4f13499a410d82d122",
    "recordId": "4590542064244737",
    "protocol": "BEP20",
    "checkMode": "0",
    "blockNumber": "26216212",
    "txFee": "0.00051248",
    "coinsDoId": "139",
    "fromAddress": "0xcbb98240d7cf185ef8c3867d2aa56e500d103d17",
    "currency": "BEP20",
    "coinName": "CD",
    "txHash": "0x2f8160ad2ab556be36003a77087968387843ef9104fa7bca5fda5a1f7b2c6c1d",
    "txIndex": "4"
}

```

#### 请求示例

主币：&#x20;

```json
{
    "data": "{\"coinType\":\"0\",\"deviceUuid\":\"85FE7308-A6B8-4D17-9849-1077FC082BA3\",\"blockConfirm\":\"250\",\"amount\":\"0.0501\",\"flag\":\"ETC\",\"checkSign\":\"aHo/lkSIgYqh76sK3DQi3HdPJJ1BcftunimAnub6ucl8rTnlj4HcXfczgIyhkr4HcOrFqF1PAentnEvRKGu8BzwoxmOyWyHMxjJjYSnLmO9/53MoQ/1Y/0+tS+7YQo0WWa3A2gdnRjGaHoIjLBn5WynM15zgXnEeCiN4qlHEu6o=\",\"txTime\":\"1673328422\",\"mainnet\":\"ETC\",\"toAddress\":\"0x9975843827d799262f2b4209489e9232d52b9a53\",\"isReachedConfirm\":\"1\",\"checkCode\":\"0\",\"feeSymbol\":\"ETC\",\"tokenAddress\":\"\",\"recordId\":\"4590533727417345\",\"protocol\":\"\",\"checkMode\":\"0\",\"blockNumber\":\"7954343\",\"txFee\":\"0.000105\",\"coinsDoId\":\"7\",\"fromAddress\":\"0x5e27188508a19e8884ab6a268a39964932301553\",\"currency\":\"ETC\",\"coinName\":\"ETC\",\"txHash\":\"0xb2377b314be008590b70d5ca81892e3d4169a567df7ac2cf810618f30ea68687\",\"txIndex\":\"null\"}",
    "sign": "99b488151db83010585d711fe890dad1a15217d288dd6a74411471616044cba9"
}
```

协议：

```json
{
    "data": "{\"coinType\":\"1\",\"deviceUuid\":\"85FE7308-A6B8-4D17-9849-1077FC082BA3\",\"blockConfirm\":\"15\",\"amount\":\"10.1\",\"flag\":\"0x378da755324ee4f1a5735a4f13499a410d82d122\",\"checkSign\":\"BLVMetTZSNEzI2apnOpSRIdhrwDjyAsOVpJprEHZeWsrL4CGq3t50G1L7MjIlVFknEaAmvlKFgLu22oEhD4NRZOUU7rIcfTldzWpYct8s+/Ais9LMqCu3Uw0mfhYXO7fB11BA3q+glaH0JEQ1Wnmcvt5OIfzlCW2rG9vethipxY=\",\"txTime\":\"1673328446\",\"mainnet\":\"BSC\",\"toAddress\":\"0x30a5c679978b8ab5bfb8b31123366d405d5efa62\",\"isReachedConfirm\":\"1\",\"checkCode\":\"0\",\"feeSymbol\":\"BNB\",\"tokenAddress\":\"0x378da755324ee4f1a5735a4f13499a410d82d122\",\"recordId\":\"4590542064244737\",\"protocol\":\"BEP20\",\"checkMode\":\"0\",\"blockNumber\":\"26216212\",\"txFee\":\"0.00051248\",\"coinsDoId\":\"139\",\"fromAddress\":\"0xcbb98240d7cf185ef8c3867d2aa56e500d103d17\",\"currency\":\"BEP20\",\"coinName\":\"CD\",\"txHash\":\"0x2f8160ad2ab556be36003a77087968387843ef9104fa7bca5fda5a1f7b2c6c1d\",\"txIndex\":\"4\"}",
    "sign": "2efb88ef2043329e60a5dad1cabc622fd076c1d1fa45648c799a0529e3babf39"
}
```

### 收币通知 data 参数

<table><thead><tr><th width="191">参数名</th><th width="83">必填</th><th width="105">类型</th><th>说明</th></tr></thead><tbody><tr><td>txHash</td><td>是</td><td>String</td><td>交易哈希</td></tr><tr><td>txIndex</td><td>否</td><td>String</td><td>交易下标(不是每个币种都有，例如BTC的交易序号、ERC20和TRC20的日志序号)</td></tr><tr><td>fromAddress</td><td>是</td><td>String</td><td>发送地址</td></tr><tr><td>toAddress</td><td>是</td><td>String</td><td>接收地址</td></tr><tr><td>amount</td><td>是</td><td>String</td><td>收币数量</td></tr><tr><td>txFee</td><td>是</td><td>String</td><td>矿工费</td></tr><tr><td>feeSymbol</td><td>是</td><td>String</td><td>矿工费单位/标识</td></tr><tr><td>txTime</td><td>是</td><td>String</td><td>交易确认时间戳(秒)</td></tr><tr><td>txMemo</td><td>否</td><td>String</td><td>链上备注(目前仅支持TRX和TRC20、EOS、XRP)</td></tr><tr><td>blockNumber</td><td>是</td><td>String</td><td>区块高度</td></tr><tr><td>deviceUuid</td><td>是</td><td>String</td><td>地址所属钱包标识</td></tr><tr><td>checkMode</td><td>是</td><td>String</td><td>核查方式(0.钱包对地址的核查+第三方API对收币记录的核查)</td></tr><tr><td>isReachedConfirm</td><td>是</td><td>String</td><td>是否达到确认数(0.未达到 1.已达到)</td></tr><tr><td>blockConfirm</td><td>是</td><td>String</td><td>确认区块数</td></tr><tr><td>checkSign</td><td>否</td><td>String</td><td>客户端对收币记录的核查结果的签名</td></tr><tr><td>addressRemark</td><td>否</td><td>String</td><td>接收地址的备注</td></tr><tr><td>mainnet</td><td>是</td><td>String</td><td>主网络名称</td></tr><tr><td>coinName</td><td>是</td><td>String</td><td>币种名称(参数见币种列表)</td></tr><tr><td>coinsDoId</td><td>是</td><td>String</td><td>币种ID(参数见币种列表)</td></tr><tr><td>protocol</td><td>是</td><td>String</td><td>协议(参数见币种列表)</td></tr><tr><td>tokenAddress</td><td>是</td><td>String</td><td>代币地址(参数见币种列表)</td></tr><tr><td>coinType</td><td>是</td><td>String</td><td>币种类型(参数见币种列表)</td></tr><tr><td>recordId</td><td>是</td><td>String</td><td>COINSDO收币记录ID</td></tr><tr><td>checkCode</td><td>否</td><td>String</td><td>核查结果(参数详情如下)</td></tr></tbody></table>

<table><thead><tr><th width="193">checkCode</th><th width="184">地址核查</th><th width="187">交易核查</th><th>说明</th></tr></thead><tbody><tr><td>-1</td><td>核查异常</td><td>核查异常</td><td>未知错误</td></tr><tr><td>0</td><td>核查成功</td><td>核查成功</td><td>核查成功</td></tr><tr><td>1</td><td>核查异常</td><td>未核查</td><td>地址不存在</td></tr><tr><td>2</td><td>核查成功</td><td>核查成功</td><td>数据不匹配</td></tr><tr><td>3</td><td>核查成功</td><td>核查异常</td><td>交易失败</td></tr><tr><td>4</td><td>核查成功</td><td>核查异常</td><td>核查交易失败</td></tr><tr><td>5</td><td>核查成功</td><td>核查异常</td><td>交易未找到</td></tr><tr><td>6</td><td>核查成功</td><td>关闭核查</td><td>核查关闭</td></tr><tr><td>7</td><td>核查异常</td><td>未核查</td><td>地址未找到</td></tr></tbody></table>

```
 ❗客户端在线状态方可进行核查，关闭核查将忽略客户端的核查直接回调；正常情况下核查成功后将会回调，如遇核查异常情况则核查超过10次后再回调
 ❗关闭了核查请忽略checkSign，因为该字段可能为空

 ❗核查的签名验签规则：
    使用RSA-SHA256验证钱包公钥对签名数据和签名的结果
    签名数据是由checkCode+recordId+txHash组成

    比如请求示例中checkCode是0;
    recordId是4590542064244737;
    txHash是0x2f8160ad2ab556be36003a77087968387843ef9104fa7bca5fda5a1f7b2c6c1d;
    签名数据就是045905420642447370x2f8160ad2ab556be36003a77087968387843ef9104fa7bca5fda5a1f7b2c6c1d，
    85FE7308-A6B8-4D17-9849-1077FC082BA3的钱包公钥是MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCYmbkVn95lUPYZTybd68Bm5CoW0UjMpEQijaGZLPm6NH0YGJiPsQa6n3jBWEm2zhiG+oLAjZnNNl+SPxEO7dJC/PhTCuFp1muGOn5xm6ItS11ByEbAOZrSMWkV7mqFQZQkTZw0tHGP7X8AqoiXClFwc+m/lkVawHqq2NUSJbafJQIDAQAB，
    checkSign(签名结果)是BLVMetTZSNEzI2apnOpSRIdhrwDjyAsOVpJprEHZeWsrL4CGq3t50G1L7MjIlVFknEaAmvlKFgLu22oEhD4NRZOUU7rIcfTldzWpYct8s+/Ais9LMqCu3Uw0mfhYXO7fB11BA3q+glaH0JEQ1Wnmcvt5OIfzlCW2rG9vethipxY=
```

```
 ❗建议直接使用coinsDoId判断是什么币种到账，或者根据mainnet + coinType判断，例：
    主币：mainnet=ETH coinType=0 就是coinsDoId为2的币种ETH，
    代币：mainnet=ETH coinType=1 ，再根据tokenAddress判断是什么币种，比如tokenAddress=0xdac17f958d2ee523a2206206994597c13d831ec7就是coinsDoId为6的币种USDT

 ❗coinName不能做币种到账判断，只做展示作用，因为同个链可能存在相同币种名称
```

**返回示例**

```json
{
    "code": 200, // 状态码
    "msg": "成功", // 提示信息
    "data": null //返回信息 
}
```

***

## 手动归集 <a href="#shou-dong-gui-ji" id="shou-dong-gui-ji"></a>

未触发自动归集时，支持人工手动发起归集操作，可全额或定额归集。

### **接口描述**

* 请求提交成功后，需等待CoinGet客户端处理，归集结果需查看归集记录或钱包客户端日志

### **请求地址**

* `{URL}/v1/manualCollect`

### **请求方式**

* POST
* Body 参数

<table><thead><tr><th width="181">参数名</th><th width="80">必填</th><th width="127">类型</th><th>说明</th></tr></thead><tbody><tr><td>data</td><td>是</td><td>String</td><td>内容（JSON字符串，如下）</td></tr></tbody></table>

```json
{
    "apiKey": "4c90b98cc97b45b2",
    "address": "0xd065380c78847bfba75ad158067a5e8e845205f0",
    "coinsDoId": "22",
    "collectAmount": "0.12",
    "timestamp": "1671699594204"
}
```

* data 参数

<table><thead><tr><th width="191">参数名</th><th width="77">必填</th><th width="126">类型</th><th>说明</th></tr></thead><tbody><tr><td>apiKey</td><td>是</td><td>String</td><td>API KEY</td></tr><tr><td>address</td><td>是</td><td>String</td><td>收币地址</td></tr><tr><td>coinsDoId</td><td>是</td><td>String</td><td>币种ID(参数见币种列表)</td></tr><tr><td>collectAmount</td><td>否</td><td>String</td><td>归集数量(不填将归集可用余额)</td></tr><tr><td>timestamp</td><td>是</td><td>String</td><td>时间戳(秒或毫秒)</td></tr></tbody></table>

### **请求示例1**

```json
{
    "data":"{\"address\":\"0xd065380c78847bfba75ad158067a5e8e845205f0\",\"apiKey\":\"4c90b98cc97b45b2\",\"coinsDoId\":\"22\",\"timestamp\":\"1671698862478\"}",
    "sign":"bca9130ebc1998e2fea8c81bf480f13dbdd7259f05ac7019f47a70bc8bae407f"
}
```

### **请求示例2**

```json
{
    "data":"{\"address\":\"0xd065380c78847bfba75ad158067a5e8e845205f0\",\"apiKey\":\"4c90b98cc97b45b2\",\"coinsDoId\":\"22\",\"collectAmount\":\"0.12\",\"timestamp\":\"1671699594204\"}",
    "sign":"278682f15ae9afba34566b79eb26d90b1ba5d5542f53a2a6b650542265aac429"
}
```

### **返回示例**

```json
{
    "code": 200, // 状态码
    "msg": "成功", // 提示信息
    "data": null // 返回内容
}
```

### **返回状态码**

<table><thead><tr><th width="164">状态码</th><th>说明</th></tr></thead><tbody><tr><td>4066</td><td>检查支持的币种失败</td></tr><tr><td>4073</td><td>CoinsDoId不存在</td></tr><tr><td>4074</td><td>收币地址不存在</td></tr><tr><td>4075</td><td>客户端版本不支持</td></tr><tr><td>4076</td><td>余额不足</td></tr><tr><td>4077</td><td>存在尚未完成的归集</td></tr><tr><td>4078</td><td>客户端归集开关未开启</td></tr><tr><td>4079</td><td>手动归集记录保存失败</td></tr><tr><td>4080</td><td>查询最小余额配置失败</td></tr><tr><td>4081</td><td>手动归集记录查询失败</td></tr><tr><td>4082</td><td>归集数量应大于0</td></tr></tbody></table>

***

## 获取收币地址余额 <a href="#huo-qu-shou-bi-di-zhi-yu-e" id="huo-qu-shou-bi-di-zhi-yu-e"></a>

可通过此API查询某一收币地址的余额

### **接口描述**

* 查询收币地址缓存的余额

### **请求地址**

* `{URL}/v1/balanceGet`

### **请求方式**

* POST
* Body 参数

<table><thead><tr><th width="169">参数名</th><th width="81">必填</th><th width="110">类型</th><th>说明</th></tr></thead><tbody><tr><td>data</td><td>是</td><td>String</td><td>内容（JSON字符串，如下）</td></tr></tbody></table>

```json
{
    "apiKey": "d3a0beaa70474d3b",
    "addresses": "r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR",
    "coinsDoId": "30",
    "timestamp": 1679397493762
}
```

* data 参数

<table><thead><tr><th width="179">参数名</th><th width="83">必填</th><th width="108">类型</th><th>说明</th></tr></thead><tbody><tr><td>apiKey</td><td>是</td><td>String</td><td>API KEY</td></tr><tr><td>addresses</td><td>是</td><td>String</td><td>收币地址(最多1000个地址)</td></tr><tr><td>coinsDoId</td><td>是</td><td>String</td><td>币种ID(参数见币种列表)</td></tr><tr><td>timestamp</td><td>是</td><td>String</td><td>时间戳(秒或毫秒)</td></tr></tbody></table>

### **请求示例**

```json
{
  "data": "{\"addresses\":[\"0x2EFCDD48E44A82CEE87DF6B6DD9649AA9A758CB4\",\"0xE0FEB0AAF65FF5162CE3B7F8FD52B9166BF27616\"],\"apiKey\":\"06cc38296ecc4602\",\"coinsDoId\":\"2\",\"timestamp\":1763977264}",
  "sign":"5d1fc48506b4dd304fe28603ae827fe4cd08772d9307bf5700fd15ba366de751"
}
```

### **返回示例**

```json
{
    "success": true,
    "code": 200,
    "msg": "成功",
    "data": [
        {
            "address": "r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR",
            "balance": "15.123456789012345678",
            "balanceUpdateTime": "1669712411"
        },
        {
            "address": "rN7n7otQDd6FczFgLdM83BjW4GCdgRAWjU",
            "balance": "1.0009702640000000",
            "balanceUpdateTime": "1669712500"
        },
        {
            "address": "rPEPPER7kfTD9w2To4CQk6UCfuHM9c6GDY",
            "balance": "1000.500000000000000000",
            "balanceUpdateTime": "1669712600"
        }
    ]
}
```

* data 参数

<table><thead><tr><th width="215">参数名</th><th width="83">必填</th><th width="109">类型</th><th>说明</th></tr></thead><tbody><tr><td>address</td><td>是</td><td>String</td><td>收币地址</td></tr><tr><td>balance</td><td>是</td><td>String</td><td>收币地址的余额</td></tr><tr><td>balanceUpdateTime</td><td>是</td><td>String</td><td>余额更新时间戳(秒)</td></tr></tbody></table>

### **返回状态码**

<table><thead><tr><th width="177">状态码</th><th>说明</th></tr></thead><tbody><tr><td>4002</td><td>参数格式错误</td></tr><tr><td>4003</td><td>JSON数据转换异常</td></tr><tr><td>4004</td><td>APIKEY不存在</td></tr><tr><td>4005</td><td>ip受限，当前ip:</td></tr><tr><td>4034</td><td>查询地址失败</td></tr><tr><td>4066</td><td>检查支持的币种失败</td></tr><tr><td>4073</td><td>CoinsDoId不存在</td></tr><tr><td>4074</td><td>收币地址不存在</td></tr><tr><td>4099</td><td>请求次数太频繁</td></tr></tbody></table>

***

## 获取归集統計 <a href="#huo-qu-shou-bi-di-zhi-yu-e" id="huo-qu-shou-bi-di-zhi-yu-e"></a>

### **接口描述**

* 查询归集統計

### **请求地址**

* `{URL}/v1/collectStatistic`

### **请求方式**

* POST
* Body 参数

<table><thead><tr><th width="109.484375">参数名</th><th width="101.26953125">必填</th><th width="120.5078125">类型</th><th>说明</th></tr></thead><tbody><tr><td>data</td><td>是</td><td>String</td><td>内容（JSON字符串，如下）</td></tr></tbody></table>

```json
{
    "apiKey": "7bb52d79e46e47ab",
    "depositDeviceUuid": "3FA9B3EE-6275-49F4-8886-13B5A58F32CF",
    "startTime": "1738886400",
    "endTime": "1738943999",
    "timestamp": "1740379248"
}
```

* data 参数

<table><thead><tr><th width="167.86328125">参数名</th><th width="97.6875">必填</th><th width="94.54296875">类型</th><th>说明</th></tr></thead><tbody><tr><td>apiKey</td><td>是</td><td>String</td><td>API KEY</td></tr><tr><td>depositDeviceUuid</td><td>是</td><td>String</td><td>设备UUID</td></tr><tr><td>startTime</td><td>是</td><td>String</td><td>开始时间 (時區UTC+0) (最多查一天且不可跨天)</td></tr><tr><td>endTime</td><td>是</td><td>String</td><td>结束时间 (時區UTC+0) (最多查一天且不可跨天)</td></tr><tr><td>timestamp</td><td>是</td><td>String</td><td>时间戳 (秒或毫秒)</td></tr></tbody></table>

### **请求示例**

```json
{
    "data":"{\"apiKey\":\"7bb52d79e46e47ab\",\"depositDeviceUuid\":\"3FA9B3EE-6275-49F4-8886-13B5A58F32CF\",\"startTime\":\"1738886400\",\"endTime\":\"1738943999\",\"timestamp\":\"1740379248\"}",
    "sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}
```

### **返回示例**

```json
{
    "code": 200,
    "msg": "Success",
    "success": true,
    "data": {
        "deviceName": "alpha",
        "deviceRemark": "Pixel 7-5be6",
        "depositDeviceUuid": "3FA9B3EE-6275-49F4-8886-13B5A58F32CF",
        "details": [
            {
              "chain": "ADA",
              "currency": "ADA",
              "currencyName": "ADA",
              "flag": "ADA",
              "customName": "ADA",
              "collectedAmount": 0,
              "uncollectedAmount": 0,
              "lastUpdateTime": null,
              "currencyType": 0
            },
            {
              "chain": "ALGO",
              "currency": "ALGO",
              "currencyName": "ALGO",
              "flag": "ALGO",
              "customName": "ALGO",
              "collectedAmount": 0,
              "uncollectedAmount": 0,
              "lastUpdateTime": null,
              "currencyType": 0
            }
        ]
    }
}
```

* data 参数

<table><thead><tr><th width="179.64453125">参数名</th><th width="101.08984375">必填</th><th width="177.40625">类型</th><th>说明</th></tr></thead><tbody><tr><td>deviceName</td><td>是</td><td>String</td><td>设备名称</td></tr><tr><td>deviceRemark</td><td>是</td><td>String</td><td>设备备注</td></tr><tr><td>depositDeviceUuid</td><td>是</td><td>String</td><td>设备UUID</td></tr><tr><td>details</td><td>是</td><td>Array</td><td>统计资料</td></tr></tbody></table>

* details 参数

<table><thead><tr><th width="175.25390625">参数名</th><th width="137.015625">必填</th><th width="99.4375">类型</th><th>说明</th></tr></thead><tbody><tr><td>chain</td><td>是</td><td>String</td><td>主链名称</td></tr><tr><td>currency</td><td>是</td><td>String</td><td>币种/协议</td></tr><tr><td>currencyName</td><td>是</td><td>String</td><td>币名称</td></tr><tr><td>flag</td><td>是</td><td>String</td><td>合约地址/币种</td></tr><tr><td>customName</td><td>否</td><td>String</td><td>自定义名称</td></tr><tr><td>collectedAmount</td><td>是</td><td>Decimal</td><td>已归集数量</td></tr><tr><td>uncollectedAmount</td><td>是</td><td>Decimal</td><td>未归集数量</td></tr><tr><td>lastUpdateTime</td><td>否</td><td>String</td><td>最后更新时间</td></tr><tr><td>currencyType</td><td>是</td><td>Integer</td><td>币种类型 (0.主币 1.代币)</td></tr></tbody></table>

### **返回状态码**

<table><thead><tr><th width="136.1328125">状态码</th><th>说明</th></tr></thead><tbody><tr><td>4002</td><td>参数格式错误</td></tr><tr><td>4003</td><td>JSON数据转换异常</td></tr><tr><td>4004</td><td>APIKEY不存在</td></tr><tr><td>4005</td><td>ip受限，当前ip:</td></tr><tr><td>4007</td><td>验签失败</td></tr><tr><td>4010</td><td>请求过期</td></tr><tr><td>4032</td><td>查询钱包失败</td></tr><tr><td>4068</td><td>检查APIKEY失败</td></tr><tr><td>4099</td><td>请求次数太频繁</td></tr><tr><td>4116</td><td>选择时间超过时间限定范围</td></tr><tr><td>4118</td><td>查询币种配置失败</td></tr><tr><td>4119</td><td>查询支持的币种列表失败</td></tr><tr><td>4120</td><td>归集统计查询失败</td></tr><tr><td>4123</td><td>开始时间超过结束时间</td></tr><tr><td>4124</td><td>查询时间需为同一天</td></tr></tbody></table>

***

## 获取矿工费归集統計 <a href="#huo-qu-shou-bi-di-zhi-yu-e" id="huo-qu-shou-bi-di-zhi-yu-e"></a>

### **接口描述**

* 查询矿工费归集統計

### **请求地址**

* `{URL}/v1/collectStatisticFee`

### **请求方式**

* POST
* Body 参数

<table><thead><tr><th width="85.76953125">参数名</th><th width="114.78515625">必填</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td>data</td><td>是</td><td>string</td><td>内容（JSON字符串，如下）</td></tr></tbody></table>

```json
{
    "apiKey": "7bb52d79e46e47ab",
    "depositDeviceUuid": "3FA9B3EE-6275-49F4-8886-13B5A58F32CF",
    "startTime": "1738886400",
    "endTime": "1738943999",
    "timestamp": "1740379248"
}
```

* data 参数

<table><thead><tr><th width="170.859375">参数名</th><th width="92.1328125">必填</th><th width="103.5625">类型</th><th>说明</th></tr></thead><tbody><tr><td>apiKey</td><td>是</td><td>String</td><td>API KEY</td></tr><tr><td>depositDeviceUuid</td><td>是</td><td>String</td><td>设备UUID</td></tr><tr><td>startTime</td><td>是</td><td>String</td><td>开始时间 (時區UTC+0) (最多查一天且不可跨天)</td></tr><tr><td>endTime</td><td>是</td><td>String</td><td>结束时间 (時區UTC+0) (最多查一天且不可跨天)</td></tr><tr><td>timestamp</td><td>是</td><td>String</td><td>时间戳 (秒或毫秒)</td></tr></tbody></table>

### **请求示例**

```json
{
    "data":"{\"apiKey\":\"7bb52d79e46e47ab\",\"depositDeviceUuid\":\"3FA9B3EE-6275-49F4-8886-13B5A58F32CF\",\"startTime\":\"1738886400\",\"endTime\":\"1738943999\",\"timestamp\":\"1740379248\"}",
    "sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}
```

### **返回示例**

```json
{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": {
        "depositDeviceUuid": "3813AC47-AB3C-4510-AFA9-47D7BDC23C37",
        "deviceName": "main",
        "deviceRemark": "",
        "details": [
            {
                "chain": "AMB",
                "currency": "AMB",
                "currencyName": "AMB",
                "flag": "AMB",
                "customName": null,
                "usedFeeAmount": 0,
                "unusedFeeAmount": 0,
                "lastUpdateTime": null,
                "currencyType": 0
            },
            {
                "chain": "ARB1",
                "currency": "ARB1",
                "currencyName": "ARB1",
                "flag": "ARB1",
                "customName": null,
                "usedFeeAmount": 0,
                "unusedFeeAmount": 0,
                "lastUpdateTime": null,
                "currencyType": 0
            }
        ]
    }
}
```

* data 参数

<table><thead><tr><th width="178.8359375">参数名</th><th width="82.83203125">必填</th><th width="122.88671875">类型</th><th>说明</th></tr></thead><tbody><tr><td>deviceName</td><td>是</td><td>String</td><td>设备名称</td></tr><tr><td>deviceRemark</td><td>是</td><td>String</td><td>设备备注</td></tr><tr><td>depositDeviceUuid</td><td>是</td><td>String</td><td>设备UUID</td></tr><tr><td>details</td><td>是</td><td>Array</td><td>统计资料</td></tr></tbody></table>

* details 参数

<table><thead><tr><th width="201.83203125">参数名</th><th width="80.24609375">必填</th><th width="167.5078125">类型</th><th>说明</th></tr></thead><tbody><tr><td>chain</td><td>是</td><td>String</td><td>主链名称</td></tr><tr><td>currency</td><td>是</td><td>String</td><td>币种/协议</td></tr><tr><td>currencyName</td><td>是</td><td>String</td><td>币名称</td></tr><tr><td>flag</td><td>是</td><td>String</td><td>合约地址/币种</td></tr><tr><td>customName</td><td>否</td><td>String</td><td>自定义名称</td></tr><tr><td>usedFeeAmount</td><td>是</td><td>Decimal</td><td>已使用矿工费数量</td></tr><tr><td>unusedFeeAmount</td><td>是</td><td>Decimal</td><td>未使用矿工费数量</td></tr><tr><td>lastUpdateTime</td><td>否</td><td>String</td><td>最后更新时间</td></tr><tr><td>currencyType</td><td>是</td><td>Integer</td><td>币种类型 (0.主币 1.代币)</td></tr></tbody></table>

### **返回状态码**

<table><thead><tr><th width="92.26953125">状态码</th><th>说明</th></tr></thead><tbody><tr><td>4002</td><td>参数格式错误</td></tr><tr><td>4003</td><td>JSON数据转换异常</td></tr><tr><td>4004</td><td>APIKEY不存在</td></tr><tr><td>4005</td><td>ip受限，当前ip:</td></tr><tr><td>4007</td><td>验签失败</td></tr><tr><td>4010</td><td>请求过期</td></tr><tr><td>4032</td><td>查询钱包失败</td></tr><tr><td>4068</td><td>检查APIKEY失败</td></tr><tr><td>4099</td><td>请求次数太频繁</td></tr><tr><td>4116</td><td>选择时间超过时间限定范围</td></tr><tr><td>4118</td><td>查询币种配置失败</td></tr><tr><td>4119</td><td>查询支持的币种列表失败</td></tr><tr><td>4121</td><td>已归集矿工费统计查询失败</td></tr><tr><td>4123</td><td>开始时间超过结束时间</td></tr><tr><td>4124</td><td>查询时间需为同一天</td></tr></tbody></table>

***

## 收币记录校验接口 <a href="#shou-bi-ji-lu-jiao-yan" id="shou-bi-ji-lu-jiao-yan"></a>

### **接口描述**

* 查询收币记录详情

### **请求地址**

* `{URL}/v1/listDepositRecordDetail`

### **请求方式**

* POST
* Body 参数

<table><thead><tr><th width="168.34375">参数名</th><th width="125.58984375">必填</th><th width="145.7421875">类型</th><th>说明</th></tr></thead><tbody><tr><td>data</td><td>是</td><td>String</td><td>内容（JSON字符串，如下）</td></tr></tbody></table>

```json
{
    "apiKey": "aa465953d55641b3",
    "timestamp": "2622775712229",
    "txHashDetailList": [
        {
            "txHash": "0ffa403dc79753748d433819fbab3d93e5845253761388470908c69eebf5be5b",
            "txIndex": 0
        },
        {
            "txHash": "b940d614ff28d423f4291627a080c184c2e4fb399c5aaa749d5b2b26d9e78f9d",
            "txIndex": 0
        }
    ]
}
```

* data 参数

| 参数名              | 必填 | 类型      | 说明         |
| ---------------- | -- | ------- | ---------- |
| apiKey           | 是  | String  | API KEY    |
| timestamp        | 是  | String  | 时间戳 (秒或毫秒) |
| txHashDetailList | 是  | Array   |            |
| txHash           | 是  | String  | 交易哈希       |
| txIndex          | 是  | Integer | 交易序号       |

### **请求示例**

```json
{
    "data": "{\"data\":\"{'apiKey': 'aa465953d55641b3', 'timestamp': '2622775712229', 'txHashDetailList': [{'txHash': '0ffa403dc79753748d433819fbab3d93e5845253761388470908c69eebf5be5b', 'txIndex': 0}, {'txHash': 'b940d614ff28d423f4291627a080c184c2e4fb399c5aaa749d5b2b26d9e78f9d', 'txIndex': 0}]}\",\"sign\":\"b75af4602754e02d7d91d0e5d4251852ee78cbd9442c978a0fa5b24e37f11444\"}",
    "sign": "22212634c772653e4074347d36040d9c51613c9a827591b12ea5888e6c301fbe"
}
```

### **返回示例**

```json
{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": [
        {
            "txHash": "0ffa403dc79753748d433819fbab3d93e5845253761388470908c69eebf5be5b",
            "txIndex": 0,
            "depositRecordDetail": {
                "merchantId": 4650863810129921,
                "depositDeviceUuid": "A8559B13-2D86-47B9-98D8-1639DC6E07A3",
                "address": "TRBZzf6khb7U1kcLZ33rGoJTuaKYK8XueR",
                "amount": "10",
                "currency": "TRX",
                "flag": "TRX",
                "txFee": "0",
                "txMemo": null,
                "callBackStatus": 1,
                "createTime": "1750146857",
                "txTime": "1750146810",
                "fromAddress": "TABfQ4vogYeetAsSiTm6ppKighXkGGai8i",
                "depositType": 0,
                "ignoreCheck": 0
            }
        },
        {
            "txHash": "b940d614ff28d423f4291627a080c184c2e4fb399c5aaa749d5b2b26d9e78f9d",
            "txIndex": 0,
            "depositRecordDetail": {
                "merchantId": 4650863810129921,
                "depositDeviceUuid": "A8559B13-2D86-47B9-98D8-1639DC6E07A3",
                "address": "TRBZzf6khb7U1kcLZ33rGoJTuaKYK8XueR",
                "amount": "12",
                "currency": "TRX",
                "flag": "TRX",
                "txFee": "1",
                "txMemo": "test_online_memo",
                "callBackStatus": 1,
                "createTime": "1750215200",
                "txTime": "1750215123",
                "fromAddress": "TABfQ4vogYeetAsSiTm6ppKighXkGGai8i",
                "depositType": 0,
                "ignoreCheck": 0
            }
        }
    ]
}
```

* details 参数

<table><thead><tr><th width="176.98828125">参数名</th><th width="95.6484375">必填</th><th width="130.578125">类型</th><th>说明</th></tr></thead><tbody><tr><td>merchantId</td><td>是</td><td>Long</td><td>商户ID</td></tr><tr><td>depositDeviceUuid</td><td>是</td><td>String</td><td>归集设备UUID</td></tr><tr><td>address</td><td>是</td><td>String</td><td>存币地址</td></tr><tr><td>amount</td><td>是</td><td>String</td><td>存币数量</td></tr><tr><td>currency</td><td>是</td><td>String</td><td>存币币种</td></tr><tr><td>flag</td><td>是</td><td>String</td><td>存币标识</td></tr><tr><td>txFee</td><td>是</td><td>String</td><td>矿工费</td></tr><tr><td>txMemo</td><td>是</td><td>String</td><td>交易备注(链上备注)</td></tr><tr><td>callBackStatus</td><td>是</td><td>Integer</td><td>收币回调状态(-1.无需回调 0.回调中 1.回调成功 2.回调失败)</td></tr><tr><td>createTime</td><td>是</td><td>String</td><td>创建时间</td></tr><tr><td>txTime</td><td>是</td><td>String</td><td>交易时间</td></tr><tr><td>fromAddress</td><td>是</td><td>String</td><td>发币地址</td></tr><tr><td>depositType</td><td>是</td><td>Integer</td><td>存币类型(0.转账 1.手续费转入)</td></tr><tr><td>ignoreCheck</td><td>是</td><td>Integer</td><td>忽略核查(0 未忽略 1忽略)</td></tr></tbody></table>

### **返回状态码**

<table><thead><tr><th width="92.26953125">状态码</th><th>说明</th></tr></thead><tbody><tr><td>4002</td><td>参数格式错误</td></tr><tr><td>4003</td><td>JSON数据转换异常</td></tr><tr><td>4004</td><td>APIKEY不存在</td></tr><tr><td>4005</td><td>ip受限，当前ip:</td></tr><tr><td>4007</td><td>验签失败</td></tr><tr><td>4010</td><td>请求过期</td></tr><tr><td>4068</td><td>检查APIKEY失败</td></tr><tr><td>4099</td><td>请求次数太频繁</td></tr><tr><td>4146</td><td>查询收币记录异常</td></tr></tbody></table>

***

## 查询收币纪录接口 <a href="#shou-bi-ji-lu" id="shou-bi-ji-lu"></a>

### **接口描述**

* 查询收币记录（分页查询）

### **请求地址**

* `{URL}/v1/depositRecordPageGet`

### **请求方式**

* POST
* Body 参数

<table><thead><tr><th width="168.34375">参数名</th><th width="125.58984375">必填</th><th width="145.7421875">类型</th><th>说明</th></tr></thead><tbody><tr><td>data</td><td>是</td><td>String</td><td>内容（JSON字符串，如下）</td></tr></tbody></table>

```json
{
    "apiKey": "aa465953d55641b3",
    "timestamp": 2622775712229,
    "pageNum": 1,
    "pageSize": 100,
    "startArrivalTime": 1763913600000,
    "endArrivalTime": 1763999999000
}
```

* data 参数

| 参数名              | 必填 | 类型      | 说明                    |
| ---------------- | -- | ------- | --------------------- |
| apiKey           | 是  | String  | API KEY               |
| timestamp        | 是  | Integer | 时间戳 (秒或毫秒)            |
| pageNum          | 否  | Integer | 当前页数(不可小于 1)          |
| pageSize         | 否  | Integer | 每页笔数(必须在 15 到 100 之间) |
| startArrivalTime | 是  | Integer | 开始到账时间(毫秒)            |
| endArrivalTime   | 是  | Integer | 结束到账时间(毫秒)            |

### **请求示例**

```json
{
    "data":"{\"apiKey\":\"7bb52d79e46e47ab\",\"timestamp\":2622775712229,\"pageNum\":1,\"pageSize\":15,\"startArrivalTime\":1763913600000,\"endArrivalTime\":1763999999000}",
    "sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}
```

### **返回示例**

```json
{
    "success": true,
    "code": 200,
    "msg": "Success",
    "data": {
        "pageNumber": 1,
        "pageSize": 100,
        "totalPageCount": 1,
        "totalRowCount": 10,
        "results": [
            {
                "merchantId": 4636267787041793,
                "amount": "1.7007",
                "callBackStatus": 1,
                "createTime": "2025-11-24T08:15:30.071+00:00",
                "currency": "SPL",
                "depositDeviceUuid": "D9868C45-0D72-499E-991E-B5A6D7109EE8",
                "depositSign": "dKyj8t+oBFnw0VqZo7ZkGpHhXSUdafDQGjUhIXmMBgCTIeuE2ZJrB7JzxJcM6snirXk+ONoaEjY/df6zbOLvrmc5aC0G2/F8v/PCdP+3pieC1ahWBpyk0C0IAFwDJC6k10CQvs78M8qPo5wW9sms/51zWS5fLxVI/LYEPqPwPdY=",
                "depositType": 0,
                "flag": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
                "fromAddress": "8iWBzd4z8WoiknZXVfisu1pGAEkKVAp7KNaHrHREi1Wa",
                "ignoreCheck": 0,
                "toAddress": "FPTTusorT3br9KUy7uxF183f2rQ31nzov18JoBHpy3mY",
                "txHash": "2CvV1GaU69uadHiMmLSsGvuzdAo1XLTe2ZCtYaTQTdKG724LHs8cA7LtdhcAT9fyXRwdNsSg2ANC1i3PFQaFqaH1",
                "txIndex": 0,
                "txMemo": null,
                "txTime": "2025-11-24T08:15:04.000+00:00",
                "txFee": "0.00001"
            },
            {
                "merchantId": 4636267787041793,
                "amount": "1.7007",
                "callBackStatus": 1,
                "createTime": "2025-11-24T08:07:30.139+00:00",
                "currency": "SPL",
                "depositDeviceUuid": "D9868C45-0D72-499E-991E-B5A6D7109EE8",
                "depositSign": "XNrphXHtse7aRxFH31qJcgES1rQYmez5+OdEU4QuFHPBwbH9lTYjoP0KDwpPvvZbL7evmIEHyhQJBJxJ5n5YQxNswdkNTyA3GTJN/xNxsEcDzs5sb43d5aOe0tU/2+HuSHiOVpm1rBxSYXiIIuQRzTRaDFR9VwNzDtSWEEhyZhg=",
                "depositType": 0,
                "flag": "4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU",
                "fromAddress": "8iWBzd4z8WoiknZXVfisu1pGAEkKVAp7KNaHrHREi1Wa",
                "ignoreCheck": 0,
                "toAddress": "FPTTusorT3br9KUy7uxF183f2rQ31nzov18JoBHpy3mY",
                "txHash": "3WARL4k525S6r7ZPFBwVBoHwaMiGYhNiL4HvdiCfnSs5TDnA9q6nsi3gimz5nXkmDd2V3tbKLshtAVDUaKh7xSsq",
                "txIndex": 0,
                "txMemo": null,
                "txTime": "2025-11-24T08:06:52.000+00:00",
                "txFee": "0.00001"
            }
        ]
    }
}
```

* details 参数

<table><thead><tr><th width="176.98828125">参数名</th><th width="95.6484375">必填</th><th width="130.578125">类型</th><th>说明</th></tr></thead><tbody><tr><td>merchantId</td><td>是</td><td>Long</td><td>商户ID</td></tr><tr><td>amount</td><td>是</td><td>String</td><td>收币数量</td></tr><tr><td>callBackStatus</td><td>是</td><td>Integer</td><td>回调状态：<br>-1 - 无需回调<br>0 - 待回调<br>1 - 回调成功<br>2 - 回调失败)</td></tr><tr><td>createTime</td><td>是</td><td>String</td><td>到账时间</td></tr><tr><td>currency</td><td>是</td><td>String</td><td>收币币种</td></tr><tr><td>depositDeviceUuid</td><td>是</td><td>String</td><td>设备UUID</td></tr><tr><td>depositSign</td><td>是</td><td>String</td><td>收币签名</td></tr><tr><td>depositType</td><td>是</td><td>Integer</td><td>收币类型：<br>0 - 转账<br>1 - 矿工费转入<br>2 - 找零</td></tr><tr><td>flag</td><td>是</td><td>String</td><td>合约地址/币种</td></tr><tr><td>fromAddress</td><td>是</td><td>String</td><td>发送地址</td></tr><tr><td>ignoreCheck</td><td>是</td><td>Integer</td><td>忽略核查：<br>0 - 未忽略<br>1 - 忽略</td></tr><tr><td>toAddress</td><td>是</td><td>String</td><td>收币地址</td></tr><tr><td>txHash</td><td>是</td><td>String</td><td>交易hash</td></tr><tr><td>txIndex</td><td>是</td><td>Integer</td><td>交易序号</td></tr><tr><td>txMemo</td><td>是</td><td>String</td><td>链上交易备注</td></tr><tr><td>txTime</td><td>是</td><td>String</td><td>上链时间</td></tr><tr><td>txFee</td><td>是</td><td>String</td><td>矿工费</td></tr></tbody></table>

### **返回状态码**

<table><thead><tr><th width="92.26953125">状态码</th><th>说明</th></tr></thead><tbody><tr><td>4002</td><td>APIKEY不能为空<br>sign不能为空<br>页码不可小于 1<br>每页数量必须在 15 到 100 之间<br>时间戳不能为空<br>开始到账时间不能为空<br>结束到账时间不能为空</td></tr><tr><td>4004</td><td>APIKEY不存在</td></tr><tr><td>4007</td><td>验签失败</td></tr><tr><td>4099</td><td>请求次数太频繁</td></tr><tr><td>4010</td><td>请求过期</td></tr><tr><td>4163</td><td>开始到账时间和结束到账时间的范围不可超过24小时</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://coinsdo.gitbook.io/docs/cn/coinsdo-api-integration/coinsdo-api-jie-ru-wen-dang/coinget-pian.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.