ChainUp Custody V2

欢迎来到ChainUp Custody，ChainUp Custody基于深厚的底层钱包技术和安全的区块链钱包架构，将强大的资产托管功通过接口的方式提供给第三方合作伙伴。通过这种方式能帮助合作伙伴在关注于核心业务发展的同时也能确保资产的安全。

您可以通过API

提交传输，并接收传输的实时信息;
安全检查所有事务类型和消息;
与托管钱包的共同管理人制定取款政策;
管理你的钱包和子钱包账户、地址簿和网络连接;
利用反洗钱机制等功能。

所有转账都反映在ChainUp Custody的交易记录、安全策略和对账中心中。

介绍

ChainUp Custody是ChainUp集团依托3年时间所服务的300多家交易所经验，将底层区块链钱包封装成的一套完整的Custody服务，包含资产托管、节点服务、主链币种开发、热门币种一键接入、共管钱包、借贷理财等多种功能服务。

ChainUp Custody通过API、SDK等形式为第三方合作伙伴提供快捷、低成本的集成Custody服务（多达200条主链不限代币的收币、发币等功能）；同时三方合作伙伴亦可通过web端可视化界面 ChainUp Custody 进行资产管理，更有丰富的金融产品供您使用。

目前ChainUp Custody服务客户已突破500家，涉及各行业，如：区块链行业：交易所、项目方、矿工、OTC、借贷等；传统行业：游戏、地产、直播、电商、供应链、媒体等；接入ChainUp Custody的客户，可享受联盟成员之间转账【0手续费】、【秒级到账】等多种优势。

愿景

ChainUp Custody旨在通过搭建一套跨主链，跨项目方的全球金融清算体系，共享联盟成员流量，降低联盟成员成本，提升联盟成员资产使用率，构建区块链领域中的开放银行。让区块链联通万物。

接入指引

您需要按照以下流程进行接入ChainUp Custody

如有任何问题，请您联系商务经理或发邮件至 custody@chainup.com 。

注册账号

下载Custody钱包

方式一：手机浏览器打开链接：https://custody.chainup.com/download

方式二：使用手机扫码打开链接下载：

注册Custody账号

打开【Custody】应用，注册账号（未注册账号登录即注册），支持邮箱与手机号两种方式

完成身份认证

身份认证信息，仅支持一种身份，且认证后不支持更换

完成【身份认证】、【谷歌验证】（身份认证需要平台审核，您可以联系项目经理或客服快速审核）

创建并配置企业钱包

登录ChainUp Custody平台

浏览器打开ChainUp Custody平台，使用【Custody】应用，首页或云端钱包【扫码】功能扫描二维码登录

创建钱包

进入【ChainUp Custody】页面，创建钱包（钱包名称不支持修改，请谨慎填写）

开启币种

开启币种前，请先联系平台开通主链币种（开通主链币种后，对应代币即可免费使用，若未收录可联系平台免费上币)
开通币种后，进入钱包点击【币种管理】，搜索币种
进入编辑页面，开启币种

获取API信息

创建API（目前仅支持一个全功能权限的API）
创建完成，完善公钥信息

开发测试

根据平台提供的技术方案与API文档进行系统对接

商户签约

正式签约

支持线上、线下签约

支付费用

支付系统订阅、安装等费用（具体费用类型以合同为准）

投入使用

协助上线

协助商户正式上线运营

技术支持

平台提供7*24h技术支持

对接方案

为了让客户更便捷、快速的接入Custody，平台基于过往客户的对接经验，梳理了一套比较完善的技术对接方案。具体如下：

获取充币地址
用户充币
用户提币
财务对账

注：若客户项目时间紧迫，可优先开发必须流程【获取充币地址】、【用户充币】、【用户提币】，【财务对账】流程可二期开发。

获取充币地址

客户向Custody系统注册用户（建议使用邮箱）
注册成功后通过Custody系统的UID获取地址

注：提前获取地址有利于用户注册后高效分配地址；若用户注册后再通过接口获取地址，有可能因为网络等其它原因造成获取失败，导致用户无法正常完成业务。

用户充币

1）用户在客户系统内完成注册

2）当用户在前端查看币种充值地址时，客户系统为用户分配币种地址

3）用户向地址充币

4）Custody系统监控区块链地址有充币交易，在Custody系统为客户上账，并主动通知客户系统或客户系统主动获取

5）客户系统确认充币信息有效后给用户上账

6）客户系统通知用户充币成功

注：Custody系统的异步回调是当每笔订单最终态时才会触发，每日最多发送5次；

定时任务：总计回调五次

通知时间：第一次1s, 第二次2min，第三次8min，第四次32min，第五次128min

回调逻辑：

如果回调成功，更新回调状态；

如果回调失败，继续回调，更新下次回调间隔时间；

当回调失败达到5次，停止回调

用户提币

1）用户在客户系统发起提币

2）客户系统审核通过后，通知Custody系统

3）Custody系统向客户系统进行提币信息二次确认

4）客户系统确认提币信息有效后Custody系统校验提币信息，校验通过发起支付

5）Custody系统监控提币订单状态，提币完成，主动通知客户系统或客户系统主动获取

6）客户系统通知用户提币成功

财务对账

1）客户系统按周期与Custody系统对账（建议按日）

2）次日0点获取上一日的所有充币、提币以及消耗的归集矿工费订单

3）客户系统订单与Custody系统内的订单做比对

4）若订单数量、金额、状态等无误则对账成功；否则对账异常，联系ChainUP Custody技术人员协助处理

注：Custody系统内三方系统共有三种成本支出：归集矿工费、提币矿工费、分润手续费；

归集矿工费：账户类型的币种，充币后地址上的资金会归集到热钱包地址，归集走区块链网络，部分主链区块链交易会消耗矿工费，这部分成本由客户承担；此部分资金支出需要联系我方处理
提币矿工费：提币到非ChainUP Custody的地址，走区块链网络需要消耗矿工费（部分币种），消耗的矿工费由三方承担；此部分资金支出在提币订单内可以直接查看；
分润手续费：暂不收取

开发前准备

开发须知

两对公私钥作用（API方式）

第一对公私钥： 开发者在开通资管账号时，需提前生成一对公私钥，其中公钥（rsa_third_pub）提供给平台B，私钥自己保管，私钥为第三方应用调用钱包服务的唯一凭证，请勿透露给任何人。第三方在请求钱包服务时，通过私钥来加密请求参数，平台接受到请求时，通过提供的公钥（rsa_third_pub）来解密请求数据。

第二对公私钥： 开发者开通资管账号后，平台会提供钱包公钥（rsa_wallet_pub）给开发者，第三方应用在接受到钱包的响应数据或异步通知时，需要通过公钥来进行解密。

为什么需要进行提现二次确认（API方式）

钱包服务接收到第三方应用请求时，为了确认该请求为第三方应用合法请求，会调用第三方提供的接口来确认。该过程在一定程度上也能避免第三方私钥丢失所造成的影响，也为钱包服务的安全性提供了一套有效屏障。

域名及API密钥（API方式）

生产环境域名(不支持测试环境):	https://openapi.hicoin.vip/
app_id:	请创建钱包后获取
rsa_wallet_pub:	Custody系统公钥；请创建钱包后从Custody系统获取
rsa_third_prv:	客户私钥；自主生成、保存
rsa_third_pub:	客户公钥；自主生成；请创建钱包后配置到Custody系统

RSA 公私钥生成地址

推荐密码长度：2048

推荐密钥格式：PKCS#8

说明：

rsa_third_prv为第三方应用私钥，主要用于加密请求参数。如果是生产环境，rsa_third_prv由开发者生成，然后将对应的公钥提供给平台。测试环境为了简化开发者对接流程，此处直接提供了一套第三方的公私钥，便于开发者快速对接。
目前不支持测试环境对接，请根据接入指引自主注册创建钱包后，获取生产环境的API相关信息。

资管账号准备

开发者准备如下信息：

1）生成一对公私钥，将公钥提供给平台；

2）第三方应用服务器IP；

3）充值提现回调通知地址；

4）提现二次确认地址；

5）是否开启自动归集功能，开启后，系统会自动将用户充值资金划转到商户归集账户。

联系平台相关人员，提供上述五类信息。平台为您准备资管账号，提供到您这边包括以下信息：

1）商户的唯一标识：app_id；

2）钱包公钥：rsa_wallet_pub。

接口交互过程

文档为钱包服务对第三方应用提供的接口。

以下文档中的接口提供方称为 钱包服务，接口调用方称为 第三方应用。第三方应用在请求钱包服务时，通过RSA算法对请求参数进行加密，接受到钱包服务的响应数据后需要进行解密

接口规则

传输方式:	https(测试环境暂时使用 http)
签名字段:	除了 `sign` 字段，其他所有必填项都需要参与签名
响应状态码为:	`0`表示处理`成功`，非 0 表示请求错误或系统异常
请求地址:	域名+接口地址
加密算法:	RSA，详见 API 文档 `加解密方式`

SDK

为满足客户多样性的业务需求，ChainUp Custody支持两种对接方式：SDK与API

SDK：支持java，PHP和node

Java SDK地址：https://github.com/HiCoinCom/java-sdk

PHP SDK地址：https://github.com/HiCoinCom/php-sdk

node SDK地址：https://github.com/HiCoinCom/js-sdk

API文档

统一说明

请求参数统一格式

Param	类型	是否必须	说明
app_id	String	必须	商户唯一标识
data	String	可选	加密之后的字符串，具体加密信息见各接口 `请求参数数据结构`

请求接口示例

POST/api/v2/user/createUser


POST/api/v2/user/createUser

app_id=baaceb1e506e1b5d7d1f0a3b1622583b&data=GCJBk77n7epyOexdGZ20qvukd321TpJ62lIAtlCinW6TzHx8SIbm6evXGulO87UgLTzIWCtgupgeLJKDdZmC7msuPNBGK--Ec27WZXjuhI0gNWXcOVk5RW_VRVcyfJ1Ml-DMW8XVxZRgA2U1bt9BztiyfryzMGj8_jl1IXd5sOQfPYXulCdm70WyTJpjsDkuMSov6QUmOn-C_-HUoZ7s715EMeZ60D09uUsF0i6mKLhFZTEQZPGPeJITYSJNddAw7nvqvX2KzNc6YUeCQhEmU1Dfxp65W4e3SVOgpd_2Q-dLN1MpOlkUKwbmbpb-gEh_s68yl7ox6WSgKfCK4i_uvA

响应参数统一格式

Param	类型	是否必须	说明
data	String	可选	加密之后的字符串，具体加密信息见 `响应结果data解密后格式`

{
    "data":"LK4D5mrtvTubDxCQM4lqyN2h8TTIkEBL_06FrrrzLrImyMO4Yuac-wdbk5VnGVfCKB5EFaUb162xXUJdTHhpA5CGBCAQKl64h_Dt10C-H8KIoap9dZI90qE4f-mAMAyjF1QzKXJ-f-R_3J3bRGqfHFBRXebh08R8MdRDssniopVOhsFUs4gBxUensKas3_ta15eFIqXPjIgJWfYQCD2DUi1gaKgmN-5Q_tgt-qXp5Y2uh3yfM4g4k71Ahyel3G8S_AktbWl2G9wU3cri3ZVQEo0faIpkX_CKsk9V1YoY5yRopvJbxNtkG9lBFxKnureAQo0KP3f1tsIMOzgcyEXPnA"
}

响应结果data解密后格式

Param	类型	是否必须	说明
code	String	是	状态码，例：100002
msg	String	是	响应结果说明，例：请求参数错误
data	String	否	具体响应数据，数据结构定义见各接口 `响应参数数据结构`

加解密方式

请求参数data与响应字段data的值都是经过rsa加密后再通过 base64urlsafe 加密的结果

获取地址

请注意，默认注册用户量为5万个，如果用户超过上限，请联系相关运营人员进行协助

用户手机注册

注册成为钱包的用户

HTTP请求

POST/api/v2/user/createUser

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
version	String	必填	接口版本号，无特殊情况，传参数v2
country	String	必填	国家编号，如：86表示中国
mobile	String	必填	手机号

{
    "code":"0",
    "data":{
        "uid":3529218
    },
    "msg":"成功"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
uid	int	是	用户在钱包服务的唯一标识

用户邮箱注册

注册成为钱包的用户。满足邮箱格式即可（e.g. 123@111.com）

HTTP请求

POST /api/v2/user/registerEmail

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
version	String	必填	接口版本号，无特殊情况，传参数v2
email	String	必填	邮箱或虚拟账号，确保其唯一性,最多支持100字符

{
    "code":"0",
    "data":{
        "uid":3529218
    },
    "msg":"成功"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
uid	int	是	用户在钱包服务的唯一标识

获取指定充币地址

获取用户指定币账户地址。如果没有地址，则给用户分配一个地址，此时不应生成账户，账户还是按需生成。

HTTP请求

POST/api/v2/account/getDepositAddress

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
version	String	必填	接口版本号，无特殊情况，传参数v2
uid	String	必填	用户ID
symbol	String	必填	币种

{
    "code":"0",
    "data":{
        "uid":"3529218",
        "address":"0x6956f9af53b22117f2fc94dfe7c74ff3893b2acd"
    },
    "msg":"成功"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
uid	int	是	用户在钱包服务的唯一标识
address	String	是	币种账户地址

账户资产

查询用户信息

查询用户信息。

HTTP请求

GET/api/v2/user/info

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
version	String	必填	接口版本号，无特殊情况，传参数v2
country	String	可选	国家编号，mobile不为空时，该字段必填。如：86
mobile	String	可选	手机号，手机和邮箱需要保证其中之一不能为空
email	string	可选	邮箱，手机和邮箱需要保证其中之一不能为空

{
    "code":"0",
    "data":{
        "uid":3529218,
        "nickname":""
    },
    "msg":"成功"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
uid	int	是	用户在钱包服务的唯一标识
nickname	String	是	用户昵称

获取币种列表

获取商户的币种列表

HTTP请求

GET/api/v2/user/getCoinList

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
version	String	必填	接口版本号，无特殊情况，传参数v2


{
  "code":"0",
  "data":[
      {
          "symbol":"BTC",
          "icon":"http://chainup-oss.oss-cn-beijing.aliyuncs.com/saas/1565681771193.png",
          "real_symbol":"BTC",
          "decimals":"8",
          "name":"Bitcoin",
          "base_symbol":"BTC",
          "contract_address":"",
          "deposit_confirmation":"2",
          "explorer":"https://btc.com/",
          "address_regex":"^(1|3)[a-zA-Z0-9]{24,36}$",
          "address_tag_regex":"",
          "support_memo":"0",
          "support_token":"0"
      }
   ]
 }

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
symbol	String	是	币种（调用提币的接口，及任何查询接口时务必使用此字段返回的值）
icon	String	是	币种icon
real_symbol	String	是	币种链上名称
decimals	String	是	精度
name	string	是	币种全称
base_symbol	string	是	主链币币名
contract_address	string	是	合约地址
deposit_confirmation	string	是	币种充值确认数
explorer	string	是	区块浏览器
address_regex	string	是	地址正则
address_tag_regex	string	是	tag正则
support_memo	string	是	是否支持memo，0不支持1支持
support_token	string	是	是否支持token币，0不支持1支持,主链币才有值,代币为空

获取指定账户信息

根据币种及用户ID查询用户的账户。另外，若商户开启自动归集后，用户账户将被转移到商户的归集账户中

HTTP请求

GET/api/v2/account/getByUidAndSymbol

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
vesion	String	必填	接口版本号，无特殊情况，传参数v2
uid	String	必填	用户ID
symbol	String	必填	币种

{
    "code":"0",
    "data":{
        "normal_balance":"2.99400066",
        "deposit_address":"0x6956f9af53b22117f2fc94dfe7c74ff3893b2acd",
        "lock_balance":"0"
    },
    "msg":"成功"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
normal_balance	String	必填	正常账户余额
lock_balance	String	必填	冻结账户余额
deposit_address	String	必填	币种对应的充值地址

获取归集账户余额

开启商户资金自动归集之后，商户可以通过该接口种获取商户归集账户余额

HTTP请求

GET/api/v2/account/getCompanyBySymbol

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
vesion	String	必填	接口版本号，无特殊情况，传参数v2
symbol	String	必填	币种

{
    "code":"0",
    "data":{
        "symbol":"ETH",
        "balance":"64.97599802"
    },
    "msg":"成功"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
symbol	String	必填	币种名称
balance	String	必填	归集账户余额

用户充值

同步充值记录

HTTP请求

GET/api/v2/billing/syncDepositList

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
version	String	必填	接口版本号，无特殊情况，传参数v2
max_id	int	必填	返回大于id的100条充值记录数据

{
    "code":"0",
    "data":[
        {
            "withdraw_fee":"0",
            "symbol":"BTC",
            "amount":"0.0001",
            "real_fee":"0",
            "fee":"0",
            "address_to":"1CfYiePwcf3mWhLBQH2ac35C7jmE2udQqH",
            "created_at":1539050731000,
            "txid":"",
            "confirmations":0,
            "address_from":"",
            "uid":10596,
            "withdraw_fee_symbol":"BTC",
            "fee_symbol":"BTC",
            "saas_status":0,
            "updated_at":1543483252000,
            "company_status":2,
            "id":45325,
            "request_id":"",
            "status":2
        },
        {
            "withdraw_fee":"0.0000001",
            "symbol":"BTC",
            "amount":"0.0001",
            "real_fee":"0",
            "fee":"0.0000001",
            "address_to":"17m2GM8aRrrnxPt5JhYPJd4qUFqF8rJDop",
            "created_at":1539065092000,
            "txid":"",
            "confirmations":0,
            "address_from":"",
            "uid":10595,
            "withdraw_fee_symbol":"BTC",
            "fee_symbol":"BTC",
            "saas_status":1,
            "updated_at":1543851222000,
            "company_status":2,
            "id":45332,
            "request_id":"",
            "status":2
        }
    ],
    "msg":"成功"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
id	int	必填	充值唯一id
uid	int	必填	充值用户id
symbol	String	必填	币种
amount	String	必填	充值金额
created_at	Long	必填	创建时间
updated_at	Long	必填	修改时间
txid	String	必填	区块链交易ID
confirmations	int	必填	区块链确认数
address_from	String	必填	来源地址
address_to	String	必填	充值到帐地址
status	int	必填	0待确认，1 成功，2 失败，4 待KYT验证，5 待人工审核(KYT风险等级过高)，6 待人工审核(KYT充值熔断)

批量充值记录

HTTP请求

GET/api/v2/billing/depositList

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
version	String	必填	接口版本号，无特殊情况，传参数v2
ids	String	必填	多个充值id使用逗号隔开，最多100个id

{
    "code":"0",
    "msg":"suc",
    "data":[
        {
            "id":1,
            "uid":11,
            "symbol":"ETH",
            "amount":"0.0002000000000000",
            "created_at":1545273830000,
            "updated_at":1545273830000,
            "txid":"78d1edef3b3fd14365f88cf2d03e8c29ec49ac1a43cedde9e21d320b3268f4de",
            "confirmations":11,
            "status":1,
            "address_to":"0xcb03bfdccb50c9f62ec1c728f264bf453e037132"
        },
        {
            "id":2,
            "uid":12,
            "symbol":"ETH",
            "amount":"0.0002000000000000",
            "created_at":1545273830000,
            "updated_at":1545273830000,
            "txid":"0xd609e050c3d573fb715431edbd36cc08eaa475f813de921026a65c0a96e8113e",
            "confirmations":11,
            "status":1,
            "address_to":"0xcb03bfdccb50c9f62ec1c728f264bf453e037132"
        }
    ]
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
id	int	必填	充值唯一id
uid	int	必填	充值用户id
symbol	String	必填	币种
amount	String	必填	充值金额
created_at	Long	必填	创建时间,时间戳
updated_at	Long	必填	修改时间，时间戳
txid	String	必填	区块链交易ID
confirmations	int	必填	区块链确认数
address_from	String	必填	来源地址
address_to	String	必填	充值到帐地址
status	int	必填	0待确认，1 成功，2 失败，4 待KYT验证，5 待人工审核(KYT风险等级过高)，6 待人工审核(KYT充值熔断)

用户充值异步回调通知

说明:	此接口仅定义了接口规范，具体接口需要开发者实现
接口地址:	接口地址由开发者提供，联系管理员在平台进行配置即可
请求方式:	POST

请求参数data解密之后数据结构:

充值通知：

Param	类型	是否必须	说明
charset	String	是	编码格式，无特殊情况，传参数utf-8
version	String	是	接口版本号，无特殊情况，传参数v2
side	String	是	通知类型，充值通知：deposit，提现通知： withdraw
notify_time	string	是	通知时间
id	string	是	充值id
uid	string	是	提现用户id
symbol	string	是	币种
amount	string	是	提现金额
address_to	string	是	充值地址
created_at	string	是	创建时间
updated_at	string	是	修改时间
txid	string	是	区块链交易ID
confirmations	string	是	区块链确认数
status	string	是	充值状态 0待确认，1 成功，2 失败，4 待KYT验证，5 待人工审核(KYT风险等级过高)，6 待人工审核(KYT充值熔断)

响应参数:

返回字符串：SUCCESS表示成功，FAILURE表示失败（注意此处返回参数无需进行加密）

获取归集矿工费

账户类型的币种充值后需要进行归集，UTXO无归集矿工费费用

HTTP请求

GET//api/v2/billing/syncMinerFeeList

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数 utf-8
version	String	必填	接口版本号，无特殊情况，传参数 v2
max_id	int	必填	返回大于 id 的 100 条归集矿工费记录数据


{ "code":"0",
  "data":[
         {
         "id":1,
          "symbol":"BTC",
          "amount":"11",
          "fee":"0.00111",
          "created_at":1539050731000,
          "updated_at":1543483252000,
          "txid":"",
          "confirmations":0,
          "status":2,
          "address_from":"",
          "address_to":"",
          "txid_type":"1",
          "base_symbol":"",
          "contract_address":"123",
          "email":""
          }
     ],
  "msg": "成功"
  }

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
id	int	是	归集唯一ID
symbol	String	是	币种
amount	String	是	归集金额
fee	String	是	归集手续费
created_at	Long	是	创建时间
updated_at	Long	是	修改时间
txid	String	是	区块链交易ID
confirmations	int	是	区块链确认数
status	int	是	0待确认，1 成功，2 失败，4 待KYT验证，5 待人工审核(KYT风险等级过高)，6 待人工审核(KYT充值熔断)
address_to	String	是	充值到账地址
address_from	String	是	充值发送地址
txid_type	String	是	0 链上交易，1 联盟转账交易
base_symbol	String	是	主链币名称
contract_address	String	是	币种合约地址
email	String	是	邮箱

用户提现

发起提现

如果提现地址为联盟内部地址，则不会上链；否则需要上链。另外，为了避免非法的提现请求，钱包服务在接收到第三方应用的提现请求时，会调用第三方提供的[提现二次确认接口。

HTTP请求

POST/api/v2/billing/withdraw

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
version	String	必填	接口版本号，无特殊情况，传参数v2
request_id	String	必填	请求唯一标识，最多支持64位
from_uid	String	必填	转出用户ID
to_address	String	必填	转入用户地址，memo类型，使用"_"进行拼接，如: eos_24545
amount	String	必填	提现金额，包含提现手续费；手续费需要在商户后台配置
symbol	String	必填	提现币种

{
    "code":"0",
    "data":{
        "id":48680,
        "status":0
    },
    "msg":"成功"
}

响应参数data解密之后数据结构:

param	type	是否必须	说明
status	string	必填	0 风控审核中，1 支付中，2 审核拒绝，4 失败，5 成功， 6 已撤销，7 待KYT验证， 8 待人工审核(KYT风险等级过高)

提现信息二次确认

说明:	平台在接收到提现请求之后，会调用第三方提供的二次确认接口，来确认该请求为商户正常发起的提现请求。此接口仅定义了接口规范，具体接口需要开发者实现。
接口地址:	接口地址由开发者提供，联系管理员在平台进行配置即可
请求方式:	POST

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	是	当前时间戳
charset	String	是	编码格式，无特殊情况，传参数utf-8
version	String	是	接口版本号，无特殊情况，传参数v2
request_id	String	是	请求唯一标识
from_uid	String	是	转出用户ID
to_address	String	是	转入用户地址
amount	String	是	提现金额，包含提现手续费；手续费需要在商户后台配置
symbol	String	是	提现币种
check_sum	String	是	随机校验码，第三方原样返回此字段平台认为成功

{
    "check_sum":"1234",
    "time":"12345678"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
check_sum	String	必填	请求参数中的check_sum
time	String	必须	时间戳

提现异步回调通知

说明:	此接口仅定义了接口规范，具体接口需要开发者实现
接口地址:	接口地址由开发者提供，联系管理员在平台进行配置即可
请求方式:	POST

请求参数data解密之后数据结构:

提现通知：

Param	类型	是否必须	说明
charset	String	是	编码格式，无特殊情况，传参数utf-8
version	String	是	接口版本号，无特殊情况，传参数v2
side	String	是	通知类型，充值通知：deposit，提现通知： withdraw
notify_time	String	是	通知时间
request_id	String	是	提现请求ID，对应提现接口中的request_id
id	String	是	提现id
uid	String	是	提现用户id
symbol	String	是	币种
amount	String	是	提现金额
withdraw_fee_symbol	String	是	提现手续费币种
withdraw_fee	String	是	提现手续费
fee_symbol	String	是	挖矿手续费币种
real_fee	String	是	矿工费
address_to	String	是	充值地址
created_at	String	是	创建时间
updated_at	String	是	修改时间
txid	String	是	区块链交易ID
confirmations	String	是	区块链确认数
status	String	是	提现状态: 0 风控审核中，1 支付中，2 审核拒绝，4 失败，5 成功， 6 已撤销，7 待KYT验证， 8 待人工审核(KYT风险等级过高)

响应参数:

返回字符串：SUCCESS表示成功，FAILURE表示失败（注意此处返回参数无需进行加密）

同步提现记录

批量获取提现记录

HTTP请求

GET/api/v2/billing/syncWithdrawList

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
version	String	必填	接口版本号，无特殊情况，传参数v2
max_id	String	必填	返回大于id的100条充值记录数据

{
    "code":"0",
    "data":[
        {
            "withdraw_fee":"0.4",
            "symbol":"LTC",
            "amount":"10",
            "real_fee":"0",
            "fee":"0",
            "address_to":"LhFrA5ZJL15UdRV1uEfFxfdqWJUbBhXpRk1",
            "created_at":1551429063000,
            "txid":"",
            "confirmations":0,
            "address_from":"",
            "uid":10739,
            "withdraw_fee_symbol":"ETH",
            "fee_symbol":"LTC",
            "saas_status":0,
            "updated_at":1551429063000,
            "company_status":0,
            "id":48393,
            "request_id":"123",
            "status":0
        }
    ],
    "msg":"成功"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
request_id	String	必填	请求id,
id	int	必填	提现id
uid	int	必填	提现用户id
symbol	String	必填	币种
amount	String	必填	提现金额
withdraw_fee_symbol	String	必填	提现手续费币种
withdraw_fee	String	必填	提现手续费
fee_symbol	String	必填	挖矿手续费币种
real_fee	String	必填	矿工费
created_at	Long	必填	创建时间
updated_at	Long	必填	修改时间
address_from	String	必填	来源地址
address_to	String	必填	到账地址
txid	String	必填	区块链交易ID
confirmations	int	必填	区块链确认数
saas_status	int	必填	平台审核状态:0 未审核，1 已审核，2 审核拒绝
company_status	int	必填	商户审核状态:0 未审核，1 已审核，2 审核拒绝
status	int	必填	提现状态: 0 风控审核中，1 支付中，2 审核拒绝，4 失败，5 成功， 6 已撤销，7 待KYT验证， 8 待人工审核(KYT风险等级过高)

批量获取提现记录

HTTP请求

GET/api/v2/billing/withdrawList

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数utf-8
version	String	必填	接口版本号，无特殊情况，传参数v2
ids	String	必填	多个request_id使用逗号隔开，最多100个request_id

{
    "code":"0",
    "data":[
        {
            "withdraw_fee":"0.4",
            "symbol":"LTC",
            "amount":"10",
            "real_fee":"0",
            "fee":"0",
            "address_to":"LhFrA5ZJL15UdRV1uEfFxfdqWJUbBhXpRk1",
            "created_at":1551429063000,
            "txid":"",
            "confirmations":0,
            "address_from":"",
            "uid":10739,
            "withdraw_fee_symbol":"ETH",
            "fee_symbol":"LTC",
            "saas_status":0,
            "updated_at":1551429063000,
            "company_status":0,
            "id":48393,
            "request_id":"123",
            "status":0
        }
    ],
    "msg":"成功"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
request_id	String	必填	请求id
id	int	必填	提现id
uid	int	必填	提现用户id
symbol	String	必填	币种
amount	String	必填	提现金额
withdraw_fee_symbol	String	必填	提现手续费币种
withdraw_fee	String	必填	提现手续费
fee_symbol	String	必填	挖矿手续费币种
real_fee	String	必填	矿工费
created_at	Long	必填	创建时间,
updated_at	Long	必填	修改时间
address_from	String	必填	来源地址
address_to	String	必填	到账地址
txid	String	必填	区块链交易ID
confirmations	int	必填	区块链确认数
saas_status	int	必填	平台审核状态
company_status	int	必填	商户审核状态
status	int	必填	提现状态: 0 风控审核中，1 支付中，2 审核拒绝，4 失败，5 成功， 6 已撤销，7 待KYT验证， 8 待人工审核(KYT风险等级过高)

商户转账

Custody商户转账

Custody内部商户互相转账

HTTP请求

POST/api/v2/account/transfer

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	Long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数`utf-8`
version	String	必填	接口版本号，无特殊情况，传参数`v2`
request_id	String	必填	请求唯一标识，最多支持64位
symbol	String	必填	转账币种，Custody获取币种名称
amount	String	必填	转账数量，包含转账手续费
to	String	必填	转入商户，目前填写商户`APPID`
remark	String	选填	备注字段

{
    "code":"0",
    "data":[
        {
            "receipt":"abcdesd",
        }
    ],
    "msg":"成功"
}

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
receipt	String	必填	转账唯一凭证

转账信息异步确认

HTTP请求

POST/same-with-withdraw-check-sum

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	Long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数`utf-8`
version	String	必填	接口版本号，无特殊情况，传参数`v2`
request_id	String	必填	请求唯一标识，最多支持64位
symbol	String	必填	币种
amount	String	必填	转账数量，包含转账手续费
to	String	必填	转入商户，目前填写商户`APPID`
check_sum	String	必填	随机校验码，第三方原样返回此字段平台认为成功
remark	String	选填	备注字段

    {
"code":"0",
"data":[
    {
        "time":1551429063111,
        "check_sum":"123124",
    }
],
"msg":"成功"
    }

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
check_sum	String	必填	随机校验码，第三方原样返回此字段平台认为成功

批量查询转账记录

HTTP请求

POST/api/v2/account/transferList

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数`utf-8`
version	String	必填	接口版本号，无特殊情况，传参数`v2`
ids	String	必填	请求唯一标识,多个之间用英文逗号分割，最多100个
ids_type	String	必填	request_id：请求ID（默认）；receipt：转账凭证

    {
"code":"0",
"data":[
    {
        "id":"123",
        "symbol":"ETH",
        "amount":"0.002",
        "from":"0xc0ff095a9f1608f6873e74b84671640364107dc4",
        "to":"0xc0ff095a9f1608f6873e74b84671640364107dc5",
        "created_at":1551429063000,
        "request_id":"123123",
        "receipt":"4444444",
        "remark":"备注信息"
    }
    {
        "id":"124",
        "symbol":"ETH",
        "amount":"0.002",
        "from":"0xc0ff095a9f1608f6873e74b84671640364107dc4",
        "to":"0xc0ff095a9f1608f6873e74b84671640364107dc5",
        "created_at":1551429063111,
        "request_id":"123124",
        "receipt":"4444445",
        "remark":"备注信息"
    }
],
"msg":"成功"
    }

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数`utf-8`
version	String	必填	接口版本号，无特殊情况，传参数`v2`
id	String	必填	请求唯一标识，最多支持64位
symbol	String	必填	币种
amount	String	必填	转账数量，包含转账手续费
from	String	必填	转出商户`APPID`
to	String	必填	转入商户`APPID`
created_at	Long	必填	创建时间
request_id	String	必填	三方ID
receipt	String	必填	转账凭证
remark	String	必填	最大支持32字符

同步转账记录

HTTP请求

POST/api/v2/account/syncTransferList

请求参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数`utf-8`
version	String	必填	接口版本号，无特殊情况，传参数`v2`
max_id	String	必填	返回大于id的100条转账记录数据

   {
"code":"0",
"data":[
    {
        "id":"123",
        "symbol":"ETH",
        "amount":"0.002",
        "from":"0xc0ff095a9f1608f6873e74b84671640364107dc4",
        "to":"0xc0ff095a9f1608f6873e74b84671640364107dc5",
        "created_at":1551429063000,
        "request_id":"123123",
        "receipt":"4444444",
        "remark":"备注信息"
    }
    {
        "id":"124",
        "symbol":"ETH",
        "amount":"0.002",
        "from":"0xc0ff095a9f1608f6873e74b84671640364107dc4",
        "to":"0xc0ff095a9f1608f6873e74b84671640364107dc5",
        "created_at":1551429063111,
        "request_id":"123124",
        "receipt":"4444445",
        "remark":"备注信息"
    }
],
"msg":"成功"
    }

响应参数data解密之后数据结构:

Param	类型	是否必须	说明
time	long	必填	当前时间戳
charset	String	必填	编码格式，无特殊情况，传参数`utf-8`
version	String	必填	接口版本号，无特殊情况，传参数`v2`
id	String	必填	请求唯一标识，最多支持64位
symbol	String	必填	币种
amount	String	必填	转账数量，包含转账手续费
from	String	必填	转出商户`APPID`
to	String	必填	转入商户`APPID`
created_at	Long	必填	创建时间
request_id	String	必填	三方ID
receipt	String	必填	转账凭证
remark	String	必填	最大支持32字符

错误码

code	msg
0	成功
100001	系统错误
100004	请求参数不合法(提现二次确认接口回调失败)
100005	签名校验失败
100007	非法IP
100015	商户ID无效
100016	商户信息过期
110004	用户被冻结不可提现
110023	手机号已注册
110037	提现地址存在风险
110055	提现地址错误
110065	请求用户用户不存在（获取用户余额、提现或转账时用到）
110078	提现或转账金额小于最小转出金额
110087	提现或转账金额大于最大转出金额
110088	请勿重复提交请求
110089	注册手机号不正确
110101	用户注册失败
110161	超过提现最大支持精度
120202	币种不支持
120206	提现二次确认失败
120402	提现或转账余额不足
120403	提现手续费余额不足
120404	提现或转账金额太小, 小于等于手续费
900006	用户存在风险，禁止提现
3040006	不能给自己转账