当前位置: 产品API > 云闪付 > 云闪付增值服务
产品介绍
  • 服务对象
    持卡人
  • 产品详情

    1.用于查询用户信息,根据优惠券代码查询该票券剩余张数;

    2.扫码核销;

    3.用于查询持卡人红包余额和红包使用情况;

    4.用于查询持卡人票券和票券历史交易明细。

  • 应用场景

     商户进行票卷承兑相关服务。

应答码参照
应答码状态列表
  • 应答码 描述 解决方案
    000000 交易成功 暂无
    100002 参数值无效,必输字段为空 暂无
    100003 参数值无效,字段超长 暂无
    100153 非法调用,无权限调用该接口 暂无
    100154 非法调用,商户允许ip配置为空 暂无
    100155 非法调用,ip非法 暂无
    100156 非法调用,验签失败,请确认请求参数 暂无
接入流程
接入流程

通讯方式:

报文接口基于HTTP/HTTPS协议进行报文传输。

调用地址:

交易发起方调用的URL地址,应通过其他途径获取。

提交方式:

请求报文统一采用POST方式提交。

系统交互:

image.png

票券交易类型

12-"票券下载"                                          

22- "票券订单生成"        

23- "票券订单支付成功"   

24- "票券订单支付失败"  

25- "票券订单退货请求"       

26- "票券订单退货成功"                    

27- "票券订单退货失败"                               

AD00000004- "折扣券累计"      

AD00000005- "抵扣券累计"   

AD00000006- "电子票累计"       

ZX00000004- "折扣券专项营销赠送"                

ZX00000005- "抵扣券专项营销赠送"   

ZX00000006- "电子票专项营销赠送" 

AC04200063- "优惠券自动承兑冲正"

17- "短信注册送券"      

HP00000006- "高端卡酒店权益赠送" 

20- "病毒式营销送券"  

AD00000104- "折扣券累计退货"

AD00000105- "抵扣券累计退货"

AD00000106- "电子票累计退货"

AD00000204- "折扣券累计撤销"

AD00000205- "抵扣券累计撤销"

AD00000206- "电子票累计撤销"

AC02000063- "优惠券自动承兑"

ZX00000104- "折扣券专项营销赠送撤销"

ZX00000105- "抵扣券专项营销赠送撤销"

ZX00000106- "电子票专项营销赠送撤销"

AC02000065- "CHSP消费"

AC02202000- "消费退货"                


线上交易类型

AC02000065 – CHSP消费

01 – 线上兑换充值卡

02 – 线上兑换礼品

04 -  线上积分赠送撤销

05 -  线上积分扣减

07 -  线上积分消费

S370000000 -  CHSP积分消费

AD00000102 - 银联通用积分累计退货

AD00000103 - 银联商圈积分累计退货

AD00000107 - 商户专用积分累计退货

AD00000104 - 折扣券累计退货

AD00000105 - 抵扣券累计退货

AD00000106 - 电子票累计退货

AD00000202 - 银联通用积分累计撤销

AD00000203 - 银联商圈积分累计撤销

AD00000207 - 商户专用积分累计撤销

AD00000204 - 折扣券累计撤销

AD00000205 - 抵扣券累计撤销

AD00000206 - 电子票累计撤销

ZX00000102 - 银联通用积分专项营销赠送撤销

ZX00000103 - 银联商圈积分专项营销赠送撤销

ZX00000104 - 折扣券专项营销赠送撤销

ZX00000105 - 抵扣券专项营销赠送撤销

ZX00000106 - 电子票专项营销赠送撤销

AC02000063 - 优惠券自动承兑

CB02000065 - 联盟积分消费

CB04202065 - 联盟积分消费撤销冲正

ZX00000102- "银联通用积分专项营销赠送撤销" 

S370000000- "CHSP积分消费"

S390000010- "CHSP积分退货"

AC02000065- "CHSP消费"

AC02202000- "消费退货"


API接口
查询用户信息
接口描述
查询用户信息
请求方式
POST
生产地址
https://esb.unionpay.com/cardholder/PREWALLET/PREWALLETOuterService/PREWALLETOuterServiceProxy/getUserInfoByMobile
测试地址
请求报文体参数
名称 标识 字段类型 长度 请求要求 默认值 备注
发起方ID appId string M-必填 由持卡人增值服务运营方分配给接入方的唯一ID。   
请求数据 data string M-必填 上送的数据报文主体,如果不填则为空。   
手机号码 mobile string M-必填 AES加密   
签名信息 signToken string M-必填 对请求报文中的“请求数据(data)”的签名,使用接入系统的私钥签名(要求将对应公钥提交给持卡人增值服务运营方),公钥证书格式要求使用PKCS#8,是否需要验码请与持卡人增值服务运营方进行沟通。   
同步应答参数
名称 标识 字段类型 长度 请求要求 默认值 备注
应答码 responseCode string M-必填   
提示信息 message string M-必填   
应答数据 data string M-必填   
持卡人用户标识 openId string M-必填   
查询优惠券剩余数量
接口描述
根据优惠券代码查询该票券剩余张数。
请求方式
POST
生产地址
https://esb.unionpay.com/cardholder/PREWALLET/PREWALLETOuterService/PREWALLETOuterServiceProxy/getCouponNum
测试地址
请求报文体参数
名称 标识 字段类型 长度 请求要求 默认值 备注
发起方ID appId string M-必填 由持卡人增值服务运营方分配给接入方的唯一ID。   
请求数据 data string M-必填 上送的数据报文主体,如果不填则为空。   
优惠券代码 couponId string M-必填   
签名信息 signToken string M-必填 对请求报文中的“请求数据(data)”的签名,使用接入系统的私钥签名(要求将对应公钥提交给持卡人增值服务运营方),公钥证书格式要求使用PKCS#8,是否需要验码请与持卡人增值服务运营方进行沟通。   
同步应答参数
名称 标识 字段类型 长度 请求要求 默认值 备注
应答码 responseCode string M-必填   
提示信息 message string M-必填   
应答数据 data string M-必填   
优惠券代码 couponId string M-必填   
优惠券剩余张数 rmngCouponNum string M-必填   
扫码核销
接口描述
扫码核销
请求方式
POST
生产地址
https://esb.unionpay.com/cardholder/PREWALLET/CHWPREUcExternalService/CHWPREUcExternalServiceProxy/codePay/verification
测试地址
请求报文体参数
名称 标识 字段类型 长度 请求要求 默认值 备注
发起方ID appId string M-必填 由持卡人增值服务运营方分配给接入方的唯一ID。   
请求数据 data string M-必填 上送的数据报文主体,如果不填则为空。   
付款码信息 tranCertificate string M-必填   
接入商户的代码 mchntId string M-必填   
商户系统内部的订单号 outTradeNo string M-必填   
商户终端编号 terminalId string M-必填   
签名信息 signToken string M-必填 对请求报文中的“请求数据(data)”的签名,使用接入系统的私钥签名(要求将对应公钥提交给持卡人增值服务运营方),公钥证书格式要求使用PKCS#8,是否需要验码请与持卡人增值服务运营方进行沟通。   
同步应答参数
名称 标识 字段类型 长度 请求要求 默认值 备注
应答码 responseCode string M-必填   
提示信息 message string M-必填   
应答数据 data string M-必填   
订单号 orderId string M-必填 银联钱包订单号   
原商户系统内部的订单号 outTradeNo string M-必填   
实际收取的金额 tranAmount string M-必填 实际收取的金额(单位分)   
优惠的金额 disAmount string M-必填 优惠的金额(单位分)   
优惠劵使用的详细信息 suppInfo string M-必填 "suppInfo":[{"infoDesc":"1张","infoName":"星巴克消费满100减40"},{"infoDesc":"11张","infoName":"屈臣氏消费满100减40"},{"infoDesc":"10.00X2张","infoName":"麦当劳消费满100减40"}]   
对订单或者商品的描述 body string M-必填   
支付的时间 tranTime string M-必填   
交易的状态 tranStatus string M-必填 交易的状态:00:处理中 01:成功 02:失败   
交易的错误码 errCode string M-必填   
错误信息的描述 errDesc string M-必填   
业务扩展参数 extendParams string M-必填 业务扩展参数,新增加了用户手机号信息(已脱敏)billId、billName、acceptanceTime、orderId、billNum、mchntId、termId、mobile   
持卡人红包查询
接口描述
该接口用于查询持卡人红包余额
请求方式
POST
生产地址
https://esb.unionpay.com/cardholder/PREWALLET/PREWALLETOuterService/PREWALLETOuterServiceProxy/khfw/getUpPointById
测试地址
请求报文体参数
名称 标识 字段类型 长度 请求要求 默认值 备注
发起方ID appId string M-必填 由持卡人增值服务运营方分配给接入方的唯一ID。   
请求数据 data string M-必填 上送的数据报文主体,如果不填则为空。   
持卡人用户标识 openId string M-必填   
版本 version string M-必填 固定填4.0   
签名信息 signToken string M-必填 对请求报文中的“请求数据(data)”的签名,使用接入系统的私钥签名(要求将对应公钥提交给持卡人增值服务运营方),公钥证书格式要求使用PKCS#8,是否需要验码请与持卡人增值服务运营方进行沟通。   
同步应答参数
名称 标识 字段类型 长度 请求要求 默认值 备注
应答码 responseCode string M-必填   
提示信息 message string M-必填   
应答数据 data string M-必填   
账户状态 acctSt string M-必填   
积分余额 pointAt string M-必填   
冻结积分额 freezePointAt string M-必填   
持卡人红包使用记录查询
接口描述
该接口用于查询持卡人红包使用情况
请求方式
POST
生产地址
https://esb.unionpay.com/cardholder/PREWALLET/PREWALLETOuterService/PREWALLETOuterServiceProxy/khfw/getUpPointHistoryById
测试地址
请求报文体参数
名称 标识 字段类型 长度 请求要求 默认值 备注
发起方ID appId string M-必填 由持卡人增值服务运营方分配给接入方的唯一ID。   
请求数据 data string M-必填 上送的数据报文主体,如果不填则为空。   
持卡人用户标识 openId string M-必填   
版本 version string M-必填   
开始日期 beginDt string M-必填 开始日期(开始结束日期跨度不能超过14天,格式YYYYMMDD)   
结束日期 endDt string M-必填 结束日期(开始结束日期跨度不能超过14天,格式YYYYMMDD)   
签名信息 signToken string M-必填 对请求报文中的“请求数据(data)”的签名,使用接入系统的私钥签名(要求将对应公钥提交给持卡人增值服务运营方),公钥证书格式要求使用PKCS#8,是否需要验码请与持卡人增值服务运营方进行沟通。   
同步应答参数
名称 标识 字段类型 长度 请求要求 默认值 备注
应答码 responseCode string M-必填   
提示信息 message string M-必填   
应答数据 data string M-必填   
超限 overLimitIn string M-必填 是否超限 1:超限,0:未超限   
持卡人红包使用记录查询结果列表节点 pointTransHisList string M-必填   
交易卡号 priAcctNo string M-必填   
商户代码 mchntCd string M-必填   
商户名称 mchntNm string M-必填   
入账日期 transDt string M-必填   
入账时间 transTm string M-必填   
交易金额 transAt string M-必填   
优惠金额 discountAt string M-必填   
umTransId umTransId string M-必填 详见:线上交易类型   
bussTp bussTp string M-必填 00 - 转接类;01 - 组合承兑;02 - 银联通用积分;03 - 银联商圈积分;04 - 折扣券;05 – 抵扣券;06 – 电子券;07 – 商户专用积分   
pointTp charaAccTp string M-必填   
积分额 pointTp string M-必填   
交易状态 transSt string M-必填   
系统决定码 sysDetCd string M-必填   
系统跟踪号 sysTraNo string M-必填   
受理机构 acpInsIdCd string M-必填   
终端号 termCd string M-必填   
云闪付实体卡号 tokenCardNo string M-必填   
云闪付产品标识 udfFld string M-必填   
持卡人票券查询
接口描述
该接口用于查询持卡人票券
请求方式
POST
生产地址
https://esb.unionpay.com/cardholder/PREWALLET/PREWALLETOuterService/PREWALLETOuterServiceProxy/khfw/getBillById
测试地址
请求报文体参数
名称 标识 字段类型 长度 请求要求 默认值 备注
发起方ID appId string M-必填 由持卡人增值服务运营方分配给接入方的唯一ID。   
请求数据 data string M-必填 上送的数据报文主体,如果不填则为空。   
持卡人用户标识 openId string M-必填   
版本 version string M-必填 固定填4.0   
分页页码 pageNum string M-必填 分页页码(页码必须大于0)   
分页大小 pageSize string M-必填 分页列表大小(分页列表最大为100)   
签名信息 signToken string M-必填 对请求报文中的“请求数据(data)”的签名,使用接入系统的私钥签名(要求将对应公钥提交给持卡人增值服务运营方),公钥证书格式要求使用PKCS#8,是否需要验码请与持卡人增值服务运营方进行沟通。   
同步应答参数
名称 标识 字段类型 长度 请求要求 默认值 备注
应答码 responseCode string M-必填   
提示信息 message string M-必填   
应答数据 data string M-必填   
总条数 total string M-必填   
持卡人票券查询结果列表节点 ticketCouponBillAcctList string M-必填   
票券ID billId string M-必填   
账单类型 billTp string M-必填   
票券数量 billNum string M-必填   
使用次数 usageNum string M-必填   
acctSt acctSt string M-必填 0:待激活;1:正常;2:已销户;3:冻结;4:受限;5:关闭   
冻结票券数量 freezeBillNum string M-必填   
票券名称 billNm string M-必填   
票券描述 billDesc string M-必填   
有效期开始日期 validBeginDt string M-必填   
有效期结束日期 validEndDt string M-必填   
billSt billSt string M-必填 0-新建;1-生效;2-已过期;3-已删除   
代金金额 moneyAt string M-必填   
交易金额下限 lowTransAtLimit string M-必填   
交易金额上限 highTransAtLimit string M-必填   
是否循环抵扣 cycleDeductIn string M-必填   
持卡人票券历史交易明细查询
接口描述
该接口用于查询持卡人票券历史交易明细
请求方式
POST
生产地址
https://esb.unionpay.com/cardholder/PREWALLET/PREWALLETOuterService/PREWALLETOuterServiceProxy/khfw/getBillHistoryById
测试地址
请求报文体参数
名称 标识 字段类型 长度 请求要求 默认值 备注
发起方ID appId string M-必填 由持卡人增值服务运营方分配给接入方的唯一ID。   
请求数据 data string M-必填 上送的数据报文主体,如果不填则为空。   
openId openId string M-必填 持卡人用户标识   
版本 version string M-必填 固定填4.0   
开始日期 beginDt string M-必填 开始结束日期跨度不能超过14天)   
结束日期 endDt string M-必填 开始结束日期跨度不能超过14天   
签名信息 signToken string M-必填 对请求报文中的“请求数据(data)”的签名,使用接入系统的私钥签名(要求将对应公钥提交给持卡人增值服务运营方),公钥证书格式要求使用PKCS#8,是否需要验码请与持卡人增值服务运营方进行沟通。   
同步应答参数
名称 标识 字段类型 长度 请求要求 默认值 备注
应答码 responseCode string M-必填   
提示信息 message string M-必填   
应答数据 data string M-必填   
超限 overLimitIn string M-必填 是否超限 1:超限,0:未超限   
持卡人票券历史交易明细查询结果列表节点 billTransHisList string M-必填   
交易卡号 priAcctNo string M-必填   
商户代码 mchntCd string M-必填   
商户名称 mchntNm string M-必填   
入账日期 transDt string M-必填   
入账时间 transTm string M-必填   
交易金额 transAt string M-必填   
优惠金额 discountAt string M-必填   
umTransId umTransId string M-必填 详见:票券交易类型   
bussTp bussTp string M-必填   
票券ID billId string M-必填   
票券数量 billNum string M-必填   
增值服务类别 charaAccTp string M-必填   
交易状态 transSt string M-必填   
系统决定码 sysDetCd string M-必填   
系统跟踪号 sysTraNo string M-必填   
受理机构 acpInsIdCd string M-必填   
终端号 termCd string M-必填   
云闪付实体卡号 tokenCardNo string M-必填   
云闪付产品标识 udfFld string M-必填   
联系我们

业务咨询: 赵帮奎

021-20633497

zhaobangkui@unionpay.com

技术咨询: 赵帮奎

021-20633497

zhaobangkui@unionpay.com

中国银联版权所有©2002-2019沪 ICP备07032180号