支付宝-活动领取咨询
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2025.10.20 | 支付宝-领取代金券咨询 |
2、业务说明
（1）接口说明
支付宝-领取代金券咨询
请求主体类型：application/json
请求方式：POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay-test.com/openapi/ysMarket/activityConsult |
| 正式环境 | https://ysgate.ysepay.com/openapi/ysMarket/activityConsult |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称，固定值：ysMarket.activityConsult |
| 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数据明文字符串）
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| merchantId | String | N | 商户PID |
| openId | String | N | 支付宝用户openId,userId 与 openId 二选一 必传 |
| userId | String | N | 用户uid,userId 与 openId 二选一 必传 |
| consultActivityInfoList | Array | Y | 待咨询的活动信息 |
4.2.1 consultActivityInfoList具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| activityId | String | Y | 活动ID |
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数据)
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| openId | String | N | 支付宝用户openId,userId 与 openId 二选一 |
| userId | String | N | 用户uid,userId 与 openId 二选一 |
| consultResultInfoList | Array | Y | 咨询后的活动结果信息 |
5.2.1.1 consultResultInfoList具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| activityId | String | Y | 活动 id |
| consultResultCode | String | Y | 结果code,【枚举值】 可以领取: SUCCESS 不可领取，次数超过限制: COUNT_OVER_LIMIT 不可领取，预算不足: BUDGET_NOT_ENOUGH 活动未开始: ACTIVITY_NOT_START 商户没有权限发放该活动: ACTIVITY_NOT_PERMISSION 不可领取，未知原因: OTHER |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0 | 成功 | |
| 901009999 | 系统错误 | |
| 901001001 | 参数校验不通过 | |
| 901001101 | 发起方权限不足 | |
| 901029998 | 支付宝渠道返回失败 | |
| 901029999 | 支付宝渠道异常 |