核销卡券

来自企业号开发者接口文档
跳转至: 导航搜索

查询code

  • 请求说明

Https请求方式: POST

https://qyapi.weixin.qq.com/cgi-bin/card/code/get?access_token=ACCESS_TOKEN

请求JSON数据包示例:

{ 
  "code" : "123456789",
}
  • 参数说明
参数 必须 说明
access_token 调用接口凭证
code 卡券code
  • 权限说明

卡券管理组的管理组具备所有卡券的核销权限,第三方套件管理组默认具备创建的卡券的核销权限。

  • 返回说明

卡券状态正常返回JSON数据包示例:

 {
   "errcode":0,
   "errmsg":"ok",
   "openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
   "card":{
   "card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
   "begin_time": 1404205036,
   "end_time": 1404205036,
   "user_card_status": "NORMAL",
   "can_consume":"true"
   }
 }

卡券状态异常返回JSON数据包示例:

{
 "errcode":0,
 "errmsg":"ok",
 "openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA",
 "card":{
   "card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc",
   "begin_time": 1404205036,
   "end_time": 1404205036,
   "user_card_status": "GIFTING",
  "can_consume":"false"
  }
 }
  • 参数说明
参数 说明
errcode 错误码
errmsg 错误信息
openid 用户openid
card_id 卡券ID
begin_time 起始使用时间
end_time 结束时间
user_card_status 当前code对应卡券的状态, NORMAL 正常 CONSUMED 已核销 EXPIRE 已过期 GIFTING 转赠中

GIFT_TIMEOUT 转赠超时 DELETE 已删除,UNAVAILABLE 已失效; code未被添加或被转赠领取的情况则统一报错:invalid serial code

can_consume 是否可以核销

核销code

  • 请求说明

Https请求方式: POST

https://qyapi.weixin.qq.com/cgi-bin/card/code/consume?access_token=ACCESS_TOKEN

请求JSON数据包示例:

{ 
  "code" : "123456789",
}
  • 参数说明
参数 必须 说明
access_token 调用接口凭证
code 卡券code
  • 权限说明

卡券管理组的管理组具备所有卡券的核销权限,第三方套件管理组默认具备创建的卡券的核销权限。

  • 返回说明

卡券状态正常返回JSON数据包示例:

 {
   "errcode":0,
   "errmsg":"ok",
   "card":{
          "card_id":"pFS7Fjg8kV1IdDz01r4SQwMkuCKc"
           },
   "openid":"oFS7Fjl0WsZ9AMZqrI80nbIq8xrA"   
 } 
  • 参数说明
参数 说明
errcode 错误码
errmsg 错误信息
card_id 卡券ID
openid 用户openid,用户在企业号内唯一身份标识