最新更新时间:2020.06.12 版本说明
用户领取优惠卡后,微信会把用户领卡信息发送给商户。
• 同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。
推荐的做法是,当商户系统收到通知进行处理时,先检查对应业务数据的状态,并判断该通知是否已经处理。如果未处理,则再进行处理;如果已处理,则直接返回结果成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。
• 如果在所有通知频率后没有收到微信侧回调,商户应调用【查询先享卡订单】接口确认订单状态。
特别提醒:商户系统对于确认订单通知的内容一定要做签名验证,并校验通知的信息是否与商户侧的信息一致,防止数据泄露导致出现“假通知”,造成资金损失。
适用对象:直连商户
请求URL:该链接是通过商户【预受理领卡请求】中提交notify_url参数,必须为https协议。如果链接无法访问,商户将无法接收到微信通知。 通知url必须为直接可访问的url,不能携带参数。示例: “https://pay.weixin.qq.com/wxpay/pay.action”
用户领取优惠卡后,微信会把用户领卡信息发送给商户,商户需要接收处理,并返回应答。出于安全的考虑,我们对数据进行加密,商户需要先对通知数据进行解密,才能得到用户领卡信息。
对后台通知交互时,如果微信收到商户的应答不符合规范或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。 (通知频率为0s/15s/15s/30s/180s/1800s/1800s/1800s/1800s/3600s )
用户领卡结果通知是以POST 方法访问商户设置的通知url,通知的数据以JSON 格式通过请求主体(BODY)传输。通知的数据包括了加密的支付结果详情。
(注:由于涉及到回调加密和解密,商户必须先设置好apiv3密钥后才能解密回调通知,apiv3密钥设置文档指引详见APIv3密钥设置指引)
下面详细描述对通知数据进行解密的流程:
注: AEAD_AES_256_GCM算法的接口细节,请参考rfc5116。微信支付使用的密钥key长度为32个字节,随机串nonce长度12个字节,associated_data长度小于16个字节并可能为空。
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
通知ID | id | string[1,36] | 是 | 通知的唯一ID。 示例值:EV-2018022511223320873 |
通知创建时间 | create_time | string[1,32] | 是 | 通知创建的时间,格式为yyyyMMddHHmmss(标准iso8601时间格式) 遵循rfc3339标准格式,格式为yyyy-MM-DDTHH:mm:ss+TIMEZONE,yyyy-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss.表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示北京时间2015年05月20日13点29分35秒。 示例值:2015-05-20T13:29:35+08:00 |
通知类型 | event_type | string[1,32] | 是 | 通知的类型,
用户领卡通知的类型为:DISCOUNT_CARD.USER_ACCEPTED 示例值:DISCOUNT_CARD.USER_ACCEPTED |
通知数据类型 | resource_type | string[1,32] | 是 | 通知的资源数据类型,用户领卡通知为encrypt-resource。 示例值:encrypt-resource |
+通知数据 | resource | object | 是 | 通知资源数据 json格式,见示例 |
回调摘要 | summary | string[1,64] | 是 | 回调摘要 示例值:用户领卡成功 |
加密不能保证通知请求来自微信。微信会对发送给商户的通知进行签名,并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名,以确认请求来自微信,而不是其他的第三方。签名验证的算法请参考 《微信支付API v3签名验证》。
{
"id":"EV-2018022511223320873",
"create_time":"2015-05-20T13:29:35+08:00",
"resource_type":"encrypt-resource",
"event_type":"DISCOUNT_CARD.USER_ACCEPTED",
"resource" : {
"algorithm":"AEAD_AES_256_GCM",
"ciphertext": "...",
"original_type": "discount_card",
"nonce": "...",
"associated_data": ""
},
"summary":"用户领卡",
}
{
"card_id": "233bcbf407e87789b8e471f251774f95",
"card_template_id": "87789b2f25177433bcbf407e8e471f95",
"openid": "oUpF8uMuAJ2pxb1Q9zNjWeS6o",
"out_card_code": "6e8369071cd942c0476613f9d1ce9ca3",
"appid": "wxd678efh567hg6787",
"mchid": "1230000109",
"time_range": {
"begin_time": "2020-05-20T13:29:35.120+08:00",
"end_time": "2020-05-21T13:29:35.120+08:00"
},
"state": "ONGOING",
"create_time": "2020-05-20T13:29:35.120+08:00",
"objectives" : [
{
"unit" : "次",
"name" : "一周购买三次商品",
"count" : 1,
"description" : "特价商品",
"objective_id" : "123456"
},
{
"unit" : "次",
"name" : "一周购买三次商品",
"count" : 1,
"description" : "特价商品",
"objective_id" : "123456"
}
],
"rewards" : [
{
"unit" : "个",
"amount" : 100,
"count_type" : "COUNT_LIMIT",
"name" : "八折优惠",
"count" : 1,
"description" : "特价商品优惠",
"reward_id" : "123456",
},
{
"unit" : "个",
"amount" : 100,
"count_type" : "COUNT_LIMIT",
"name" : "八折优惠",
"count" : 1,
"description" : "特价商品优惠",
"reward_id" : "123456"
}
],
"sharer_openid" : "oUpF8uMuAJ2pxb1Q9zNjWUHsd"
}
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
先享卡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 |
创卡时间 | 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 |
接收成功:HTTP应答状态码需返回200或204,无需返回应答报文。
接收失败:HTTP应答状态码需返回5XX或4XX,同时需返回应答报文,格式如下:
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
---|---|---|---|---|
返回状态码 | code | string[1,32] | 是 | 错误码,SUCCESS为接收成功,其他错误码为失败。 示例值:FAIL |
返回信息 | message | string[1,64] | 是 | 返回信息,如非空,为错误原因。 示例值:失败 |
{
"code": "FAIL",
"message": "失败"
}