source/_posts/一卡通v5系统应用接口文档.md

title: 一卡通v5系统应用接口文档 date: 2016-08-05 09:52:33 tags:

版本	日期	说明
1.0	2016-8-5	初始版本

1.1 文档说明

本文档用于描述了一卡通对第三方应用提供的通用支付api接口文档，供第三方系统（前置和应用）对接参考。

1.2 约定

传输编码统一为utf-8 2.RSA 加密算法为本接口采用的非对称加密算法，SIGN_ALGORITHMS ="SHA1WithRSA"; 3.RSA公钥由本系统提供，本系统返回信息的签名数据，第三方系统得到后通过公钥校验算法，验证返回数据的合法性 4.HMAC加密算法为用户请求本系统采用的加密算法，SIGN_ALGORITHMS ="HMAC-SHA1"; 5.具体签名生成参考后面的签名章节 6.retcode 等于0表示成功，非0表示失败，失败具体信息查看 retmsg 7.密码加密的原始串为 timestamp:pwd

2.1 充值操作员签到

请求URL:

https://ip:port/epay/api/pos_deposit/login

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
cardphyid	String	是	操作员授权卡物理卡号
cardpwd	String	是	操作员密码， MD5串
deviceid	Integer	否	充值POS机设备ID
devphyid	String	否	充值POS机物理ID，devphyid 和 deviceid 二选一
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/pos_deposit/login

partner_id:10000
stuempno:48BC2188
oper_pswd:e10adc3949ba59abbe56e057f20f883e
devphyid:10000001
timestamp:20150119130901
sign:5195f9b9116e4adf67eeebc9935d33dc683f677d
sign_method:HMAC

返回示例:

成功

{
	"retcode":"0",
	"retmsg":"签到成功",
	"termid":123,
	"termseqno":58,
    "checknum":123454,
    "cardno":456,
	"opername":"张三",
	"operid":45,
	"authcode": 64551,
	"batchno": 4757,
	"hostdate": "20160803",
	"hosttime": "154311",
	"mainkey": "434582727485",
	"timestamp":"20160606150902",
	"sign":"hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method": "RSA"
}

失败

{
	"retcode":"1",
	"retmsg":"操作员密码错误",
	"timestamp":"20160606150902",
	"sign": "hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method":"RSA"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
termid	Integer	终端ID
termseqno	Integer	终端流水号
checknum	Integer	校验码
cardno	Integer	卡号
opername	String	操作员名称
operid	Integer	操作员ID
authcode	Integer	授权号
batchno	Integer	批次号
hostdate	String	主机日期
hosttime	String	主机时间
mainkey	String	M1卡密钥（暂时为空）

2.2 操作员充值接口

请求URL:

https://ip:port/epay/api/pos_deposit/deposit

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
cardno	Integer	是	交易卡号
cardphyid	String	是	物理卡号
dpscnt	Integer	是	充值前次数
paycnt	Integer	是	消费前次数
cardbefbal	Integer	是	充值前卡余额
amount	Integer	是	充值金额
dpsamt	Integer	是	实际写卡金额
fundtype	Integer	是	资金类型：1-现金；2-支票；3-经费本
samno	String	是	SAM终端号
random_num	String	是	随机数
mac1	String	是	MAC1
operid	Integer	是	操作员ID
authcode	Integer	是	授权号
batchno	Integer	是	批次号
deviceid	Integer	是	终端ID，操作员签到返回的termid
devseqno	Integer	是	终端流水号
refno	String	否	交易参考号，重发请求时上传
reqflag	String	是	请求标志，重发请求时 'Q'
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/pos_deposit/oper_login

返回示例:

成功

{
	"retcode":"0",
	"retmsg":"签到成功",
	"termid":123,
	"termseqno":58,
    "checknum":123454,
    "cardno":456,
	"opername":"张三",
	"operid":45,
	"authcode": 64551,
	"batchno": 4757,
	"hostdate": "20160803",
	"hosttime": "154311",
	"mainkey": "434582727485",
	"timestamp":"20160606150902",
	"sign":"hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method": "RSA"
}

失败

{
	"retcode":"1",
	"retmsg":"操作员密码错误",
	"timestamp":"20160606150902",
	"sign": "hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method":"RSA"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
termid	Integer	终端ID
cardno	Integer	卡号
refno	String	交易参考号
hostdate	String	主机日期
hosttime	String	主机时间
mac2	String	MAC2

2.3 操作员充值确认接口

请求URL:

https://ip:port/epay/api/pos_deposit/confirm

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
refno	String	是	交易参考号
isok	Integer	是	是否成功 1: 成功，其他失败
isbreak	Integer	是	是否是中途拔卡 0-不是，1-是
tac	String	是	TAC
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/pos_deposit/oper_login

返回示例:

成功

{
	"retcode":"0",
	"retmsg":"签到成功",
	"termid":123,
	"termseqno":58,
    "checknum":123454,
    "cardno":456,
	"opername":"张三",
	"operid":45,
	"authcode": 64551,
	"batchno": 4757,
	"hostdate": "20160803",
	"hosttime": "154311",
	"mainkey": "434582727485",
	"timestamp":"20160606150902",
	"sign":"hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method": "RSA"
}

失败

{
	"retcode":"1",
	"retmsg":"操作员密码错误",
	"timestamp":"20160606150902",
	"sign": "hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method":"RSA"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
termid	Integer	终端ID
nextTermseqno	Integer	下一笔终端流水号
refno	String	交易参考号

2.4 B模式卡消费初始化

请求URL:

https://ip:port/epay/api/bmode_pay/init_for_pay

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
cardno	Integer	是	交易卡号
paycnt	Integer	是	消费前次数
cardbefbal	Integer	是	卡消费前余额
amount	Integer	是	消费金额
termid	Integer	是	终端号
termseqno	Integer	是	终端流水号
termdate	String	是	终端日期
termtime	String	是	终端时间
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/bmode_pay/init_for_pay

返回示例:

成功

{
	"retcode":"0",
	"retmsg":"签到成功",
	"termid":123,
	"termseqno":58,
    "checknum":123454,
    "cardno":456,
	"opername":"张三",
	"operid":45,
	"authcode": 64551,
	"batchno": 4757,
	"hostdate": "20160803",
	"hosttime": "154311",
	"mainkey": "434582727485",
	"timestamp":"20160606150902",
	"sign":"hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method": "RSA"
}

失败

{
	"retcode":"1",
	"retmsg":"操作员密码错误",
	"timestamp":"20160606150902",
	"sign": "hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method":"RSA"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
termid	Integer	终端ID
cardno	Integer	交易卡号
refno	String	交易参考号
payamt	Integer	实际消费金额（分）
otheramt	Integer	其它金额（分）
otheramt_desc	String	说明
sign	String	签名
sign_method	String	是

2.5 B模式卡消费确认

请求URL:

https://ip:port/epay/api/bmode_pay/credit_for_pay

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
refno	String	是	交易参考号
isok	Integer	是	是否消费成功
tac	String	是	TAC
samno	String	是	SAM卡号
samseqno	Integer	是	SAM卡流水号
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/bmode_pay/init_for_pay

返回示例:

成功

{
	"retcode":"0",
	"retmsg":"签到成功",
	"termid":123,
	"termseqno":58,
    "checknum":123454,
    "cardno":456,
	"opername":"张三",
	"operid":45,
	"authcode": 64551,
	"batchno": 4757,
	"hostdate": "20160803",
	"hosttime": "154311",
	"mainkey": "434582727485",
	"timestamp":"20160606150902",
	"sign":"hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method": "RSA"
}

失败

{
	"retcode":"1",
	"retmsg":"操作员密码错误",
	"timestamp":"20160606150902",
	"sign": "hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method":"RSA"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
refno	String	交易参考号
sign	String	签名
sign_method	String	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

2.6 挂失接口

请求URL:

https://ip:port/epay/api/cardmanage/cardloss

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
cardno	Integer	否	交易卡号
stuempno	String	否	学工号，与交易卡号二选一
needcardpwd	Boolean	是	是否校验卡密码
cardpwd	String	否	卡密码，MD5加密
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/cardmanage/cardloss

app_id:10001
cardno:123
sign:1231231234
sign_method:HMAC

返回示例:

成功

{
	"retcode":"0",
	"retmsg":"签到成功",
	"termid":123,
	"termseqno":58,
    "checknum":123454,
    "cardno":456,
	"opername":"张三",
	"operid":45,
	"authcode": 64551,
	"batchno": 4757,
	"hostdate": "20160803",
	"hosttime": "154311",
	"mainkey": "434582727485",
	"timestamp":"20160606150902",
	"sign":"hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method": "RSA"
}

失败

{
	"retcode":"1",
	"retmsg":"操作员密码错误",
	"timestamp":"20160606150902",
	"sign": "hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method":"RSA"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
refno	String	交易参考号
sign	String	签名
sign_method	String	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

2.7 解挂接口

请求URL:

https://ip:port/epay/api/cardmanage/cardunloss

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
cardno	Integer	否	交易卡号
stuempno	String	否	学工号，与交易卡号二选一
needcardpwd	Boolean	是	是否校验卡密码
cardpwd	String	否	卡密码，MD5加密
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/cardmanage/cardloss

app_id:10001
cardno:123
sign:1231231234
sign_method:HMAC

返回示例:

成功

{
	"retcode":"0",
	"retmsg":"签到成功",
	"termid":123,
	"termseqno":58,
    "checknum":123454,
    "cardno":456,
	"opername":"张三",
	"operid":45,
	"authcode": 64551,
	"batchno": 4757,
	"hostdate": "20160803",
	"hosttime": "154311",
	"mainkey": "434582727485",
	"timestamp":"20160606150902",
	"sign":"hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method": "RSA"
}

失败

{
	"retcode":"1",
	"retmsg":"操作员密码错误",
	"timestamp":"20160606150902",
	"sign": "hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method":"RSA"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
refno	String	交易参考号
sign	String	签名
sign_method	String	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

2.8 卡基本信息更新、修改卡有效期

请求URL:

https://ip:port/epay/api/cardmanage/updatecardinfo

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
cardno	Integer	是	交易卡号
cardphyid	String	是	物理卡号
paycnt	Integer	是	卡消费次数
dpscnt	Integer	是	卡充值次数
expiredate	String	是	卡有效期，yyyyMMdd
reqflag	String	是	“1”-卡基本信息更新；“2”-修改卡有效期;
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/cardmanage/updatecardinfo

app_id:10001
cardno:123
sign:1231231234
sign_method:HMAC

返回示例:

成功

{
	"retcode":"0",
	"retmsg":"签到成功",
	"termid":123,
	"termseqno":58,
    "checknum":123454,
    "cardno":456,
	"opername":"张三",
	"operid":45,
	"authcode": 64551,
	"batchno": 4757,
	"hostdate": "20160803",
	"hosttime": "154311",
	"mainkey": "434582727485",
	"timestamp":"20160606150902",
	"sign":"hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method": "RSA"
}

失败

{
	"retcode":"1",
	"retmsg":"操作员密码错误",
	"timestamp":"20160606150902",
	"sign": "hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method":"RSA"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
data	String	写卡数据，成功时返回
sign	String	签名
sign_method	String	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

2.9 修改卡单次消费限额和日累计消费限额

请求URL:

https://ip:port/epay/api/cardmanage/updatecardlimit

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
cardno	Integer	是	交易卡号
cardphyid	String	是	物理卡号
singlemaxamt	Integer	是	单次消费限额。金额（分）
daymaxamt	Integer	是	日累计消费限额。金额（分）
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/cardmanage/updatecardlimit

app_id:10001
cardno:123
sign:1231231234
sign_method:HMAC

返回示例:

成功

{
	"retcode":"0",
	"retmsg":"签到成功",
	"termid":123,
	"termseqno":58,
    "checknum":123454,
    "cardno":456,
	"opername":"张三",
	"operid":45,
	"authcode": 64551,
	"batchno": 4757,
	"hostdate": "20160803",
	"hosttime": "154311",
	"mainkey": "434582727485",
	"timestamp":"20160606150902",
	"sign":"hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method": "RSA"
}

失败

{
	"retcode":"1",
	"retmsg":"操作员密码错误",
	"timestamp":"20160606150902",
	"sign": "hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method":"RSA"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
data	String	写卡数据，成功时返回
sign	String	签名
sign_method	String	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

3.0 修改卡密码

请求URL:

https://ip:port/epay/api/cardmanage/cardpwdreset

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
cardno	Integer	是	交易卡号
oldcardpwd	String	是	旧密码
newcardpwd	String	是	新密码
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/cardmanage/cardpwdreset

app_id:10001
cardno:123
sign:1231231234
sign_method:HMAC

返回示例:

成功

{
	"retcode":"0",
	"retmsg":"签到成功",
	"termid":123,
	"termseqno":58,
    "checknum":123454,
    "cardno":456,
	"opername":"张三",
	"operid":45,
	"authcode": 64551,
	"batchno": 4757,
	"hostdate": "20160803",
	"hosttime": "154311",
	"mainkey": "434582727485",
	"timestamp":"20160606150902",
	"sign":"hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method": "RSA"
}

失败

{
	"retcode":"1",
	"retmsg":"操作员密码错误",
	"timestamp":"20160606150902",
	"sign": "hjAtBGygGjFyOKEZmWdxi1tk51/xqLYTr5tm2+zQVfD1RHRzGVC9GNm4ZaXnUsHnu5o3kAZ4U32m0YNiSFpncs0pl1AnnCf1n2hhn39ruABsvD//GzkEINHjyHsnxBr44G2UhyNxplUj+s7s0a7ggjbiMk+BYC3u7VkU9/l+kZOTkEyqs+wZKumfByMZGvKVkY2c2Nr67RaSWd7bsfOJ6HYw2spvu3ptAo2RTrfCxZ0Kn5DcSDm4cagzPMZSHxB8isqqNGrdUaAU0wzzC7704iA5zze//SvCqpCJfYt0OrHOiJEN5kw1d4KESrKGMG6bezlXzAp0LbNlhl+HwZJcag==",
    "sign_method":"RSA"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
newcardpwd	String	新密码，成功时返回
sign	String	签名
sign_method	String	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

4.0 在线支付交易-读卡器签到

请求URL:

https://ip:port/epay/api/onlinepay/cardreaderlogin

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
termno	String	是	PSAM卡终端编号
term_id	Integer	是	读卡器设备编号
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/cardmanage/cardpwdresetapp_id:10001cardno:123sign:1231231234sign_method:HMAC

返回示例:

成功

{

    }

失败

{

}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
mfkey	String	读卡密钥
termid	integer	终端号
termseqno	integer	终端流水号
checknum	integer	验证码
singlemaxamt	Integer	单次消费限额
daymaxamt	Integer	日累计消费限额
limited	Integer	是否限制
shopid	Integer	商户号
shopname	String	商户名称
sign	String	签名
签名	String	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

4.1 在线支付交易-读卡器支付请求##

请求URL:

https://ip:port/epay/api/onlinepay/cardreaderpayinit

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
termno	String	是	PSAM卡终端编号
term_id	Integer	是	读卡器设备编号
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1
checknum	integer	验证码	签到返回的验证码
shopid	Integer	是	商户号
cardno	Integer	是	卡号
cardphyid	string	是	卡物理ID
dpscnt	Integer	是	充值次数
paycnt	Integer	是	消费次数
cardbefbal	Integer	是	卡交易前余额
amount	Integer	是	消费金额

请求内容示例:

URI：https://ip:port/epay/api/cardmanage/cardpwdresetapp_id:10001cardno:123sign:1231231234sign_method:HMAC

返回示例:

成功

{

    }

失败

{

}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
termid	integer	终端号
refno	integer	交易参考号
cardno	integer	卡号
amount	integer	消费金额
sign	String	签名
sign_method	String	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

4.3 在线支付交易-读卡器支付确认##

请求URL:

https://ip:port/epay/api/onlinepay/cardreaderpayconfirm

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	必选	说明
app_id	String	是	本系统分配给各个接入应用的合作伙伴id号
term_id	Integer	是	读卡器设备编号
refno	String	是	交易参考号
isok	String	是	写卡是否成功
isbreak	String	是	是否中途拔卡
tac	String	否	写卡tac码
sign	String	是	签名
sign_method	String	是	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI：https://ip:port/epay/api/cardmanage/cardpwdresetapp_id:10001cardno:123sign:1231231234sign_method:HMAC

返回示例:

成功

{

    }

失败

{

}

返回参数说明:

参数名	类型	说明
retcode	String	返回码（0=成功，其他为失败）
retmsg	String	返回消息
refno	String	交易参考号
sign	String	签名
签名	String	参数的加密方法选择，可选值是：HMAC 加密方式为HAMC-SHA1

#5 生活缴费接口#

5.0 生活缴费查询系统区域级别

请求URL:

https://ip:port/epayapi/services/lifebill/thirdparty/querylocationlevel

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

无

请求内容示例:

URI：https://ip:port/epayapi/services/lifebill/thirdparty/querylocationlevel

返回示例:

成功

[
  {
    "levelnum": 0,
    "name": "校区"
  },
  {
    "levelnum": 1,
    "name": "楼栋"
  },
  {
    "levelnum": 2,
    "name": "单元"
  },
  {
    "levelnum": 3,
    "name": "房间"
  }
]

失败

null 或者 []

返回参数说明:

参数名	类型	说明
levelnum	Integer	级别
name	String	名称

5.1 生活缴费查询房间

请求URL:

https://ip:port/epayapi/services/lifebill/thirdparty/querylocation

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	说明
levelnum	Integer	级别，非空
pid	String	父级ID

请求内容示例:

URI：https://ip:port/epayapi/services/lifebill/thirdparty/querylocation

返回示例:

成功

levelnum=0，pid=null 返回：
[
  {
    "id": "1",
    "code": "1",
    "name": "呈贡校区",
    "pid": null,
    "levelnum": 0
  }
]

或 levelnum=1，pid=“1” 返回：
[
  {
    "id": "2",
    "code": "2",
    "name": "楠苑五栋",
    "pid": "1",
    "levelnum": 1
  },
  {
    "id": "3",
    "code": "3",
    "name": "楠苑三栋",
    "pid": "1",
    "levelnum": 1
  }
]

失败

null 或者 []

返回参数说明:

参数名	类型	说明
id	String	位置ID
code	String	位置代码
name	String	名称
pid	String	父级ID
levelnum	Integer	级别

5.2 生活缴费查询房间账单

请求URL:

https://ip:port/epayapi/services/lifebill/thirdparty/querybills

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	说明
locationid	String	房间ID

请求内容示例:

URI：https://ip:port/epayapi/services/lifebill/thirdparty/querybills

返回示例:

成功

[
  {
    "billid": "8a53b78257bcee0a0157bd1f67d20032",
    "billname": "9月份水费",
    "itemno": "8a53b78257bcee0a0157bd1f67b3002f",
    "locationid": "7",
    "locationfullname": "呈贡校区/楠苑五栋/B区/339",
    "shopid": 4,
    "shopname": "电控商户",
    "startdate": "20161013",
    "amount": 10
  },
  {
    "billid": "8a53b78257bcee0a0157bd13afaa0020",
    "billname": "测试电费",
    "itemno": "8a53b78257bcee0a0157bd13af7b001d",
    "locationid": "7",
    "locationfullname": "呈贡校区/楠苑五栋/B区/339",
    "shopid": 6,
    "shopname": "水控商户",
    "startdate": "20161013",
    "amount": 10
  },
  {
    "billid": "8a53b78257bcee0a0157bd20c5ba0038",
    "billname": "测试水费",
    "itemno": "8a53b78257bcee0a0157bd20c59a0035",
    "locationid": "7",
    "locationfullname": "呈贡校区/楠苑五栋/B区/339",
    "shopid": 4,
    "shopname": "电控商户",
    "startdate": "20161013",
    "amount": 10
  }
]

失败

null 或者 []

返回参数说明:

参数名	类型	说明
billid	String	账单ID
billname	String	名称
itemno	String	账单项目号
locationid	String	房间ID
locationfullname	String	房间名称
shopid	Integer	收费商户ID
shopname	String	收费商户名称
startdate	String	开始日期
amount	Double	账单金额

5.3 生活缴费账单缴费初始化（APP）

请求URL:

https://ip:port/epayapi/services/lifebill/paylifebillinit

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	说明
billid	String	账单ID
gid	Integer	app个人的gid

请求内容示例:

URI：https://ip:port/epayapi/services/lifebill/paylifebillinit

返回示例:

成功

{
    "retcode": "0",
    "retmsg": "初始化成功",
    "billno": "8a53b78257bcee0a0157bd20c5ba0038"
}

失败

{
    "retcode": "2",
    "retmsg": "账单已付款"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码，0-成功，其他失败
retmsg	String	返回信息
billno	String	成功时返回流水号

5.4 生活缴费账单缴费确认（多媒体）

请求URL:

https://ip:port/epayapi/services/lifebill/dmt/lifebillconfirm

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	说明
termid	String	设备终端号
devphyid	String	设备物理ID（与termid 二选一）
billid	String	账单ID
amount	Integer	账单金额（分）
refno	String	付款流水号
cardno	Integer	付款卡号
app_id	String	应用ID
term_id	String	设备终端号或物理ID
timestamp	String	时间戳 ‘yyyyMMddHHmmss’
sign	String	签名
sign_method	String	签名方法

请求内容示例:

URI：https://ip:port/epayapi/services/lifebill/dmt/lifebillconfirm

devphyid:10000001
billid:8a53b78257bcee0a0157bd13afaa0020
amount:1000
refno:20161019180731005169
cardno:4
app_id:1000011
term_id: 10000001
timestamp:20150119130901
sign:5195f9b9116e4adf67eeebc9935d33dc683f677d
sign_method:HMAC

返回示例:

成功

{
    "retcode": "0",
    "retmsg": "成功"
}

失败

{
    "retcode": "99",
    "retmsg": "缴费流水已被冲正"
}

返回参数说明:

参数名	类型	说明
retcode	String	返回码，0-成功，其他失败
retmsg	String	返回信息

#6 自助补卡接口

6.0 初始化

请求URL:

https://ip:port/epayapi/services/consume/zzsb/init

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	说明
idno	String	证件号
transname	String	'补办' 或 'NETCARDRENEW' 二选一。('NETCARDRENEW'表费用从账户里扣，会判断余额是否足够)
version	String	'v5'（固定），不参与签名
app_id	String	应用ID
term_id	String	设备终端号或物理ID
timestamp	String	时间戳 ‘yyyyMMddHHmmss’
sign	String	签名
sign_method	String	签名方法

返回参数说明:

参数名	类型	说明
oldcardno	Integer	老卡号
feeamt	Integer	补办费用（金额：分）
expiredate	String	卡有效期
stuempno	String	学工号
custname	String	姓名
feetype	Integer	收费类别
custtype	Integer	客户类别
custtypename	String	客户类别名称
dept	String	部门名称
classname	String	班级名称

返回示例:

成功

{
    "retcode": "0",
    "retmsg": "成功",
    “oldcardno”:"43",
    "feeamt":2000,
    ...
}

失败

{
    "retcode": "99",
    "retmsg": "缴费流水已被冲正"
}

6.1 补办请求

请求URL:

https://ip:port/epayapi/services/consume/zzsb/renewcard

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	说明
operid	String	操作员ID
opercode	String	操作员代码（与operid二选一）
termid	String	终端ID
devphyid	String	终端物理ID （与termid二选一）
oldcardno	String	老卡号
newcardphyid	String	新卡物理ID
cardphytypecode	String	新卡物理类型
showcardno	String	新卡显示卡号
transname	String	’补办‘ 或 ’NETCARDRENEW‘
fundtype	String	基金类型 1-现金；2-支票；3-经费本；6-费用从账户扣
feeamt	Integer	补办费用（金额：分）
version	String	'v5'（固定），不参与签名
app_id	String	应用ID
term_id	String	设备终端号或物理ID
timestamp	String	时间戳 ‘yyyyMMddHHmmss’
sign	String	签名
sign_method	String	签名方法

返回参数说明:

参数名	类型	说明
accdate	String	记账日期
refno	String	参考号
feeamt	Integer	补办费用
hostdate	String	主机日期
hosttime	String	主机时间
feetype	Integer	收费类别
expiredate	String	卡有效期
cardno	Integer	卡号
cardtype	Integer	卡类型
dept	String	部门名称
classname	String	班级名称
showcardno	String	显示卡号
cardverno	String	卡版本号
cardpwd	String	卡密码
country	String	国籍
nation	String	民族
areacode	String	区域
deptcode	String	部门
custtype	String	客户类别
custname	String	姓名
stuempno	String	学工号
idtype	String	证件类型
idno	String	证件号
sex	String	性别
singlemaxamt	Integer	单次消费限额（金额：分）
daymaxamt	Integer	日累计消费限额（金额：分）
cardmode	String	卡消费模式

返回示例:

成功

{
    "retcode": "0",
    "retmsg": "成功",
    “refno”:"201611112321140000234",
    "feeamt":2000,
    ...
}

失败

{
    "retcode": "99",
    "retmsg": "缴费流水已被冲正"
}

6.2 补办确认

请求URL:

https://ip:port/epayapi/services/consume/zzsb/renewcardconfirm

请求方式/格式:

POST
application/x-www-form-urlencoded

请求参数:

参数名	类型	说明
operid	String	操作员ID
opercode	String	操作员代码（与operid二选一）
termid	String	终端ID
devphyid	String	终端物理ID （与termid二选一）
refno	String	参考号
isok	Boolean	写卡成功标志
cardno	String	新卡卡号
amount	Integer	充值金额（金额：分）
version	String	'v5'（固定），不参与签名
app_id	String	应用ID
term_id	String	设备终端号或物理ID
timestamp	String	时间戳 ‘yyyyMMddHHmmss’
sign	String	签名
sign_method	String	签名方法

返回参数说明:

参数名	类型	说明
nextoperseqno	String	下笔操作员流水号
nexttermseqno	String	下笔终端流水号
dpsflag	Boolean	充值成功标志
dpsmsg	String	充值返回信息
dpsrefno	String	充值流水参考号
dpsamt	Integer	实际充值金额（分）
dpsfeeamt	Integer	充值收手续费金额（分）

返回示例:

成功

{
    "retcode": "0",
    "retmsg": "成功",
    “refno”:"201611112321140000234",
    "feeamt":2000,
    ...
}

失败

{
    "retcode": "99",
    "retmsg": "缴费流水已被冲正"
}