根据商户号查用户的券

更新时间:2024.05.28

可通过该接口查询用户在某商户号可用的全部券,可用于商户的小程序/H5中,用户"我的代金券"或"提交订单页"展示优惠信息。无法查询到微信支付立减金。本接口查不到用户的微信支付立减金(又称“全平台通用券”),即在所有商户都可以使用的券,例如:摇摇乐红包;当按可用商户号查询时,无法查询用户已经核销的券

接口频率:不区分来源 2000/s 单ip 500/s

接口耗时:平均100ms以内

幂等规则:接口支持幂等重入

# 接口说明

支持商户:
【普通商户】
请求方式:
【GET】/v3/marketing/favor/users/{openid}/coupons
请求域名:
【主域名】
https://api.mch.weixin.qq.com
使用该域名将访问就近的接入点
【备域名】
https://api2.mch.weixin.qq.com
使用该域名将访问异地的接入点 ,指引点击查看

# 请求参数

    Header HTTP头参数
  • Authorization 必填 string
    请参考 签名认证 生成认证信息
  • Accept 必填 string
    请设置为 application/json
    Path 路径参数
  • openid 必填 string(128)
    【用户标识】 用户在商户appid下的唯一标识。
    校验规则:该openid需要与接口传入中的appid有对应关系。
    Query 查询参数
  • appid 必填 string(128)
    【公众账号ID】 微信为发券方商户分配的公众账号ID,接口传入的所有appid应该为公众号的appid(在mp.weixin.qq.com申请的)或APP的appid(在open.weixin.qq.com申请的)。
    校验规则:
    1、该appid需要与接口传入中的openid有对应关系;
    2、该appid需要与调用接口的商户号(即请求头中的商户号)有绑定关系,若未绑定,可参考该指引完成绑定(商家商户号与AppID账号关联管理
  • stock_id 选填 string(20)
    【批次号】 批次号,是否指定批次号查询,填写available_mchid,该字段不生效。
  • status 选填 string(6)
    【券或消费金状态】 代金券或消费金状态:
    选填creator_mchid时,
    SENDED:返回可用
    USED:返回可用+已实扣
    选填available_mchid时,该字段不生效,仅返回 可用 状态的券或消费金。
  • creator_mchid 选填 string(20)
    【创建批次的商户号】 批次创建方商户号。请求参数传创建商户号返回除过期以外所有状态的用户券。creator_mchid与available_mchid二选一,如果同时存在,优先使用creator_mchid。
  • available_mchid 选填 string(20)
    【可用商户号】 可用商户号请求参数传可用商户号只能返回可用的代金券,实扣的与过期的无法返回。creator_mchid与available_mchid二选一,如果同时存在,优先使用creator_mchid。
  • offset 选填 integer
    【分页页码】 分页页码,默认0,填写available_mchid,该字段不生效
  • limit 选填 integer
    【分页大小】 分页大小,默认20,填写available_mchid,该字段不生效
  • business_type 选填 string
    【业务类型】 若选择MULTIUSE,则仅返回查询用户拥有的消费金列表
    枚举值:
    MULTIUSE:消费金
    可选取值:
    • MULTIUSE: 消费金类型

请求示例

GET

# 应答参数

    200OK
  • data 选填 array[object]
    【结果集】 结果集
    • 属性
  • total_count 必填 integer
    【查询结果总数】 查询结果总数
  • limit 必填 integer
    【分页大小】 分页大小
  • offset 必填 integer
    【分页页码】 分页页码

应答示例

200 OK

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 请根据错误提示正确传入参数
400 INVALID_REQUEST HTTP 请求不符合微信支付 APIv3 接口规则 请参阅 接口规则
401 SIGN_ERROR 验证不通过 请参阅 签名常见问题
500 SYSTEM_ERROR 系统异常,请稍后重试 请稍后重试

# 业务错误码

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