适用对象：直连商户
请求URL：https://api.mch.weixin.qq.com/v3/discount-card/cards/{out_card_code}
请求方式：GET
path 指该参数为路径参数
query 指该参数为URL参数
body 指该参数需在请求JSON传参
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 商户领卡号 | out_card_code | string[1,32] | 是 | path 商户在请求领卡预受理接口时传入的领卡请求号，同一个商户号下必须唯一，要求32个字符内，只能是数字、大小写字母_-|* 示例值：233bcbf407e87789b8e471f251774f95 |
https://api.mch.weixin.qq.com/v3/discount-card/cards/233bcbf407e87789b8e471f251774f95
| 参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 先享卡ID | card_id | string[1,64] | 是 | 先享卡ID，唯一标识一个先享卡。 示例值：233bcbf407e87789b8e471f251774f95 |
| 先享卡模板ID | card_template_id | string[1,64] | 是 | 先享卡卡模板ID，唯一定义此资源的标识。创建模板后可获得。 示例值：87789b2f25177433bcbf407e8e471f95 |
| 用户标识 | openid | string [1,128] | 是 | 微信用户在商户对应appid下的唯一标识 示例值：oUpF8uMuAJ2pxb1Q9zNjWeS6o |
| 商户领卡号 | out_card_code | string[1,32] | 是 | 商户在请求领卡预受理接口时传入的领卡请求号，同一个商户号下必须唯一，要求32个字符内，只能是数字、大小写字母_-|* 示例值：6e8369071cd942c0476613f9d1ce9ca3 |
| 公众账号ID | appid | string[10,32] | 是 | 微信公众平台分配的与传入的商户号建立了支付绑定关系的appid，可在公众平台查看绑定关系 示例值：wxd678efh567hg6787 |
| 商户号 | mchid | string[1,32] | 是 | 微信支付分配的商户号 示例值：1230000109 |
| + 约定时间期限 | time_range | object | 是 | 用户领取先享卡之后，约定的生效时间和到期时间。 |
| 状态 | state | string[1,16] | 是 | 先享卡的守约状态： ONGOING：约定进行中，表示用户在约定有效期内，尚未完成所有目标时，守约状态为约定进行中。 SETTLING：约定到期核对中，在约定有效期结束后的一段时间，商户可对卡记录进行校对并做必要调整，守约状态为约定到期核对调整中。 FINISHED：已完成约定，表示用户在约定有效期内，已完成所有目标，守约状态为已完成约定。 UNFINISHED：未完成约定，表示用户在约定有效期到期后，最终未完成所有约定目标，或用户提前退出约定，守约状态为未完成约定。 示例值：ONGOING |
| 未完成约定原因 | unfinished_reason | string[1,16] | 否 | 用户未完成约定的原因，当订单守约状态为UNFINISHED时，返回此字段 DUE_TO_QUIT：到期未完成约 EARLY_QUIT：提前退出约定 示例值：DUE_TO_QUIT |
| 享受优惠总金额 | total_amount | int64 | 否 | 表示用户享受优惠的总金额，单位为：分； 示例值：1000 |
| + 用户退回优惠的付款信息 | pay_information | object | 否 | 当状态为UNFINISHED(用户未完成约定)时，且需要退回已享受的优惠金额时，返回此字段； |
| 创卡时间 | create_time | string[1,32] | 是 | 创卡时间，遵循rfc3339标准格式，格式为yyyy-MM-DDTHH:mm:ss.sss+TIMEZONE，yyyy-MM-DD表示年月日，T出现在字符串中，表示time元素的开头，HH:mm:ss.sss表示时分秒毫秒，TIMEZONE表示时区（+08:00表示东八区时间，领先UTC 8小时，即北京时间）。例如：2015-05-20T13:29:35.120+08:00表示北京时间2015年05月20日13点29分35秒 示例值：2015-05-20T13:29:35.120+08:00 |
| + 目标列表 | objectives | array | 是 | 用户先享卡目标列表 |
| + 优惠列表 | rewards | array | 是 | 用户先享卡优惠列表 |
| 邀请者用户标识 | sharer_openid | string[1,128] | 否 | 微信用户在商户对应appid下的唯一标识。 仅当此卡是通过“邀请有礼”渠道领卡时，会返回此字段；指此先享卡是通过此[邀请者]邀请领卡成功的。当此先享卡完成约定时，商户可给此[邀请者]下发应邀请有礼的奖励 示例值：oUpF8uMuAJ2pxb1Q9zNjWUHsd |
{
"unfinished_reason" : "DUE_TO_QUIT",
"mchid" : "1230000109",
"create_time" : "2015-05-20T13:29:35.12+08:00",
"openid" : "oUpF8uMuAJ2pxb1Q9zNjWeS6o",
"pay_information" : {
"transaction_id" : "1009660380201506130728806387",
"pay_state" : "PAYING",
"pay_amount" : 100,
"pay_time" : "2015-05-20T13:29:35.12+08:00"
},
"sharer_openid" : "oUpF8uMuAJ2pxb1Q9zNjWUHsd",
"card_id" : "233bcbf407e87789b8e471f251774f95",
"card_template_id" : "87789b2f25177433bcbf407e8e471f95",
"out_card_code" : "6e8369071cd942c0476613f9d1ce9ca3",
"time_range" : {
"end_time" : "2015-05-20T13:29:35.12+08:00",
"begin_time" : "2015-05-20T13:29:35.12+08:00"
},
"total_amount" : 1000,
"appid" : "wxd678efh567hg6787",
"objectives" : [ {
"unit" : "次",
"name" : "一周购买三次商品",
"count" : 1,
"description" : "特价商品",
"objective_completion_records" : [ {
"completion_time" : "2015-05-20T13:29:35.120+08:00",
"objective_completion_serial_no" : "578354545",
"description" : "购买商品/取消购买商品",
"completion_count" : 1,
"remark" : "特价商品",
"completion_type" : "INCREASE",
"objective_id" : "123456"
}, {
"completion_time" : "2015-05-20T13:29:35.120+08:00",
"objective_completion_serial_no" : "578354545",
"description" : "购买商品/取消购买商品",
"completion_count" : 1,
"remark" : "特价商品",
"completion_type" : "INCREASE",
"objective_id" : "123456"
} ],
"objective_id" : "123456"
}, {
"unit" : "次",
"name" : "一周购买三次商品",
"count" : 1,
"description" : "特价商品",
"objective_completion_records" : [ {
"completion_time" : "2015-05-20T13:29:35.120+08:00",
"objective_completion_serial_no" : "578354545",
"description" : "购买商品/取消购买商品",
"completion_count" : 1,
"remark" : "特价商品",
"completion_type" : "INCREASE",
"objective_id" : "123456"
}, {
"completion_time" : "2015-05-20T13:29:35.120+08:00",
"objective_completion_serial_no" : "578354545",
"description" : "购买商品/取消购买商品",
"completion_count" : 1,
"remark" : "特价商品",
"completion_type" : "INCREASE",
"objective_id" : "123456"
} ],
"objective_id" : "123456"
} ],
"state" : "ONGOING",
"rewards" : [ {
"unit" : "个",
"amount" : 100,
"count_type" : "COUNT_LIMIT",
"name" : "八折优惠",
"count" : 1,
"description" : "特价商品优惠",
"reward_id" : "123456",
"reward_usage_records" : [ {
"usage_count" : 100,
"amount" : 1,
"usage_type" : "INCREASE",
"usage_time" : "2015-05-20T13:29:35.120+08:00",
"reward_usage_serial_no" : "578354",
"description" : "购买商品",
"reward_id" : "123456",
"remark" : "特价商品"
}, {
"usage_count" : 100,
"amount" : 1,
"usage_type" : "INCREASE",
"usage_time" : "2015-05-20T13:29:35.120+08:00",
"reward_usage_serial_no" : "578354",
"description" : "购买商品",
"reward_id" : "123456",
"remark" : "特价商品"
} ]
}, {
"unit" : "个",
"amount" : 100,
"count_type" : "COUNT_LIMIT",
"name" : "八折优惠",
"count" : 1,
"description" : "特价商品优惠",
"reward_id" : "123456",
"reward_usage_records" : [ {
"usage_count" : 100,
"amount" : 1,
"usage_type" : "INCREASE",
"usage_time" : "2015-05-20T13:29:35.120+08:00",
"reward_usage_serial_no" : "578354",
"description" : "购买商品",
"reward_id" : "123456",
"remark" : "特价商品"
}, {
"usage_count" : 100,
"amount" : 1,
"usage_type" : "INCREASE",
"usage_time" : "2015-05-20T13:29:35.120+08:00",
"reward_usage_serial_no" : "578354",
"description" : "购买商品",
"reward_id" : "123456",
"remark" : "特价商品"
} ]
} ]
}
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 500 | SYSTEM_ERROR | 系统错误 | 5开头的状态码都为系统问题，请使用相同参数稍后重新调用 |
| 400 | PARAM_ERROR | 参数错误 | 根据错误提示，传入正确参数 |
| 404 | RESOURCE_NOT_EXISTS | 订单不存在，请检查订单号是否正确 | 请传入正确的订单号 |
| 400 | INVALID_REQUEST | 请求参数符合参数格式，但不符合业务规则 | 当前状态无需操作 |
| 401 | SIGN_ERROR | 签名验证失败 | 请检查签名参数和方法是否都符合签名算法要求 |
| 403 | NO_AUTH | 权限异常 | 请开通商户号相关权限，请联系产品或商务申请 |
| 429 | FREQUENCY_LIMITED | 请求超过频率限制 | 请求未受理，请降低频率后重试 |