NAV
go php js java

地址

地址获取

请求示例:

POST <base_path>/v2/address/getBatch HTTP/1.1
Host: api.xxxx.com
Content-Type: application/json
X-Cbc-App-Id: hxgmau9imt86qky9
X-Cbc-Key-Version: admin
X-Cbc-Timestamp: 1792382460
X-Cbc-Nonce: 7c1e9a3b5d7f9b1d3f5a7c9e1b3d5f7a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{"coin":"hc"}

resp, err := client.Post("/v2/address/getBatch", map[string]any{
    "coin": "hc",
})
$resp = $client->post('/v2/address/getBatch', [
    'coin' => 'hc',
]);
const resp = await client.post('/v2/address/getBatch', {
  coin: 'hc',
});
String resp = client.post("/v2/address/getBatch", Map.of("coin", "hc"));

返回结果示例:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: 4bf92f3577b34da6a3ce929d0e0e4736
X-Cbc-Timestamp: 1792382461
X-Cbc-Nonce: 3b5d7f9a1c3e5b7d9f1a3c5e7b9d1f3a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{ "status":200, "msg":"请求成功", "data":[ "HsZWVPmCS92hXJ4mUpTwCs3DX74MK1ihEBn", "HsCt7eYaJJkn331ZkprcbvGFDrRuqMYcAHx" ], "date_time":"2020-06-29 14:43:17", "time_stamp":1593412997 }

其他返回示例:

{
  "status": 500,
  "msg": "地址不足",
  "data": null,
  "date_time": "2020-01-09 15:46:14"
}
{
  "status":551,
  "msg":"有 6 个已分配未使用地址,请使用完再请求新的地址",
  "data":"6",
  "date_time":"2020-03-05 10:46:24",
  "time_stamp":1583376384
}

HTTP Request

POST /v2/address/getBatch

请求参数

公共 Header 见签名规则,下表只列 body 中的业务参数。

参数名 必选 类型 说明
coin 是 string 12个字符内主链币名,币名平台提供为准(若是bnb_bsc请传eth)。可查询/coin/list接口查看币名

返回参数说明

参数名 必选 类型 说明
status 是 integer 状态码
msg 否 string 100字内 状态描述
data 否 object 状态200返回地址数组,500地址不足返回null,551已分配未使用地址,返回未使用数字
date_time 否 string 北京时间:2020-06-29 14:28:14
time_stamp 否 string 响应时间,单位秒:1593412094

合约币和主链币共享同一个地址,请只用主链币名进行申请即可,不支持用合约币名申请地址,对于商户同一个用户的一个或多个合约币及同属于一个主链的主链币,仅分配一个主链币地址即可。 案列:user_coin表

用户ID 币名 地址
1688eth0xa6f8745c56a7c4fcb094678a2fbdcbd9ee9228f7
1688usdt_erc200xa6f8745c56a7c4fcb094678a2fbdcbd9ee9228f7
1688leek0xa6f8745c56a7c4fcb094678a2fbdcbd9ee9228f7

地址列表

请求示例:

POST <base_path>/v2/address/list HTTP/1.1
Host: api.xxxx.com
Content-Type: application/json
X-Cbc-App-Id: hxgmau9imt86qky9
X-Cbc-Key-Version: admin
X-Cbc-Timestamp: 1792382460
X-Cbc-Nonce: 7c1e9a3b5d7f9b1d3f5a7c9e1b3d5f7a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{"coin":"hc","address":"HsHGWeEMmx5QLds9UiWfjxarM4RbLAc3xrD","is_used":1,"page":1}
resp, err := client.Post("/v2/address/list", map[string]any{
    "coin":    "hc",
    "address": "HsHGWeEMmx5QLds9UiWfjxarM4RbLAc3xrD",
    "is_used": 1,
    "page":    1,
})
$resp = $client->post('/v2/address/list', [
    'coin' => 'hc',
    'address' => 'HsHGWeEMmx5QLds9UiWfjxarM4RbLAc3xrD',
    'is_used' => 1,
    'page' => 1,
]);
const resp = await client.post('/v2/address/list', {
  coin: 'hc',
  address: 'HsHGWeEMmx5QLds9UiWfjxarM4RbLAc3xrD',
  is_used: 1,
  page: 1,
});
String resp = client.post("/v2/address/list", Map.of(
        "coin", "hc",
        "address", "HsHGWeEMmx5QLds9UiWfjxarM4RbLAc3xrD",
        "is_used", 1,
        "page", 1));

返回结果示例:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: 4bf92f3577b34da6a3ce929d0e0e4736
X-Cbc-Timestamp: 1792382461
X-Cbc-Nonce: 3b5d7f9a1c3e5b7d9f1a3c5e7b9d1f3a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{
  "status":200,
  "msg":"处理成功",
  "data":{
    "page":1,
    "max_page":1,
    "count":4,
    "list":[
      {
        "address":"HsHGWeEMmx5QLds9UiWfjxarM4RbLAc3xrD",
        "user_id":""
      },
      {
        "address":"HsDZKWmgusF7fYbJ1Xw6FJJWx5Bkykdcfq9",
        "user_id":""
      }
    ]
  },
  "date_time":"2020-04-26 17:26:09",
  "time_stamp":1587893169
}

HTTP Request

POST /v2/address/list

请求参数

公共 Header 见签名规则,下表只列 body 中的业务参数。

参数名 必选 类型 说明
coin 是 string 主链币名-见支持公链公共信息说明(若是bnb_bsc请传eth)
address 否 string 地址
page 否 integer 1<= N <=Max, 超过Max的取Max,小于1返回1
is_used 否 integer 1=使用 , 2=未使用

返回参数说明

参数名 类型 说明
statusinteger状态码
msgstring状态描述
dataobject**具体见下面** “data细节说明”。
data.pageinteger当前第几页
data.max_pageinteger一共多少页
data.countinteger本页记录数
data.listarray具体每条记录
date_timestring响应时间
time_stampinteger时间戳,单位秒

类eos的地址+memo模式

请求示例:

POST <base_path>/v2/address/coinAccount HTTP/1.1
Host: api.xxxx.com
Content-Type: application/json
X-Cbc-App-Id: hxgmau9imt86qky9
X-Cbc-Key-Version: admin
X-Cbc-Timestamp: 1792382460
X-Cbc-Nonce: 7c1e9a3b5d7f9b1d3f5a7c9e1b3d5f7a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{"coin":"eos"}
resp, err := client.Post("/v2/address/coinAccount", map[string]any{
    "coin": "eos",
})
$resp = $client->post('/v2/address/coinAccount', [
    'coin' => 'eos',
]);
const resp = await client.post('/v2/address/coinAccount', {
  coin: 'eos',
});
String resp = client.post("/v2/address/coinAccount", Map.of("coin", "eos"));

返回结果示例:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: 4bf92f3577b34da6a3ce929d0e0e4736
X-Cbc-Timestamp: 1792382461
X-Cbc-Nonce: 3b5d7f9a1c3e5b7d9f1a3c5e7b9d1f3a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{
  "status":200,
  "msg":"请求成功",
  "data":"hyperpayeos1",
  "date_time":"2020-04-08 18:20:33",
  "time_stamp":1586341233
}

HTTP Request

POST /v2/address/coinAccount

请求参数

公共 Header 见签名规则,下表只列 body 中的业务参数。

参数名 必选 类型 说明
coin 是 string 主链币名-见支持公链公共信息说明(若是bnb_bsc请传eth)

返回参数说明

参数名 类型 说明
status integer 状态码
msg string 状态描述
data object
date_time string 响应时间
time_stamp integer 时间戳,单位秒

地址状态同步

请求示例:

POST <base_path>/v2/address/syncStatus HTTP/1.1
Host: api.xxxx.com
Content-Type: application/json
X-Cbc-App-Id: hxgmau9imt86qky9
X-Cbc-Key-Version: admin
X-Cbc-Timestamp: 1792382460
X-Cbc-Nonce: 7c1e9a3b5d7f9b1d3f5a7c9e1b3d5f7a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{"coin":"eth","address":"0xb930c8149bc0bbb0214ae4207164d3b1cb41f395","user_id":"28"}
resp, err := client.Post("/v2/address/syncStatus", map[string]any{
    "coin":    "eth",
    "address": "0xb930c8149bc0bbb0214ae4207164d3b1cb41f395",
    "user_id": "28",
})
$resp = $client->post('/v2/address/syncStatus', [
    'coin' => 'eth',
    'address' => '0xb930c8149bc0bbb0214ae4207164d3b1cb41f395',
    'user_id' => '28',
]);
const resp = await client.post('/v2/address/syncStatus', {
  coin: 'eth',
  address: '0xb930c8149bc0bbb0214ae4207164d3b1cb41f395',
  user_id: '28',
});
String resp = client.post("/v2/address/syncStatus", Map.of(
        "coin", "eth",
        "address", "0xb930c8149bc0bbb0214ae4207164d3b1cb41f395",
        "user_id", "28"));

返回结果示例:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: 4bf92f3577b34da6a3ce929d0e0e4736
X-Cbc-Timestamp: 1792382461
X-Cbc-Nonce: 3b5d7f9a1c3e5b7d9f1a3c5e7b9d1f3a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{
  "status":200,
  "msg":"同步成功",
  "data":{
    "address":"0x0603b5a606e6ae28e729d145f4d5a99bd8769950",
    "coin":"eth"
  },
  "date_time":"2020-01-14 00:33:58"
}

HTTP Request

POST /v2/address/syncStatus

请求参数

公共 Header 见签名规则,下表只列 body 中的业务参数。

参数名 必选 类型 说明
coin 是 string 12个字符以内,地址所属主链币种 (若是bnb_bsc请传eth)
address 是 string 地址,128个字符以内
user_id 是 string 关联到地址的用户ID,由字母、数字和下划线组成,长度40以内。

返回参数说明

参数名 必选 类型 说明
status 是 integer 返回状态码
msg 是 string 状态码描述
date_time 是 string 接口返回时间
time_stamp 是 string 无时区时间单位秒
data 是 object 返回数据

注意:商户把地址分配给自己的用户后,一定要请求该接口回传使用状态信息,并获取到 200正确状态码返回值后再开启用户的充提现功能。
*1、如果不同步会影响地址获取接口的使用(已分配未使用的地址数量 超过一定量时,平台不再分配新的地址给商家)。
*2、如果状态同步没有收到正确返回结果,而是报错提示,请人工排查错误。
设计规则:相同币种或合约币,相同商家,相同用户ID 只能分配一个地址。
如果违法上面规则会报错。

地址状态批量同步

请求示例:

POST <base_path>/v2/address/syncBatchStatus HTTP/1.1
Host: api.xxxx.com
Content-Type: application/json
X-Cbc-App-Id: hxgmau9imt86qky9
X-Cbc-Key-Version: admin
X-Cbc-Timestamp: 1792382460
X-Cbc-Nonce: 7c1e9a3b5d7f9b1d3f5a7c9e1b3d5f7a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{"address_list":[{"address":"0x038B8E7406dED2Be112B6c7E4681Df5316957cad","coin":"eth","user_id":"123sa"},{"address":"0xf854AC319A546ae11e367ef80a203AaC923ca6A3","coin":"eth","user_id":"123sb"}]}
resp, err := client.Post("/v2/address/syncBatchStatus", map[string]any{
    "address_list": []map[string]any{
        {"address": "0x038B8E7406dED2Be112B6c7E4681Df5316957cad", "coin": "eth", "user_id": "123sa"},
        {"address": "0xf854AC319A546ae11e367ef80a203AaC923ca6A3", "coin": "eth", "user_id": "123sb"},
    },
})
$resp = $client->post('/v2/address/syncBatchStatus', [
    'address_list' => [
        ['address' => '0x038B8E7406dED2Be112B6c7E4681Df5316957cad', 'coin' => 'eth', 'user_id' => '123sa'],
        ['address' => '0xf854AC319A546ae11e367ef80a203AaC923ca6A3', 'coin' => 'eth', 'user_id' => '123sb'],
    ],
]);
const resp = await client.post('/v2/address/syncBatchStatus', {
  address_list: [
    { address: '0x038B8E7406dED2Be112B6c7E4681Df5316957cad', coin: 'eth', user_id: '123sa' },
    { address: '0xf854AC319A546ae11e367ef80a203AaC923ca6A3', coin: 'eth', user_id: '123sb' },
  ],
});
String resp = client.post("/v2/address/syncBatchStatus", Map.of(
        "address_list", List.of(
                Map.of("address", "0x038B8E7406dED2Be112B6c7E4681Df5316957cad", "coin", "eth", "user_id", "123sa"),
                Map.of("address", "0xf854AC319A546ae11e367ef80a203AaC923ca6A3", "coin", "eth", "user_id", "123sb"))));

返回结果示例:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: 4bf92f3577b34da6a3ce929d0e0e4736
X-Cbc-Timestamp: 1792382461
X-Cbc-Nonce: 3b5d7f9a1c3e5b7d9f1a3c5e7b9d1f3a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{
  "status":200,
  "msg":"请求成功",
  "data":{
    "success_data":[
      {
        "address":"0x038B8E7406dED2Be112B6c7E4681Df5316957cad",
        "user_id":"123sa",
        "coin":"eth"
      }
    ],
    "fail_data":[
      {
        "address":"0xf854AC319A546ae11e367ef80a203AaC923ca6A3",
        "user_id":"123sb",
        "coin":"eth",
        "msg":"该地址已分配给其他用户不能重复分配",
        "status":524,
        "owner_user_id":"345ad"
      }
    ]
  },
  "date_time":"2021-03-22 10:55:58",
  "time_stamp":1616381758
}

HTTP Request

POST /v2/address/syncBatchStatus

请求参数

公共 Header 见签名规则,下表只列 body 中的业务参数。

参数名 必选 类型 长度 说明
address_list 是 array
address_list.address 是 string 128个字符以内 地址
address_list.coin 是 string 12个字符以内 地址所属主链币种 (若是bnb_bsc请传eth)
address_list.user_id 是 string 40以内字符串 关联到地址的用户ID,由字母、数字和下划线组成。

返回参数说明

参数名 必选 类型 说明
status 是 integer 返回状态码
msg 是 string 状态码描述
date_time 是 string 接口返回时间
time_stamp 是 string 无时区时间单位秒
success_data 是 object 成功分配信息
success_data.address 是 string 地址
success_data.coin 是 string 币名
success_data.user_id 是 string 商家用户id
fail_data 是 object 失败分配信息
fail_data.address 是 string 地址
fail_data.coin 是 string 币名
fail_data.user_id 是 string 商家用户id
fail_data.status 是 string 失败code
fail_data.msg 是 string 失败原因描述
fail_data.old_address 是 string 该用户id 已经绑定的地址信息
fail_data.owner_user_id 是 string 当前地址已经绑定的用户信息

注意:商户把地址分配给自己的用户后,一定要请求该接口回传使用状态信息,并获取到 200正确状态码返回值后再开启用户的充提现功能。
1、如果不同步会影响地址获取接口的使用(已分配未使用的地址数量 超过一定量时,平台不再分配新的地址给商家)。
2、如果状态同步没有收到正确返回结果,而是报错提示,请人工排查错误。
设计规则:相同币种或合约币,相同商家,相同用户ID 只能分配一个地址。
如果违法上面规则会报错。

地址验证

请求示例:

POST <base_path>/v2/address/verifyAddress HTTP/1.1
Host: api.xxxx.com
Content-Type: application/json
X-Cbc-App-Id: hxgmau9imt86qky9
X-Cbc-Key-Version: admin
X-Cbc-Timestamp: 1792382460
X-Cbc-Nonce: 7c1e9a3b5d7f9b1d3f5a7c9e1b3d5f7a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{"coin":"trx","address":"TUEgUZh24tA48EXiAQjA6Qf6rSS7bJKQ6g"}
resp, err := client.Post("/v2/address/verifyAddress", map[string]any{
    "coin":    "trx",
    "address": "TUEgUZh24tA48EXiAQjA6Qf6rSS7bJKQ6g",
})
$resp = $client->post('/v2/address/verifyAddress', [
    'coin' => 'trx',
    'address' => 'TUEgUZh24tA48EXiAQjA6Qf6rSS7bJKQ6g',
]);
const resp = await client.post('/v2/address/verifyAddress', {
  coin: 'trx',
  address: 'TUEgUZh24tA48EXiAQjA6Qf6rSS7bJKQ6g',
});
String resp = client.post("/v2/address/verifyAddress", Map.of(
        "coin", "trx",
        "address", "TUEgUZh24tA48EXiAQjA6Qf6rSS7bJKQ6g"));

返回结果示例:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: 4bf92f3577b34da6a3ce929d0e0e4736
X-Cbc-Timestamp: 1792382461
X-Cbc-Nonce: 3b5d7f9a1c3e5b7d9f1a3c5e7b9d1f3a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{
  "status":200,
  "msg":"验证成功",
  "data":null,
  "date_time":"2020-10-20 15:32:16",
  "time_stamp":1603179136
}

HTTP Request

POST /v2/address/verifyAddress

请求参数

公共 Header 见签名规则,下表只列 body 中的业务参数。

参数名 必选 类型 说明
coin 是 string 12个字符内主链币名, 币名平台提供为准
address 是 string 地址

返回参数说明

参数名 必选 类型 说明
status 是 integer 返回值:200 验证成功;543 验证失败;565 币种不支持
msg 否 string 100字内, 状态描述
data 是 object —
date_time 否 string 北京时间:2020-06-29 14:28:14
time_stamp 否 string 响应时间,单位秒:1593412094

地址AML反洗钱风险验证

请求示例:

POST <base_path>/v2/address/verifyAml HTTP/1.1
Host: api.xxxx.com
Content-Type: application/json
X-Cbc-App-Id: hxgmau9imt86qky9
X-Cbc-Key-Version: admin
X-Cbc-Timestamp: 1792382460
X-Cbc-Nonce: 7c1e9a3b5d7f9b1d3f5a7c9e1b3d5f7a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{"chain":"trx","address":"TUEgUZh24tA48EXiAQjA6Qf6rSS7bJKQ6g","skip_api_source":"OK_LINK"}
resp, err := client.Post("/v2/address/verifyAml", map[string]any{
    "chain":           "trx",
    "address":         "TUEgUZh24tA48EXiAQjA6Qf6rSS7bJKQ6g",
    "skip_api_source": "OK_LINK",
})
$resp = $client->post('/v2/address/verifyAml', [
    'chain' => 'trx',
    'address' => 'TUEgUZh24tA48EXiAQjA6Qf6rSS7bJKQ6g',
    'skip_api_source' => 'OK_LINK',
]);
const resp = await client.post('/v2/address/verifyAml', {
  chain: 'trx',
  address: 'TUEgUZh24tA48EXiAQjA6Qf6rSS7bJKQ6g',
  skip_api_source: 'OK_LINK',
});
String resp = client.post("/v2/address/verifyAml", Map.of(
        "chain", "trx",
        "address", "TUEgUZh24tA48EXiAQjA6Qf6rSS7bJKQ6g",
        "skip_api_source", "OK_LINK"));

返回结果示例:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
X-Request-ID: 4bf92f3577b34da6a3ce929d0e0e4736
X-Cbc-Timestamp: 1792382461
X-Cbc-Nonce: 3b5d7f9a1c3e5b7d9f1a3c5e7b9d1f3a
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{
  "data": {
    "address": "0x8e609ac80f4324e499a6efd24f221a2caa868224",
    "chain": "eth",
    "detail": "{\"可疑交易\":[\"大额交易比例较高\",\"存在高频交易行为\",\"交易的集中程度高\"],\"黑地址关联方\":[\"黑客关联方\"]}",
    "level": "MEDIUM",
    "risk_code": 5103,
    "risk_score": "62",
    "source": "OK_LINK",
    "tag": "风险中等:黑地址关联方;可疑交易"
  },
  "date_time": "2023-11-22 18:19:54",
  "msg": "SUCCESS",
  "status": 200,
  "time_stamp": 1700648394
}

HTTP Request

POST /v2/address/verifyAml

请求参数

公共 Header 见签名规则,下表只列 body 中的业务参数。

参数名 必选 类型 说明
chain 是 string 主链币名, 以平台提供为准。传 coin 时可不传,传了须与 coin 所属主链一致
address 是 string 地址
skip_api_source 否 string 指定跳过远程接口查询的aml源,可填写来源 OK_LINK 或 BEOSIN,多个逗号分隔。前提是已通过客服开通来相应来源。
source 否 string 只匹配指定的一种 AML 来源,目前仅支持 BEOSIN,传其他值返回 522
coin 否 string 币名,仅 Beosin 检测使用。有值时以该币种所属主链为准
contract_address 否 string 合约地址,仅 Beosin 检测使用。与 coin 同时传时须与该币种的合约地址一致

返回参数说明

参数名 必选 类型 说明
status 是 integer 返回值:200 成功
msg 否 string 100字内, 状态描述
data 是 object —
data.chain 是 string 主链币名
data.address 是 string 地址
data.risk_code 是 integer 风险标识码,默认0:无风险。非0就是有风险,后续可能增加更多标识码。
data.source 是 string AML数据来源,OK_LINK,SLOW_MIST,BEOSIN
data.tag 否 string 风险描述标签
data.detail 否 string 附带描述
data.risk_score 否 string OK_LINK风险分值,满分100无风险。分值越低风险越高。
data.level 否 string OK_LINK风险等级,SEVERE,HIGH,MEDIUM,LOW,NONE
date_time 否 string 北京时间:2020-06-29 14:28:14
time_stamp 否 string 响应时间,单位秒:1593412094

risk_code错误码说明

risk_code 说明
0 无风险
5001 实施勒索活动,涉及恶意挖矿活动
5002 实施盗币攻击
5003 实施钓鱼活动
5004 实施钓鱼活动,涉及网络犯罪
5101 风险极大(OK_LINK来源的)
5102 风险高(OK_LINK来源的)
5103 风险中等(OK_LINK来源的)
5104 风险低(OK_LINK来源的)
5201 风险极大(BEOSIN来源的)
5202 风险高(BEOSIN来源的)
5203 风险中等(BEOSIN来源的)
5204 风险低(BEOSIN来源的)
xxxx 后续可能增加更多标识码...