NAV
go php js java

充值

充值列表

请求示例:

POST <base_path>/v2/receive/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>

{"page":1,"page_size":20,"coin":"eth","order_id":"20200803220112662436","status":1,"start_time":1578736053,"end_time":1578836053,"sort_num":2}

resp, err := client.Post("/v2/receive/list", map[string]any{
    "page":       1,
    "page_size":  20,
    "coin":       "eth",
    "order_id":   "20200803220112662436",
    "status":     1,
    "start_time": 1578736053,
    "end_time":   1578836053,
    "sort_num":   2,
})
$resp = $client->post('/v2/receive/list', [
    'page' => 1,
    'page_size' => 20,
    'coin' => 'eth',
    'order_id' => '20200803220112662436',
    'status' => 1,
    'start_time' => 1578736053,
    'end_time' => 1578836053,
    'sort_num' => 2,
]);
const resp = await client.post('/v2/receive/list', {
  page: 1,
  page_size: 20,
  coin: 'eth',
  order_id: '20200803220112662436',
  status: 1,
  start_time: 1578736053,
  end_time: 1578836053,
  sort_num: 2,
});
String resp = client.post("/v2/receive/list", Map.of(
        "page", 1,
        "page_size", 20,
        "coin", "eth",
        "order_id", "20200803220112662436",
        "status", 1,
        "start_time", 1578736053,
        "end_time", 1578836053,
        "sort_num", 2));

返回结果示例:

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, "count":9, "list":[ { "coin":"hc", "txid":"b064a252228105d7be10fefabf02fcdfbb863a071304298f7c3c1c1ace471e2b", "total":"0.30000000", "chain":"hc", "confirm_count":"6", "order_id":"20200803220112662436", "status":"0", "address":"0", #入账地址, "from_address":"0", #转出地址, "time":"1583922327", #新增status=1的时间如果没有为status=0的时间 "type":"1" } ] }, "date_time":"2020-03-11 18:25:27", "time_stamp":1583922327 }

通过批量查询接口查询订单状态情况

HTTP Request

POST /v2/receive/list

请求参数

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

参数名 必选 类型 说明
page 否 integer,默认值为1 1<= N <=Max, N>Max ? N=Max ; N<1 ? N=1
coin 否 string 币名(如:eth)
txid 否 string 链上 txid。传 txid 时按 txid 精确查询,忽略 coin、address;只允许字母和数字,不超过 70 个字符,否则返回 569
address 否 string 充值地址,按地址筛选
order_id 否 string 平台 订单号
status 否 integer 0 待审核 1 转入成功
start_time 否 integer 开始时间(创建时间) 格式 :时间戳
end_time 否 integer 结束时间(创建时间) 格式 :时间戳
page_size 否 integer 每页数量 (20 ~100),默认 20
sort_num 否 integer 列表排序规则 默认按入系统时间正序排列( 1 正序 ; 2 倒序)

返回参数说明

参数名 类型 说明
status integer 状态码
msg string 状态描述
data object trade_id-由商户提供
data.page integer 第几页
data.count integer 本页记录数
data.list array 具体每条记录
data.list.coin string 币种
data.list.txid string 链上txid
data.list.total string 总金额
data.list.chain string 主链币名
data.list.confirm_count string 确认数
data.list.order_id string 订单号
data.list.status string 0入账但未确认 1确认成功 5失败 8等待退款 10退款中 20已退款
data.list.address string 转入地址
data.list.from_address string 转出地址
data.list.time string 默认为status=1的时间,如果status=0就是status=0的时间
data.list.type string 1站内充值 2链上充值
date_time string 响应时间
time_stamp integer 无时区的秒

账户余额查询

请求示例:

POST <base_path>/v2/balance 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":"etc"}
resp, err := client.Post("/v2/balance", map[string]any{
    "coin": "etc",
})
$resp = $client->post('/v2/balance', [
    'coin' => 'etc',
]);
const resp = await client.post('/v2/balance', {
  coin: 'etc',
});
String resp = client.post("/v2/balance", Map.of("coin", "etc"));

返回结果示例:

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": {
    "chain_hot_amount": "0",
    "amount": "0",
    "freeze_amount": "0",
    "total": "0",
    "waiting_collect_amount": "0"
  },
  "date_time": "2022-07-22 19:03:08",
  "time_stamp": 1658487788
}

币种余额查询接口,返回单个币种的链上充值剩余总余额。

HTTP Request

POST /v2/balance

请求参数

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

参数名 必选 类型 说明
coin 是 string 20个字符内币名,币名平台提供为准

返回参数说明

参数名 类型 说明
status integer 状态码
msg string 状态描述
data object 余额信息
data.amount string 总可用余额
data.freeze_amount string 冻结余额
data.total string 冻结+可用余额
data.chain_hot_amount string 链上热钱包余额
date_time string 响应时间
time_stamp integer 无时区的秒

充值结果回调通知

回调请求示例:

POST <商户提供的回调地址>
Content-Type: application/json
X-Cbc-Timestamp: 1792382460
X-Cbc-Nonce: 9f2c4e6a8b0d1f3e5a7c9e1b3d5f7a9c
X-Cbc-Sign-Alg: RSA-SHA256
X-Cbc-Signature: <base64>

{
  "data": {
    "order_id": "2020010211153423123456",
    "coin": "usdt_erc20",
    "chain": "eth",
    "address": "0x038B8E7406dED2Be112B6c7E4681Df5316957cad",
    "from_address": "0xf854AC319A546ae11e367ef80a203AaC923ca6A3",
    "txid": "0x735dc8becd0d5dc0023b526584b75c8772551fc9268668991608dadc69facb39",
    "amount": "10.0089",
    "fee": "0",
    "total": "10.0089",
    "status": 1,
    "confirm_count": 12,
    "time": 1650011196,
    "type": 2
  }
}
http.HandleFunc("/notify/deposit", func(w http.ResponseWriter, r *http.Request) {
    body, _ := io.ReadAll(r.Body)
    if err := cbc.VerifyBody(r.Header, body, client.PlatformKey, true); err != nil {
        http.Error(w, "invalid signature", http.StatusUnauthorized)
        return
    }
    // 验签已通过:按 X-Cbc-Nonce 去重后再解析 body,处理 data
    w.Header().Set("Content-Type", "application/json")
    w.Write([]byte(`{"status":200,"data":{"success_data":"success"}}`))
})
$body = file_get_contents('php://input');
$headers = array_change_key_case(getallheaders(), CASE_LOWER);
try {
    CbcClient::verifyBody($headers, $body, $platformPublicKeyPem, true);
} catch (RuntimeException $e) {
    http_response_code(401);
    exit;
}
// 验签已通过:按 X-Cbc-Nonce 去重后再解析 body,处理 data
$notify = json_decode($body, true);
header('Content-Type: application/json');
echo '{"status":200,"data":{"success_data":"success"}}';
app.post('/notify/deposit', express.raw({ type: 'application/json' }), (req, res) => {
  try {
    verifyBody((name) => req.get(name), req.body, platformPublicKeyPem, true);
  } catch (e) {
    return res.status(401).end();
  }
  // 验签已通过:按 X-Cbc-Nonce 去重后再解析 body,处理 data
  const notify = JSON.parse(req.body);
  res.type('application/json').send('{"status":200,"data":{"success_data":"success"}}');
});
@PostMapping(value = "/notify/deposit", produces = "application/json")
public ResponseEntity<String> notify(@RequestHeader HttpHeaders headers, @RequestBody byte[] body) {
    Map<String, String> sig = new HashMap<>();
    for (String name : new String[]{"X-Cbc-Timestamp", "X-Cbc-Nonce", "X-Cbc-Sign-Alg", "X-Cbc-Signature"}) {
        sig.put(name, headers.getFirst(name));
    }
    try {
        CbcClient.verifyBody(sig, body, platformKey, true);
    } catch (Exception e) {
        return ResponseEntity.status(401).build();
    }
    // 验签已通过:按 X-Cbc-Nonce 去重后再解析 body,处理 data
    return ResponseEntity.ok("{\"status\":200,\"data\":{\"success_data\":\"success\"}}");
}

商户应答示例:

{
  "status": 200,
  "data": {
    "success_data": "success"
  }
}

用户充值到账通知回调,有平台发起请求,商户响应

HTTP Request

POST: 具体回调地址,由商户提供给平台方

请求参数

请求 Header 与接收端校验步骤见回调与复核签名。先用平台公钥验签,通过后再解析 body;下表为 body 中的字段。

参数名 必选 类型 说明
data 否 string 回调通知携带数据结构
data.order_id 是 string 订单号
data.coin 是 string 币名
data.chain 是 string 主链币名
data.address 是 string 入账地址
data.from_address 是 string 转出地址,正式环境2023-05-05之后接入的商户才会返回该属性
data.txid 是 string 链上txid
data.total 是 string 实际到账 total = amount - fee
data.fee 是 string 平台手续费
data.amount 否 string 链上金额(本字段仅供参考)
data.status 是 integer 0入账但未确认 1确认成功 5失败 8等待退款 10退款中 20已退款
data.confirm_count 是 integer 确认数仅供参考,以status=1为入账成功
data.time 是 integer 订单确认时间
data.type 是 integer 1站内充值 2链上充值
data.reject_reason 否 string 商户审核时选择的拒绝原因,值描述见后面的表格。默认不会有该参数,需要返回请联系商务人员。
data.user_id 否 string 地址关联的用户ID。按需开通,需要请联系商务人员
data.is_black 否 integer 来源地址是否命中风险地址:1 是 0 否。按需开通
data.black_tag 否 string 风险标签。按需开通
data.black_source 否 string 风险来源:HBC、SLOW_MIST、OK_LINK、BEOSIN、ELLIPTIC。按需开通
data.black_score 否 string 风险分数,仅 OK_LINK、BEOSIN 来源下发。按需开通
data.black_level 否 string 风险等级,仅 OK_LINK、BEOSIN 来源下发。按需开通
data.is_frozen_by_tr 否 boolean 命中 Travel Rule 冻结时下发,值为 true
data.transfer_id 否 string Travel Rule 交易授权 ID,命中 Travel Rule 冻结时下发,未匹配到授权时为空字符串

返回参数说明

参数名 必选 类型 说明
status 是 integer 状态码
data 是 object 返回数据对象
data.success_data 是 string success 接收成功

请求参数中data.reject_reason说明

值 描述说明
no-shop-coin 商户没有配置币种
shop-coin-no-recharge 币种没有开通充值功能
aml-slow-mist 慢雾检测:风险地址
aml-ok-link OKLink检测:风险地址
other 其他