📙CoinGet篇

用户无需部署钱包节点，只需要管理一个私钥+通过派生私钥即获得海量的钱包地址。CoinGet可以有效控制归集成本，并且根据用户需求设计多个地址的归集策略。

获取收币地址

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

  1. 企业部署的归集钱包自动生成批量地址

  2. 归集钱包客户端将签名后的地址提交给CoinsDo服务器

  3. 企业透过CoinsDo API请求带有签名的地址

  4. 企业业务服务器对地址进行验签保证地址来自企业归集钱包客户端

接口描述

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

请求地址

  • {URL}/v1/addressGet

请求方式

  • POST

请求参数

  • Body 参数

参数名
必填
类型
说明

data

是

string

内容（JSON字符串，如下）

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

  • data 参数

参数名
必填
类型
说明

apiKey

是

string

API KEY

mainnet

是

string

主网络(参数见币种列表)

targetDeviceUuid

是

string

指定归集钱包

timestamp

是

string

时间戳(秒或毫秒)

addressRemark

否

string

地址的备注

isConvert

否

string

是否需要转换地址(0.否 1.是，默认为否，目前只有BCH会使用到，转换的地址为经典地址)

请求示例1

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

请求示例2

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

返回示例1

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

返回示例2

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

  • data 参数

参数名
必填
类型
说明

address

是

string

收币地址

addrSign

是

string

收币地址签名(可用钱包公钥对地址验签)

convertedAddr

否

string

转换后的地址(目前只有BCH会使用到，转换后地址为LegacyAddr/经典地址， 回调只会以address字段回调 )

返回状态码

状态码
说明

4042

查询归集钱包失败

4043

归集钱包不存在

4044

获取收币地址失败

4045

地址数量不足

4050

主网络暂不支持

4051

EOS链网络无需获取收币地址

4052

代币无需获取收币地址

4053

BCH地址转换失败

4061

查询关联链记录失败

4062

关联币种不能单独获取地址

4063

查询矿工费地址失败

4064

主网络不支持，请更新版本

4071

请指定主网络

4072

检查支持的主网络失败

BCH地址转换

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

接口描述

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

请求地址

  • {URL}/v1/bchAddrConvert

请求方式

  • POST

  • Body 参数

参数名
必填
类型
说明

data

是

string

内容（JSON字符串，如下）

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

  • data 参数

参数名
必填
类型
说明

apiKey

是

string

API KEY

address

是

string

BCH地址，Legacy格式(经典地址)或CashAddr格式(标准地址)

timestamp

是

string

时间戳(秒或毫秒)

请求示例1

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

请求示例2

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

返回示例1

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

返回示例2

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

  • data 参数

参数名
必填
类型
说明

legacyAddr

是

string

Legacy格式(经典地址)

cashAddr

是

string

CashAddr格式(标准地址)

返回状态码

状态码
说明

4053

BCH地址转换失败

4054

BCH地址格式有误

4055

校验BCH地址失败

回调通知

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

请求方式

  • POST

请求参数

  • Body 参数

参数名
必填
类型
说明

data

是

string

内容（JSON字符串，如下）

收币通知

  1. CoinsDo的钱包节点检测到钱包地址有充值后通知企业部署的CoinGet客户端

  2. 企业CoinGet客户端对地址进行验签保证地址是属于自己的钱包

  3. 企业CoinGet客户端透过第三方区块链浏览器验证充值

  4. 验证成功后通知企业CoinGet客户端

  5. 当CoinGet钱包客户端收到验证成功后会对信息进行签名然后提交给CoinsDo服务器

  6. 企业透过CoinsDo API接收带有签名的回调信息

  7. 企业业务服务器对信息进行验签保证信息来自企业CoinGet客户端

链上达到一个确认数通知

主币：

{
    "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"
}

协议：

{ 
    "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"
}

请求示例

主币：

{
    "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"
}

协议：

{
    "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"
}

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

主币：

 {
    "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"
}

协议：

{
    "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"
}

请求示例

主币： 

{
    "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"
}

协议：

{
    "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 参数

参数名
必填
类型
说明

txHash

是

string

交易哈希

txIndex

否

string

交易下标(不是每个币种都有，例如BTC的交易序号、ERC20和TRC20的日志序号)

fromAddress

是

string

发送地址

toAddress

是

string

接收地址

amount

是

string

收币数量

txFee

是

string

矿工费

feeSymbol

是

string

矿工费单位/标识

txTime

是

string

交易确认时间戳(秒)

txMemo

否

string

链上备注(目前仅支持TRX和TRC20、EOS、XRP)

blockNumber

是

string

区块高度

deviceUuid

是

string

地址所属钱包标识

checkMode

是

string

核查方式(0.钱包对地址的核查+第三方API对收币记录的核查)

isReachedConfirm

是

string

是否达到确认数(0.未达到 1.已达到)

blockConfirm

是

string

确认区块数

checkSign

否

string

客户端对收币记录的核查结果的签名

addressRemark

否

string

接收地址的备注

mainnet

是

string

主网络名称

coinName

是

string

币种名称(参数见币种列表)

coinsDoId

是

string

币种ID(参数见币种列表)

protocol

是

string

协议(参数见币种列表)

tokenAddress

是

string

代币地址(参数见币种列表)

coinType

是

string

币种类型(参数见币种列表)

recordId

是

string

COINSDO收币记录ID

checkCode

否

string

核查结果(参数详情如下)

checkCode
地址核查
交易核查
说明

-1

核查异常

核查异常

未知错误

0

核查成功

核查成功

核查成功

1

核查异常

未核查

地址不存在

2

核查成功

核查成功

数据不匹配

3

核查成功

核查异常

交易失败

4

核查成功

核查异常

核查交易失败

5

核查成功

核查异常

交易未找到

6

核查成功

关闭核查

核查关闭

7

核查异常

未核查

地址未找到

 ❗客户端在线状态方可进行核查，关闭核查将忽略客户端的核查直接回调；正常情况下核查成功后将会回调，如遇核查异常情况则核查超过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不能做币种到账判断，只做展示作用，因为同个链可能存在相同币种名称

返回示例

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

手动归集

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

接口描述

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

请求地址

  • {URL}/v1/manualCollect

请求方式

  • POST

  • Body 参数

参数名
必填
类型
说明

data

是

string

内容（JSON字符串，如下）

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

  • data 参数

参数名
必填
类型
说明

apiKey

是

string

API KEY

address

是

string

收币地址

coinsDoId

是

string

币种ID(参数见币种列表)

collectAmount

否

string

归集数量(不填将归集可用余额)

timestamp

是

string

时间戳(秒或毫秒)

请求示例1

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

请求示例2

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

返回示例

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

返回状态码

状态码
说明

4066

检查支持的币种失败

4073

CoinsDoId不存在

4074

收币地址不存在

4075

客户端版本不支持

4076

余额不足

4077

存在尚未完成的归集

4078

客户端归集开关未开启

4079

手动归集记录保存失败

4080

查询最小余额配置失败

4081

手动归集记录查询失败

4082

归集数量应大于0

获取收币地址余额

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

接口描述

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

请求地址

  • {URL}/v1/balanceGet

请求方式

  • POST

  • Body 参数

参数名
必填
类型
说明

data

是

string

内容（JSON字符串，如下）

{
    "apiKey": "d3a0beaa70474d3b",
    "address": "r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR",
    "coinsDoId": "30",
    "timestamp": 1679397493762
}

  • data 参数

参数名
必填
类型
说明

apiKey

是

string

API KEY

address

是

string

收币地址

coinsDoId

是

string

币种ID(参数见币种列表)

timestamp

是

string

时间戳(秒或毫秒)

请求示例

{
    "data":"{\"address\":\"r4NXBFySVyhwR1yFBLm2ocxq731KvZKcVR\",\"apiKey\":\"d3a0beaa70474d3b\",\"coinsDoId\":\"30\",\"timestamp\":\"1679497593762\"}",
    "sign":"03dabf4073bad9d5fcde3b881bba076cae211ac28b11995289740f96f51162a5"
}

返回示例

{
    "code": 200,
    "msg": "成功",
    "data": {
        "balance": 15.000000000000000000,
        "balanceUpdateTime": "1669712411"
    }
}

  • data 参数

参数名
必填
类型
说明

balance

是

string

收币地址的余额

balanceUpdateTime

是

string

余额更新时间戳(秒)

返回状态码

状态码
说明

4034

查询地址失败

4066

检查支持的币种失败

4073

CoinsDoId不存在

4074

收币地址不存在

获取归集統計

接口描述

  • 查询归集統計

请求地址

  • {URL}/v1/collectStatistic

请求方式

  • POST

  • Body 参数

参数名
必填
类型
说明

data

是

string

内容（JSON字符串，如下）

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

  • data 参数

参数名
必填
类型
说明

apiKey

是

string

API KEY

depositDeviceUuid

是

string

设备UUID

startTime

是

string

开始时间 (時區UTC+0) (最多查一天且不可跨天)

endTime

是

string

结束时间 (時區UTC+0) (最多查一天且不可跨天)

timestamp

是

string

时间戳 (秒或毫秒)

请求示例

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

返回示例

{
    "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 参数

参数名
必填
类型
说明

deviceName

是

string

设备名称

deviceRemark

是

string

设备备注

depositDeviceUuid

是

string

设备UUID

details

是

array

统计资料

  • details 参数

参数名
必填
类型
说明

chain

是

string

主链名称

currency

是

string

币种/协议

currencyName

是

string

币名称

flag

是

string

合约地址/币种

customName

否

string

自定义名称

collectedAmount

是

Decimal

已归集数量

uncollectedAmount

是

Decimal

未归集数量

lastUpdateTime

否

string

最后更新时间

currencyType

是

Integer

币种类型 (0.主币 1.代币)

返回状态码

状态码
说明

4002

参数格式错误

4003

JSON数据转换异常

4004

APIKEY不存在

4005

ip受限，当前ip:

4007

验签失败

4010

请求过期

4032

查询钱包失败

4068

检查APIKEY失败

4099

请求次数太频繁

4116

选择时间超过时间限定范围

4118

查询币种配置失败

4119

查询支持的币种列表失败

4120

归集统计查询失败

4123

开始时间超过结束时间

4124

查询时间需为同一天

获取矿工费归集統計

接口描述

  • 查询矿工费归集統計

请求地址

  • {URL}/v1/collectStatisticFee

请求方式

  • POST

  • Body 参数

参数名
必填
类型
说明

data

是

string

内容（JSON字符串，如下）

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

  • data 参数

参数名
必填
类型
说明

apiKey

是

string

API KEY

depositDeviceUuid

是

string

设备UUID

startTime

是

string

开始时间 (時區UTC+0) (最多查一天且不可跨天)

endTime

是

string

结束时间 (時區UTC+0) (最多查一天且不可跨天)

timestamp

是

string

时间戳 (秒或毫秒)

请求示例

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

返回示例

{
    "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 参数

参数名
必填
类型
说明

deviceName

是

string

设备名称

deviceRemark

是

string

设备备注

depositDeviceUuid

是

string

设备UUID

details

是

array

统计资料

  • details 参数

参数名
必填
类型
说明

chain

是

string

主链名称

currency

是

string

币种/协议

currencyName

是

string

币名称

flag

是

string

合约地址/币种

customName

否

string

自定义名称

usedFeeAmount

是

Decimal

已使用矿工费数量

unusedFeeAmount

是

Decimal

未使用矿工费数量

lastUpdateTime

否

string

最后更新时间

currencyType

是

Integer

币种类型 (0.主币 1.代币)

返回状态码

状态码
说明

4002

参数格式错误

4003

JSON数据转换异常

4004

APIKEY不存在

4005

ip受限，当前ip:

4007

验签失败

4010

请求过期

4032

查询钱包失败

4068

检查APIKEY失败

4099

请求次数太频繁

4116

选择时间超过时间限定范围

4118

查询币种配置失败

4119

查询支持的币种列表失败

4121

已归集矿工费统计查询失败

4123

开始时间超过结束时间

4124

查询时间需为同一天

收币记录校验接口

接口描述

  • 查询收币记录详情

请求地址

  • {URL}/v1/listDepositRecordDetail

请求方式

  • POST

  • Body 参数

参数名
必填
类型
说明

data

是

string

内容（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

交易序号

请求示例

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

返回示例

{
    "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 参数

参数名
必填
类型
说明

merchantId

是

Long

商户ID

depositDeviceUuid

是

string

归集设备UUID

address

是

string

存币地址

amount

是

string

存币数量

currency

是

string

存币币种

flag

是

string

存币标识

txFee

是

string

矿工费

txMemo

是

string

交易备注(链上备注)

callBackStatus

是

Integer

收币回调状态(-1.无需回调 0.回调中 1.回调成功 2.回调失败)

createTime

是

string

创建时间

txTime

是

string

交易时间

fromAddress

是

string

发币地址

depositType

是

Integer

存币类型(0.转账 1.手续费转入)

ignoreCheck

是

Integer

忽略核查(0 未忽略 1忽略)

返回状态码

状态码
说明

4002

参数格式错误

4003

JSON数据转换异常

4004

APIKEY不存在

4005

ip受限，当前ip:

4007

验签失败

4010

请求过期

4068

检查APIKEY失败

4099

请求次数太频繁

4146

查询收币记录异常

上一页CoinSend篇下一页关于CoinWallet

最后更新于

这有帮助吗？