支付增值服务
接口列表
代金券
根据商户号查询用户的券

根据商户号查用户的券

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

接口说明

请求方式:
post
https://p.wecard.tencent.com/cloudpay/v1/favor/query-user-coupons

请求参数

Request
Body 包体
openid必填
string

用户在商户appid下的唯一标识。校验规则:该openid需要与接口传入中的appid有对应关系。
示例值:2323dfsdf342342

最小长度:1     最大长度:128

wx_appid必填
string

微信为发券方商户分配的公众账号ID,接口传入的所有appid应该为公众号的appid(在mp.weixin.qq.com申请的)或APP的appid(在open.weixin.qq.com申请的)。
校验规则:
1、该appid需要与接口传入中的openid有对应关系;
2、该appid需要与调用接口的商户号(即请求头中的商户号)有绑定关系,若未绑定,可参考该指引完成绑定(商家商户号与AppID账号关联管理)
示例值:wx233544546545989

最小长度:1     最大长度:128

stock_id选填
string

批次号,是否指定批次号查询,填写available_mchid,该字段不生效。
示例值:9865000

最小长度:1     最大长度:20

creator_mchid选填
string

批次创建方商户号。与sender_mchid、available_mchid不可同时为空。
示例值:9865002
请求参数传创建商户号返回除过期以外所有状态的用户券

最小长度:1     最大长度:20

sender_mchid 选填
string

批次发放商户号(该字段暂未开放)。与creator_mchid、available_mchid不可同时为空。
示例值:9865001


available_mchid选填
string

可用商户号,与creator_mchid、sender_mchid 不可同时为空。
示例值:9865000
请求参数传核销商户号只能返回可用的代金券,实扣的与过期的无法返回


status选填
string

代金券状态:
选填creator_mchid时,
SENDED:返回可用
USED:返回可用+已实扣
选填available_mchid时,该字段不生效,仅返回可用状态的券。
示例值:SENDED

最小长度:1     最大长度:20

offset选填
uint32

分页页码,默认0,填写available_mchid,该字段不生效。
示例值:0


limit选填
uint32

分页大小,默认20,填写available_mchid,该字段不生效。
示例值:20


channel_merchant_id必填
string

请求示例

{
  "offset": 0,
  "stock_id": "8956000",
  "channel_merchant_id": "CM465922975711959340",
  "wx_appid": "wx233544546545989"
}

返回参数

Response
Response必填
object

返回示例

{
  "Response": {
    "RequestId": "948948503842433001",
    "Result": {
      "data": [
        {
          "stock_creator_mchid": "9800064",
          "stock_id": "9865888",
          "coupon_id": "98674556",
          "cut_to_message": {
            "single_price_max": 100,
            "cut_to_price": 100
          },
          "coupon_name": "微信支付代金券",
          "status": "SENDED",
          "description": "微信支付营销",
          "create_time": "2015-05-20T13:29:35+08:00",
          "coupon_type": "CUT_TO",
          "no_cash": true,
          "available_begin_time": "2015-05-20T13:29:35+08:00",
          "available_end_time": "2015-05-20T13:29:35+08:00",
          "singleitem": true,
          "normal_coupon_information": {
            "coupon_amount": 100,
            "transaction_minimum": 100
          },
          "consume_information": {
            "consume_time": "2015-05-20T13:29:35+08:00",
            "consume_mchid": "9856081",
            "transaction_id": "2345234523",
            "goods_detail": [
              {
                "goods_id": "a_goods1",
                "quantity": 7,
                "price": 1,
                "discount_amount": 4
              }
            ]
          }
        }
      ],
      "total_count": 100,
      "limit": 10,
      "offset": 10
    },
    "ErrCode": "SUCCESS",
    "ErrMessage": "成功"
  }
}

腾讯微卡收付通接口文档