查询代金券可用商户API

最新更新时间:2019.09.29 版本说明


通过调用此接口可查询批次的可用商户号,判断券是否在某商户号可用,来决定是否展示。

接口说明

适用对象:直连商户 服务商 渠道商

请求URL:https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/{stock_id}/merchants

请求方式:GET

接口规则:https://pay.weixin.qq.com/wiki/doc/apiv3/wechatpay/wechatpay-1.shtml


path指该参数为路径参数

query 指该参数需在请求URL传参

body 指该参数需在请求JSON传参


请求参数

参数名 变量 类型[长度限制] 必填 描述
分页页码 offset uint32 query 分页页码,最大1000。
示例值: 10
分页大小 limit uint32 query 分页大小,最大50。
示例值: 10
创建批次的商户号 stock_creator_mchid string[1,20] query 批次创建方商户号。
示例值: 9865000
批次号 stock_id string[1,20] path 批次号
示例值: 9865000

请求示例


https://api.mch.weixin.qq.com/v3/marketing/favor/stocks/9865000/merchants?offset=10&limit=10&stock_creator_mchid=9865000
    
{
JAVA示例代码
}
    

返回参数

参数名 变量 类型[长度限制] 必填 描述

可用商户总数量
total_count uint32 可用商户总数量。
示例值: 200
可用商户列表 data array 可用商户列表
特殊规则:单个商户号的字符长度为【1,20】,条目个数限制为【1,50】。
示例值:1232001
分页页码 offset uint32 分页页码
示例值: 10
分页大小 limit uint32 分页大小
示例值: 10
批次号 stock_id string[1,20]
批次号
示例值: 9865000

返回示例


{
    "data": [
        "2480248941"
    ],
    "limit": 5,
    "offset": 0,
    "stock_id": "15019035",
    "total_count": 1
}
                                

    http://2323weixin.qq.com
                                

错误码公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 回调url不能为空 请填写回调url
PARAM_ERROR 回调商户不能为空 请填写回调商户
PARAM_ERROR 券id必填 请填写券id
PARAM_ERROR appid必填 请输入appid
PARAM_ERROR openid必填 请输入openid
PARAM_ERROR 页大小超过阈值 请不要超过最大的页大小
PARAM_ERROR 输入时间格式错误 请输入正确的时间格式
PARAM_ERROR 批次号必填 请输入批次号
PARAM_ERROR 商户号必填 请输入商户号
PARAM_ERROR 非法的批次状态 请检查批次状态
400 MCH_NOT_EXISTS 商户号不合法 请输入正确的商户号
400 INVALID_REQUEST openid与appID不匹配 请使用appID下的的openid
INVALID_REQUEST 活动已结束或未激活 请检查批次状态
INVALID_REQUEST 非法的商户号 请检查商户号是否正确
400 APPID_MCHID_NOT_MATCH 商户号与appid不匹配 请绑定调用接口的商户号和APPID后重试
403 USER_ACCOUNT_ABNORMAL 用户非法 该用户账号异常,无法领券。商家可联系微信支付或让用户联系微信支付客服处理。
403 NOT_ENOUGH 批次预算不足 请补充预算
403 REQUEST_BLOCKED 调用商户无权限 请开通产品权限后再调用该接口
REQUEST_BLOCKED 商户无权发券 调用接口的商户号无权发券,请检查是否是自己的批次或是已授权的批次。
REQUEST_BLOCKED 批次不支持跨商户发券 该批次未做跨商户号的授权,请授权后再发放
REQUEST_BLOCKED 用户被限领拦截 用户领取已经达到上限,请调高上限或停止发放。
404 RESOURCE_NOT_EXISTS 批次不存在 请检查批次ID是否正确
429 FREQUENCY_LIMIT_EXCEED 接口限频 请降低调用频率

版本说明

关闭
V1.0
2019年09月29日
1. 查询代金券可用商户接口上线

技术咨询

文档反馈