支付增值服务
接口列表
代金券
查询代金券详情

查询代金券详情

通过此接口可查询代金券信息,包括代金券的基础信息、状态。

接口说明

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

请求参数

Request
Body 包体
wx_appid必填
string

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

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

coupon_id必填
string

微信为代金券唯一分配的id。
发放代金券API返回的数据。
示例值:9856888

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

openid必填
string

openid是微信用户在appid下的唯一用户标识(appid不同,则获取到的openid就不同),可用于永久标记一个用户。
获取openid的方式
示例值:2323dfsdf342342

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

channel_merchant_id必填
string

请求示例

{
  "offset": 0,
  "coupon_id": "9856888",
  "wx_appid": "wx233544546545989",
  "openid": "2323dfsdf342342",
  "channel_merchant_id": "CM465922975711959340"
}

返回参数

Response
Response必填
object

返回示例

{
  "Response": {
    "RequestId": "948948503842433001",
    "Result": {
      "stock_creator_mchid": "9800064",
      "stock_id": "9865888",
      "coupon_id": "98674556",
      "cut_to_message": {
        "single_price_max": 100,
        "cut_to_price": 100
      },
      "coupon_name": "微信支付代金券",
      "status": "EXPIRED",
      "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
      },
      "ErrCode": "SUCCESS",
      "ErrMessage": "成功"
    }
  }
}

cut_to_message

参数名变量类型[长度限制]必填描述
可用优惠的商品最高单价single_price_maxuint64可用优惠的商品最高单价,单位:分。
示例值:100
减至后的优惠单价cut_to_priceuint64减至后的优惠单价,单位:分。
示例值:100

normal_coupon_information

参数名变量类型[长度限制]必填描述
面额coupon_amountuint64面额,单位:分。
示例值:100
门槛transaction_minimumuint64使用券金额门槛,单位:分。
示例值:100

腾讯微卡收付通接口文档