天宏一卡通支付接口说明文档V1.0.2

1引言

1.1 编写目的

文档历史

修订日期修订内容修订版本修订人2010-7-1 创建 1.0.1 lvzhe 2010-7-14 修改支付金额为可选参数。 1.0.2 lvzhe 本文档说明了如何通过网关系统和天宏公司一卡通游戏充值系统进行对接。

2协议概述

2.1 协议列表

协议名称说明销售协议充值一卡通的协议

2.2 协议的交互逻辑

华彤商家

销售请求

销售结果

3销售协议

3.1 协议说明

协议采用HTTP协议，经销商将请求报文post或get到天宏的一卡通充值的80端口：

正式地址：

支付地址：/gateway/ECard_PayGate.do

单笔查询地址：/gateway/ECard_QueryGate_Single.do

批量查询地址：/gateway/ECard_QueryGate.do

url示例：

/gateway/ECard_PayGate.do?username=***&productid=***&cknum=***&kahao1=*** &mima1=*** &buynum=*** &orderNum=***&addition=***&returnUrl=*** &md5toself=***

/gateway/ECard_QueryGate_Single.do?userName=***&orderNum=***&md5toself=***

/gateway/ECard_QueryGate.do?userName=***&productID=***&eCardNum=*** &buyNum=***&orderNum=***&startDate=***&endDate=***&ip=***&pageCount=***&pageIndex=***& md5toself=***

测试地址：

支付地址：http://222.222.59.248/ECardPay/gateway /ECard_PayGate.do

单笔查询地址：http://222.222.59.248/ECardPay/gateway / ECard_QueryGate_Single.do

批量查询地址：http://222.222.59.248/ECardPay/gateway / ECard_QueryGate.do

3.1.1支付接口调用说明

支付接口参数说明：

输入参数数据类型说明是否必填

username varchar(20) 商户名Y

productid Int 产品类型，请和公司申请Y

cknum Int 一卡通张数Y

kahao1 mima1 kahao2 mima2

*

*

* varchar(50) 一卡通卡号密码

（最多支持5张一卡通组合充值支付）

Y

buynum Int 购买数量（按元计算，1=1元）

orderNum varchar(50) 商户订单号Y addition varchar(50) 附加信息

returnUrl varchar(200) 回调地址

md5toself Int 数字签名Y

调用说明：

1.所有字段中不能包含“&”和“=”

ername：商户名，例如huatong

3.productid：表示产品类型，真实产品ID请和天宏公司索要。

4.cknum：本次充值所提交的一卡通数量，请注意和kahao、mima字段要保持一致。

5.kahao\mima：所提交的一卡通卡号密码，形式为kahao1、kahao2…….mima1、mima2……，，其中

密码为MD5(32位)加密后的结果卡号密码提交前请务必请转换成大写。

6.buynum：充值数量表示充值1面值卡的张数，取值范围[1, 500]。可选参数，不传时默认全额支

付（支付所传一卡通的所有余额）。

7.orderNum: 商户订单号

8.addition: 附加信息

9.returnUrl: 回调地址，用于异步调用时的回调。

10.md5toself为按顺序对交易信息的MD5加密签名的32位字符串：

md5toself =md5(username=***&productid=***&cknum=***&kahao1=***&mima1=*** &buynum=*** &orderNum=***&addition=***&returnUrl=*** ||enc_key) 。

●可选参数如果不传的话，不能包含在加密串中。

●其中enc_key为双方约定的key,用于验证交易的合法性，请和天宏公司申请。

3.1.2支付接口返回结果说明

返回结果是xml格式数据字符串

1

成功！

10

充值结果代码结果说明

0 未知异常

1 成功

-1 参数验证异常

-2 一卡通验证异常

-3 账户验证异常

-4 支付类型验证异常

-5 订单验证异常

-6 支付操作异常

3.1.3查询接口调用说明

1.单笔查询接口参数说明：

输入参数数据类型说明默认值是否必填userName varchar(20) 商户名Y

orderNum varchar(50) 商户订单号Y

md5toself Int 数字签名Y

调用说明：

1.所有字段中不能包含“&”和“=”

erName：商户名，例如huatong

3.orderNum: 商户订单号

4.md5toself为按顺序对交易信息的MD5加密签名的32位字符串：

md5toself =md5(userName=***&orderNum=***||enc_key) 。

其中enc_key为双方约定的key,用于验证交易的合法性，请和天宏公司申请。

2.批量查询接口参数说明：

输入参数数据类型说明默认值是否必填userName varchar(20) 商户名Y

productID Int 产品类型，请和公司申请0

eCardNum varchar(50) 一卡通卡号

buyNum Int 购买数量（按元计算，1=1元）0

orderNum varchar(50) 商户订单号

startDate varchar(50) 开始时间

endDate varchar(50) 截止时间

ip varchar(50) 支付ip地址

pageCount int 每页数量100(暂定)

pageIndex int 页码 1

md5toself Int 数字签名Y

调用说明：

5.所有字段中不能包含“&”和“=”

erName：商户名，例如huatong

7.productID：表示产品类型，真实产品ID请和天宏公司索要。

8.eCardNum：所提交的一卡通卡号。

9.buyNum：充值数量表示充值1面值卡的张数，取值范围[1, 500]

10.orderNum: 商户订单号