接口文档

 

1 接入方式说明

1.1      调用入口

测试环境：http://18test-app.stg3.1768.com/ItemSubaccount

1.2     消息结构

1.3          接口请求结构如下:

{

      "head"：{             //报文头

           "apiVersion": "",  //报文版本号

           "reqAppId": "",   //请求方身份标示

           "custString": "",   //请求方自定义字符串，服务端照原样返回

           "reqTime": "",    //请求时间, 服务端照原样返回

       }，

      "body"：请求信息

}

1.4          接口响应结构如下

{

"head"：{             //报文头

   "apiVersion": "",   //号

   "reqAppId": "",    //请求方身份标示

   "custString": "",   //请求方自定义字符串，服务端照原样返回

   "reqTime": "",    //请求时间, 服务端照原样返回

   "rspTime": ""     //应答时间，服务端处理处理完请求数据后的时间戳

   "rspCode": "",    //应答码，（对应值：正确为：0；请求验签不正确：1；请求输入参数不正确：2；服务器内部错误：3）

   "rspMsg": "",    //应答描述

}，

"body"：响应信息

}

2 接口说明

 

2.1房卡余额充值入游戏子帐户

n  接口地址：/subAccount/rechargeSubaccount.do

n  请求方式：get\post

n  请求参数及返回值说明：

每次充值需要传入唯一的flowNo

	参数名	类型	是否必须	说明
输入参数	userId	int	Y	用户id
	count	long	Y	充值房卡
	accountFlag	String	Y	账户标示
	flowNo	String	Y	对账用唯一流水号
	trackCode	String	N	订单来源trackCode
传入json示例	{" userId ":14," count ":1440, "flowNo":"201711302384233"," trackCode ":"track123456"}
输出参数	availableCount	long	Y	累计可用余额
异常信息	code	String	Y	附加错误代码 00：充值成功 01余额不足 1：参数不完整 5： app没分配密钥6： 验签失败9999系统异常
	msg	String	Y	错误提示
JSON返 回值示例	{" availableCount ":1000}

 

 

2.2 查询房卡子帐户余额

n  接口地址：/subAccount/getItemBalance.do

n  请求方式：get\post

n  请求参数及返回值说明：

	参数名	类型	是否必须	说明
输入参数	userId	int	Y	用户id
	accountFlag	String	Y	账户标示
传入json示例	{ "userId":14}
输出参数	availableCount	long	Y	累计可用余额
异常信息	code	String	Y	附加错误代码 00：查询成功1：参数不完整 5： app没分配密钥6： 验签失败9999系统异常
	msg	String	Y	错误提示
JSON返 回值示例	{“ availableCount “：1000}

 

 

 

 

 

 

2.3 冻结子账户房卡

接口名：/subAccount/freezeBalance.do

功能：

说明：扣减账户余额（冻结）

参数

	参数名	类型	是否必须	说明
输入参数	userId	int	Y	用户id
	count	long	Y	冻结房卡
	accountFlag	String	Y	账户标示
	gameId	int	Y	游戏id
	flowNo	String	Y	对账用唯一流水号
	trackCode	String	N	订单来源trackCode
传入json示例	{" userId ":14," count ":1440, "flowNo":"201711302384233"," trackCode ":"track123456"}
异常信息	code	String	Y	附加错误代码 00：冻结成功 01余额不足 1：参数不完整 5： app没分配密钥6： 验签失败9999系统异常
异常信息 JSON返 回值示例	msg	String	Y	错误提示
	{}

 

 

 

 

2.4 解冻子账户房卡（回滚）

接口名：/subAccount/unfreezeBalance.do

功能：

说明：解冻冻结余额

参数

	参数名	类型	是否必须	说明
输入参数	userId	int	Y	用户id
	flowNo	String	Y	冻结订单流水号
传入json示例	{" userId ":14," count ":1440, "flowNo":"201711302384233"}
异常信息	code	String	Y	附加错误代码 00：解冻成功 01订单编号不存在 1：参数不完整 5： app没分配密钥6： 验签失败9999系统异常
异常信息 JSON返 回值示例	msg	String	Y	错误提示
	{}

 

 

 

 

 

2.5 确认冻结子账户房卡（扣减）

接口名：/subAccount/confirmFreeze.do

功能：

说明：扣减冻结余额

参数：超过30天未完成订单，则跑批完成扣减

	参数名	类型	是否必须	说明
输入参数	userId	int	Y	用户id
	flowNo	String	Y	冻结订单流水号
传入json示例	{" userId ":14," count ":1440, "flowNo":"201711302384233"," trackCode ":"track123456"}
异常信息	code	String	Y	附加错误代码 00：扣减成功 01订单编号不存在 1：参数不完整 5： app没分配密钥6： 验签失败9999系统异常
异常信息 JSON返 回值示例	msg	String	Y	错误提示
	{}

 

 

 

 

 

2.6 子账户帐户余额返回到房卡账户

n  接口地址：/subAccount/transferToItem.do

n  请求方式：get\post

n  请求参数及返回值说明：

每次充值需要传入唯一的flowNo

已过期子账户房卡不返回

	参数名	类型	是否必须	说明
输入参数	userId	int	Y	用户id
	flowNo	String	Y	对账用唯一流水号
	accountFlag	String	Y	账户标示
	trackCode	String	N	订单来源trackCode
传入json示例	{" userId ":14," "flowNo":"201711302384233"," trackCode ":"track123456"}
异常信息	code	String	Y	附加错误代码 00：返还成功 01余额不足 02 有冻结中订单不能收获 1：参数不完整 5： app没分配密钥6： 验签失败9999系统异常
	msg	String	Y	错误提示