title: 一卡通v5第三方数据对接接口文档 date: 2016-06-21 13:54:26 tags:


1.1文档说明

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

1.2约定

  1. 传输编码统一为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/epayapi/services/thirdparty/common/single/custcardinfo

请求方式/格式:

  • POST
  • application/x-www-form-urlencoded

请求参数:

参数名类型必选说明
partner_idString是      本系统分配给各个接入应用的合作伙伴id号
stuempnoString查询对象的学号
timestampString时间戳格式为yyyyMMddhh24miss
signString签名
sign_methodString参数的加密方法选择,可选值是:HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI:https://ip:port/epayapi/services/thirdparty/common/single/custcardinfo

partner_id:10000
stuempno:09893092
timestamp:20150119130901
sign:5195f9b9116e4adf67eeebc9935d33dc683f677d
sign_method:HMAC

返回示例:

  • 成功
{
    "retcode": "0",
    "retmsg": "查询成功",
    "data": [
        {
            "stuempno": "2012135138",
            "custname": "徐晨",
            "cardno": 900,
            "cardstatus": 1,
            "showcardno": "0000006271",
            "cardphyid": "540DB1E3",
            "expiredate": "20160801",
            "opendate": "20150901",
            "cardverno": "150901001789",
            "cardtype": 1,
            "cardtypename": "正式卡",
            "custid": 2001393,
            "custtype": 3,
            "custtypename": "学生",
            "deptcode": "1",
            "deptname": "上海**学院",
            "specialtycode": "0",
            "specialtyname": null,
            "sex": "1",
            "idtype": "1",
            "idtypename": "身份证",
            "idno": "310108199********3",
            "areacode": "2",
            "areaname": "浦东校区",
            "classcode": null,
            "countrycode": "0",
            "country": null,
            "email": null,
            "nationcode": "0",
            "nation": "汉族",
            "tel": null,
            "mobile": null,
            "zipcode": null,
            "cardupdtime": "20150901135222",
            "custupdtime": "20150901135222"
        }
    ]
}

  • 失败
{
	"retcode":"1",
	"retmsg":"账户不存在"
}

返回参数说明:

参数名类型说明
retcodeString返回码(0=成功,其他为失败)
retmsgString返回消息
stuempnoString学号
custnameString姓名
balanceInteger余额(分)
cardnoInteger卡号
statusString状态(正常)

2.2 通用卡、账户信息查询-批量接口

请求URL:

  • https://ip:port/epayapi/services/thirdparty/common/batch/custcardinfo

请求方式/格式:

  • POST
  • application/x-www-form-urlencoded

请求参数:

参数名类型必选说明
partner_idString是      本系统分配给各个接入应用的合作伙伴id号
pagenoString页码,默认1
pagesizeString每页行数,默认10,范围10-500
cardupdtimeString卡最后更新时间(二选一)
custupdtimeString客户最后更新时间(二选一)
timestampString时间戳格式为yyyyMMddhh24miss
signString签名
sign_methodString参数的加密方法选择,可选值是:HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI:https://ip:port/epayapi/services/thirdparty/common/batch/custcardinfo

partner_id:10000
pageno:1
pagesize:100
cardupdtime:20150829145802
timestamp:20150119130901
sign:5195f9b9116e4adf67eeebc9935d33dc683f677d
sign_method:HMAC

返回示例:

  • 成功
{
    "retcode": "0",
    "retmsg": "查询成功",
    "data": null,
    "page": {
        "totalCount": 10700,
        "pageSize": 10,
        "pageNo": 1,
        "list": [
            {
                "stuempno": "2012127213",
                "custname": "时妍婧",
                "cardno": 1767,
                "cardstatus": 1,
                "showcardno": "0000002103",
                "cardphyid": "540F38B3",
                "expiredate": "20160801",
                "opendate": "20150901",
                "cardverno": "150901003521",
                "cardtype": 1,
                "cardtypename": "正式卡",
                "custid": 2000907,
                "custtype": 3,
                "custtypename": "学生",
                "deptcode": "1",
                "deptname": "上海**学院",
                "specialtycode": "0",
                "specialtyname": null,
                "sex": "2",
                "idtype": "1",
                "idtypename": "身份证",
                "idno": "3702851*********",
                "areacode": "2",
                "areaname": "浦东校区",
                "classcode": null,
                "countrycode": "0",
                "country": null,
                "email": null,
                "nationcode": "0",
                "nation": "汉族",
                "tel": null,
                "mobile": null,
                "zipcode": null,
                "cardupdtime": "20150901143334",
                "custupdtime": "20150901143334"
            },
            {
                "stuempno": "2012145107",
                "custname": "汪珍霞",
                "cardno": 1779,
                "cardstatus": 1,
                "showcardno": "0000002340",
                "cardphyid": "54101943",
                "expiredate": "20160801",
                "opendate": "20150901",
                "cardverno": "150901003545",
                "cardtype": 1,
                "cardtypename": "正式卡",
                "custid": 2001795,
                "custtype": 3,
                "custtypename": "学生",
                "deptcode": "1",
                "deptname": "上海**学院",
                "specialtycode": "0",
                "specialtyname": null,
                "sex": "2",
                "idtype": "1",
                "idtypename": "身份证",
                "idno": "3702851*********",
                "areacode": "2",
                "areaname": "浦东校区",
                "classcode": null,
                "countrycode": "0",
                "country": null,
                "email": null,
                "nationcode": "0",
                "nation": "汉族",
                "tel": null,
                "mobile": null,
                "zipcode": null,
                "cardupdtime": "20150901143411",
                "custupdtime": "20150901143411"
            },
            {
                "stuempno": "2012127218",
                "custname": "高秋依",
                "cardno": 1781,
                "cardstatus": 1,
                "showcardno": "0000002098",
                "cardphyid": "540FA163",
                "expiredate": "20160801",
                "opendate": "20150901",
                "cardverno": "150901003550",
                "cardtype": 1,
                "cardtypename": "正式卡",
                "custid": 2000912,
                "custtype": 3,
                "custtypename": "学生",
                "deptcode": "1",
                "deptname": "上海**学院",
                "specialtycode": "0",
                "specialtyname": null,
                "sex": "2",
                "idtype": "1",
                "idtypename": "身份证",
                "idno": "3702851*********",
                "areacode": "2",
                "areaname": "浦东校区",
                "classcode": null,
                "countrycode": "0",
                "country": null,
                "email": null,
                "nationcode": "0",
                "nation": "汉族",
                "tel": null,
                "mobile": null,
                "zipcode": null,
                "cardupdtime": "20150901143419",
                "custupdtime": "20150901143419"
            },
            {
                "stuempno": "2012145110",
                "custname": "邱婷",
                "cardno": 1783,
                "cardstatus": 1,
                "showcardno": "0000002337",
                "cardphyid": "540C7BA3",
                "expiredate": "20160801",
                "opendate": "20150901",
                "cardverno": "150901003553",
                "cardtype": 1,
                "cardtypename": "正式卡",
                "custid": 2001798,
                "custtype": 3,
                "custtypename": "学生",
                "deptcode": "1",
                "deptname": "上海**学院",
                "specialtycode": "0",
                "specialtyname": null,
                "sex": "2",
                "idtype": "1",
                "idtypename": "身份证",
                "idno": "3702851*********",
                "areacode": "2",
                "areaname": "浦东校区",
                "classcode": null,
                "countrycode": "0",
                "country": null,
                "email": null,
                "nationcode": "0",
                "nation": "汉族",
                "tel": null,
                "mobile": null,
                "zipcode": null,
                "cardupdtime": "20150901143425",
                "custupdtime": "20150901143425"
            },
            {
                "stuempno": "2012145111",
                "custname": "汪逸馨",
                "cardno": 1785,
                "cardstatus": 1,
                "showcardno": "0000002336",
                "cardphyid": "540FDD33",
                "expiredate": "20160801",
                "opendate": "20150901",
                "cardverno": "150901003557",
                "cardtype": 1,
                "cardtypename": "正式卡",
                "custid": 2001799,
                "custtype": 3,
                "custtypename": "学生",
                "deptcode": "1",
                "deptname": "上海**学院",
                "specialtycode": "0",
                "specialtyname": null,
                "sex": "2",
                "idtype": "1",
                "idtypename": "身份证",
                "idno": "3702851*********",
                "areacode": "2",
                "areaname": "浦东校区",
                "classcode": null,
                "countrycode": "0",
                "country": null,
                "email": null,
                "nationcode": "0",
                "nation": "汉族",
                "tel": null,
                "mobile": null,
                "zipcode": null,
                "cardupdtime": "20150901143430",
                "custupdtime": "20150901143430"
            },
            {
                "stuempno": "0823",
                "custname": "殷林森",
                "cardno": 11267,
                "cardstatus": 1,
                "showcardno": "0000021032",
                "cardphyid": "540F8A03",
                "expiredate": "20990801",
                "opendate": "20151010",
                "cardverno": "151010000274",
                "cardtype": 1,
                "cardtypename": "正式卡",
                "custid": 2007087,
                "custtype": 2,
                "custtypename": "教工",
                "deptcode": "129",
                "deptname": "国际**学院",
                "specialtycode": "0",
                "specialtyname": null,
                "sex": "0",
                "idtype": "0",
                "idtypename": null,
                "idno": null,
                "areacode": "2",
                "areaname": "浦东校区",
                "classcode": null,
                "countrycode": "0",
                "country": null,
                "email": null,
                "nationcode": "0",
                "nation": null,
                "tel": null,
                "mobile": null,
                "zipcode": null,
                "cardupdtime": "20151010140928",
                "custupdtime": "20151010140928"
            },
            {
                "stuempno": "2012121242",
                "custname": "顾承阳",
                "cardno": 1586,
                "cardstatus": 1,
                "showcardno": "0000004005",
                "cardphyid": "540C6533",
                "expiredate": "20160801",
                "opendate": "20150901",
                "cardverno": "150901003160",
                "cardtype": 1,
                "cardtypename": "正式卡",
                "custid": 2000091,
                "custtype": 3,
                "custtypename": "学生",
                "deptcode": "1",
                "deptname": "上海**学院",
                "specialtycode": "0",
                "specialtyname": null,
                "sex": "1",
                "idtype": "1",
                "idtypename": "身份证",
                "idno": "3702851*********",
                "areacode": "2",
                "areaname": "浦东校区",
                "classcode": null,
                "countrycode": "0",
                "country": null,
                "email": null,
                "nationcode": "0",
                "nation": "汉族",
                "tel": null,
                "mobile": null,
                "zipcode": null,
                "cardupdtime": "20150901142422",
                "custupdtime": "20150901142422"
            },
            {
                "stuempno": "0920",
                "custname": "方磊",
                "cardno": 1592,
                "cardstatus": 1,
                "showcardno": "0000000168",
                "cardphyid": "540F7953",
                "expiredate": "20990801",
                "opendate": "20150901",
                "cardverno": "150901003172",
                "cardtype": 1,
                "cardtypename": "正式卡",
                "custid": 2007090,
                "custtype": 2,
                "custtypename": "教工",
                "deptcode": "129",
                "deptname": "国际**学院",
                "specialtycode": "0",
                "specialtyname": null,
                "sex": "0",
                "idtype": "0",
                "idtypename": null,
                "idno": null,
                "areacode": "2",
                "areaname": "浦东校区",
                "classcode": null,
                "countrycode": "0",
                "country": null,
                "email": null,
                "nationcode": "0",
                "nation": null,
                "tel": null,
                "mobile": null,
                "zipcode": null,
                "cardupdtime": "20150901142449",
                "custupdtime": "20150901142449"
            },
            {
                "stuempno": "2012127117",
                "custname": "施雨",
                "cardno": 1593,
                "cardstatus": 1,
                "showcardno": "0000002146",
                "cardphyid": "540CC9B3",
                "expiredate": "20160801",
                "opendate": "20150901",
                "cardverno": "150901003173",
                "cardtype": 1,
                "cardtypename": "正式卡",
                "custid": 2000864,
                "custtype": 3,
                "custtypename": "学生",
                "deptcode": "1",
                "deptname": "上海**学院",
                "specialtycode": "0",
                "specialtyname": null,
                "sex": "2",
                "idtype": "1",
                "idtypename": "身份证",
                "idno": "3702851*********",
                "areacode": "2",
                "areaname": "浦东校区",
                "classcode": null,
                "countrycode": "0",
                "country": null,
                "email": null,
                "nationcode": "0",
                "nation": "汉族",
                "tel": null,
                "mobile": null,
                "zipcode": null,
                "cardupdtime": "20150901142451",
                "custupdtime": "20150901142451"
            },
            {
                "stuempno": "2012127119",
                "custname": "朱时琳",
                "cardno": 1597,
                "cardstatus": 1,
                "showcardno": "0000002144",
                "cardphyid": "540CDDB3",
                "expiredate": "20160801",
                "opendate": "20150901",
                "cardverno": "150901003182",
                "cardtype": 1,
                "cardtypename": "正式卡",
                "custid": 2000866,
                "custtype": 3,
                "custtypename": "学生",
                "deptcode": "1",
                "deptname": "上海**学院",
                "specialtycode": "0",
                "specialtyname": null,
                "sex": "2",
                "idtype": "1",
                "idtypename": "身份证",
                "idno": "3702851*********",
                "areacode": "2",
                "areaname": "浦东校区",
                "classcode": null,
                "countrycode": "0",
                "country": null,
                "email": null,
                "nationcode": "0",
                "nation": "汉族",
                "tel": null,
                "mobile": null,
                "zipcode": null,
                "cardupdtime": "20150901142514",
                "custupdtime": "20150901142514"
            }
        ],
        "firstResult": 0,
        "firstPage": true,
        "lastPage": false,
        "nextPage": 2,
        "totalPage": 10,
        "prePage": 1
    }
}

  • 失败
{
	"retcode":"1",
	"retmsg":"查询失败"

返回参数说明:

参数名类型说明
retcodeString返回码(0=成功,其他为失败)
retmsgString返回消息
stuempnoString学号
usernameString姓名
balanceInteger余额(分)
cardnoInteger卡号
statusString状态(正常)

2.3 通用账户流水查询

请求URL:

  • https://ip:port/epayapi/services/thirdparty/common/getbilldata

请求方式/格式:

  • POST
  • application/x-www-form-urlencoded

请求参数:

参数名类型必选说明
partner_idString是      本系统分配给各个接入应用的合作伙伴id号
stuempnoString查询对象的学号
pagenoString页码,默认1
pagesizeString每页行数,默认10,范围10-500
startdateString开始时间 格式yyyyMMdd 最多3个月前
enddateString结束日期 格式yyyyMMdd
timestampString时间戳格式为yyyyMMddhh24miss
signString签名
sign_methodString参数的加密方法选择,可选值是:HMAC 加密方式为HAMC-SHA1

请求内容示例:

URI:https://ip:port/epayapi/services/thirdparty/common/getbilldata

partner_id:10000
pageno:1
pagesize:10
startdate:20150829
enddate:20150929
timestamp:20150119130901
sign:5195f9b9116e4adf67eeebc9935d33dc683f677d
sign_method:HMAC

返回示例:

  • 成功
{
{
    "retcode": "0",
    "retmsg": "查询成功",
    "data": {
        "totalCount": 3,
        "pageSize": 10,
        "pageNo": 1,
        "list": [
            {
                "refno": "20151015111200029503",
                "paytime": "20151015111223",
                "billname": "悦校现金补助",
                "amount": 283,
                "billtype": "下发补助",
                "billstatus": 2,
                "expiredate": null,
                "tradetype": "1",
                "tradecode": "3130"
            },
            {
                "refno": "20151013191000028629",
                "paytime": "20151013191031",
                "billname": "悦校现金补助",
                "amount": 283,
                "billtype": "下发补助",
                "billstatus": 2,
                "expiredate": null,
                "tradetype": "1",
                "tradecode": "3130"
            },
            {
                "refno": "20151013184200027918",
                "paytime": "20151013184230",
                "billname": "悦校现金补助",
                "amount": 283,
                "billtype": "下发补助",
                "billstatus": 2,
                "expiredate": null,
                "tradetype": "1",
                "tradecode": "3130"
            }
        ],
        "firstResult": 0,
        "totalPage": 1,
        "lastPage": true,
        "nextPage": 1,
        "prePage": 1,
        "firstPage": true
    }
}

  • 失败
{
	"retcode":"1",
	"retmsg":"查询失败"

返回参数说明:

参数名类型说明
retcodeString返回码(0=成功,其他为失败)
retmsgString返回消息
refnoString交易参考号
billnameString交易名称
billtypeString交易类型
amountInteger交易金额(分)
billstatusString状态 2-成功 3-失败
tradetypeString交易方向 1-充值 2-消费