支付宝-同步券核销状态
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2025.10.20 | 支付宝-同步券核销 |
2、业务说明
（1）接口说明
支付宝-同步券核销
请求主体类型：application/json
请求方式：POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay-test.com/openapi/ysMarket/ordervoucherUse |
| 正式环境 | https://ysgate.ysepay.com/openapi/ysMarket/ordervoucherUse |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称，固定值：ysMarket.ordervoucherUse |
| charset | String(10) | Y | 请求使用的编码格式，如utf-8,gbk,gb2312等,固定为utf-8 |
| sign | String | Y | 商户请求参数的签名串（签名算法默认为国密）,详见demo,注意:请用商户私钥进行签名 |
| check | String | Y | 银盛公钥加密随机生成的字符串（key）得到的加密值，详见demo |
| bizContent | String | Y | 业务参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递。注意：需要通过AES以及随机生成的字符串（key）加密业务参数集合，得到bizContent |
| reqId | String | Y | 请求唯一流水号,商户系统唯一，要求32个字符内（最少14个字符），只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值：xy1415220315145602 |
| certId | String | Y | 发起方商户号，服务商在银盛给自己开设的商户号，即可当作发起方商户号，由银盛生成并下发。 注意：不同于子商户号，服务商发展的商户即为子商户号 |
| version | String | Y | 调用的接口版本，固定为：1.0 |
4.2、业务请求参数
（bizContent加密前的json数据明文字符串）
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| activityId | String | Y | 活动 id |
| bizDt | String | Y | 外部优惠券的核销时间,格式为：yyyy-MM-dd HH:mm:ss |
| voucherCode | String | Y | 券码 |
| tradeChannel | String | Y | 交易渠道,【枚举值】 支付宝交易渠道: ZHIFUBAO_TRADE_CHANNEL 微信交易渠道: WX_TRADE_CHANNEL 其他交易渠道: OTHER_TRADE_CHANNEL |
| totalFee | String | Y | 订单优惠前的总金额,单位:元 【注意事项】使用当前优惠券的订单总金额，可用于商家在活动结束后统计数据。 限制：取值范围[0.01,100000000]，精确到小数点后2位。 |
| outBizNo | String | Y | 外部业务单号 |
| tradeNo | String | N | 支付宝的交易流水号,该交易在支付宝系统中的交易流水号。 注意：若用户使用支付宝为交易的渠道，本参数必填。 |
| realShopId | String | N | 物理门店ID |
| storeId | String | N | 支付宝内部门店id |
| goodsDetail | Array | N | 商品明细信息 |
| voucherUseDetailInfo | Object | N | 券核销详情 |
4.2.1 goodsDetail具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| goodsId | String | Y | 可核销单品 |
| goodsName | String | Y | 商品名称 |
| price | String | Y | 商品单价,单位 元 精确到小数点后2位 |
| quantity | int | Y | 商品数量 |
4.2.2 voucherUseDetailInfo具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| voucherUseTimes | int | N | 本次核销次数 |
5、响应参数说明
请注意：银盛后期会对返回参数保留扩展的权力，扩展方式为新增参数但不会删除参数，请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。5.1、公共响应参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| code | String(5) | Y | 网关响应码，示例值：00000 ，详见网关公共响应码 |
| msg | String(50) | Y | 网关响应码描述 |
| subCode | String | Y | 业务响应码，参见具体的API接口文档 |
| subMsg | String | Y | 业务响应描述 |
| timeStamp | String | Y | 响应时间，格式"yyyy-MM-dd HH:mm:ss" |
| norce | String(128) | Y | 随机参数 |
| sign | String | Y | 响应参数的签名串，详见demo, 注意:请用银盛公钥进行验签 |
| businessData | String | Y | 业务响应参数集合， 注意：银盛网关通过AES加密业务响应参数集合，得到businessData，商户需要对其进行解密，详情请见demo |
5.2、业务响应参数
响应业务参数businessData(json数据)
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| activityId | String | N | 优惠券活动id |
| voucherUseDetailResultInfo | Object | N | 券核销详情返回结果 |
5.2.1.1 voucherUseDetailResultInfo具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| voucherMaxUnUseTimes | int | N | 剩余可核销次数 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0 | 成功 | |
| 901579999 | 渠道返回错误 | |
| 901001001 | 参数校验不通过 | |
| 901001101 | 发起方权限不足 | |
| 901572999 | 支付宝返回错误 |