会员卡事件通知
更新时间:2025.06.22一、回调描述
当用户的会员卡发生变化时,微信会把相关事件结果和用户信息发送给商户
|
二、回调处理步骤
1、服务商接收回调通知报文
微信支付会通过POST的方式向回调地址发送回调报文,回调通知的请求主体中会包含JSON格式的通知参数,具体的通知参数列表如下:
通知参数
id 必填 string(36)
【通知ID】通知的唯一ID。
create_time 必填 string(32)
【通知创建时间】通知创建的时间,遵循RFC3339标准格式(如:2015-05-20T13:29:35+08:00)。
event_type 必填 string(32)
【通知类型】会员卡回调通知类型,枚举值:
MEMBERCARDSP.USER_CARD.CREATE:用户开通会员卡
MEMBERCARDSP.USER_CARD.DELETE:用户删除会员卡
resource_type 必填 string(32)
【通知数据类型】通知的资源数据类型,为encrypt-resource。
resource 必填 object
【通知资源数据】通知资源数据。
属性 | |
summary 必填 string(64)
【回调摘要】回调摘要
用户开通会员卡通知
2、回调验签与应答
服务商接收到回调通知报文后,需在5秒内完成对报文的验签,并应答回调通知。
2.1、对回调通知进行验签
回调报文的HTTP请求头中会包含报文的签名信息,用于后续验签,具体如下:
参数 | 描述 |
---|---|
Wechatpay-Serial | |
Wechatpay-Signature | 验签的签名值 |
Wechatpay-Timestamp | 验签的时间戳 |
Wechatpay-Nonce | 验签的随机字符串 |
验签需使用请求头中的【Wechatpay-Timestamp】、【Wechatpay-Nonce】以及请求主体中JSON格式的通知参数构建出验签串,然后使用【Wechatpay-Serial】对应的微信支付平台证书/微信支付公钥对验签串和【Wechatpay-Signature】进行验签,确保接收的回调内容是来自微信支付。
商户可通过HTTP头"Wechatpay-Serial"中的证书序列号判断选择对应的证书验签,微信支付公钥的序列号固定采用"PUB_KEY_ID_数字串"格式(例如:PUB_KEY_ID_3000000001),若请求头中的序列号不符合该格式,则应使用平台证书进行验签。
详细验签步骤请参考:如何验证签名
微信支付会在极少数通知回调中返回以“WECHATPAY/SIGNTEST/”开头的错误【Wechatpay-Signature】,以检测商户系统是否正确验证签名。服务商请参考:如何应对签名探测流量进行处理。
签名探测流量HTTP头中的Wechatpay-Signature示例:
2.2、对回调通知进行应答
服务商验签后,根据验签结果对回调进行应答:
验签通过:服务商需告知微信支付接收回调成功,HTTP应答状态码需返回200或204,无需返回应答报文。
验签不通过:服务商需告知微信支付接收回调失败,HTTP应答状态码需返回5XX或4XX,同时需返回以下应答报文:
code 选填 string(32)
【返回状态码】服务商验签不通过时返回FAIL,代表回调接收失败。
message 选填 string(256)
【返回信息】返回信息,回调接收失败原因。
应答成功示例
200或204
应答失败示例
5XX或4XX
2.3、微信支付回调处理机制说明
微信支付接收到商户的应答后,会根据应答结果做对应的逻辑处理:
若商户应答回调接收成功,微信支付将不再重复发送该回调通知。若因网络或其他原因,商户收到了重复的回调通知,请按正常业务流程进行处理并应答。
对后台通知交互时,如果微信收到应答不是成功或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。(通知频率为每隔60秒重试一次,最多重试11次)
3、对回调通知内容进行解密
为了保证业务信息的安全性,微信支付将业务信息进行了AES-256-GCM加密,并通过参数resource将加密信息回调给服务商,服务商需要进行解密后才能获取到业务信息。
解密步骤如下:
获取服务商平台上设置的APIv3密钥,设置APIv3密钥可参考文档:APIv3密钥设置方法;
通过回调通知参数resource.algorithm确认加密算法(目前仅支持AEAD_AES_256_GCM,算法的接口细节,请参考:rfc5116)。
使用APIv3密钥与回调通知参数resource.nonce和resource.associated_data,对数据密文resource.ciphertext进行解密,最终可得到JSON格式的业务信息。
解密示例代码可参考文档:如何解密回调报文
注意
使用Java进行回调解密,取JSON串内的参数值时,只需取引号内的内容进行解密。例:"nonce":"123",只需取值123,不用取加上引号的"123"。
resource中ciphertext解密后字段
event_type 必填 string(32)
【事件类型】 业务细分事件类型。
枚举值:
MEMBERCARDSP.USER_CARD.CREATE:用户开通会员卡
MEMBERCARDSP.USER_CARD.DELETE:用户删除会员卡
event_time 必填 string(32)
【激活时间】 激活时间,遵循RFC3339标准格式(如:2015-05-20T13:29:35+08:00)。
user_card_code 选填 string(32)
【会员卡code】 会员在会员卡模板ID下的唯一标识,用户领取会员卡后获得的code。在用户开通会员卡的事件通知中,若商户选择平台生成user_card_code,则返回给商户。在用户删除会员卡事件中,若user_card_code不为空值则返回给商户。
card_id 必填 string(32)
【会员卡模板ID】 商家创建微信会员卡模板成功后系统返回的会员卡模板ID。
openid 必填 string(128)
【用户标识】 用户在品牌商家会员卡模板AppID下的唯一标识。
card_color 必填 string(7)
【卡背景颜色】 用于卡片正面设计的RGB颜色编码,带有'#'前缀的十六进制(如#FFFF00)。
card_picture_url 必填 string(512)
【卡图片】 商家自定义会员卡背景图URL。
brand_id 必填 string(32)
【品牌ID】 商家进驻微信支付品牌商家后获得的品牌ID,用于标记该会员卡的归属方。
card_type 必填 string
【会员卡类型】 标识会员卡类型。
枚举值:
PAY:付费
NORMAL:普通
BALANCE:储值
phone_number 选填 string(32)
【手机号】 注册会员的手机号码,当用户微信有绑定手机号时返回,没有时不返回。
level 选填 string(10)
【用户会员等级】 等级描述,该值由商户自定义,品牌商户可在修改用户会员卡时设置该值,该值不为空则会返回给商户。
valid_date_information 必填 object
【会员卡有效期】 会员卡有效期
属性 | |
pickup_time 必填 string(32)
【领取时间】 用户领取会员卡的时间。遵循RFC3339标准格式(如:2015-05-20T13:29:35+08:00)。
user_information 选填 object
【用户开卡时填写的个人信息】 个人信息。若商户要求用户领卡时填写个人信息,则返回给商户。
属性 | |
attach 选填 string(256)
【商家数据包】 商家在创建用户会员卡时可传入自定义数据包,该数据对用户不可见,用于存储商家自定义信息,其总长度限制在256字符以内。此接口和查询用户会员卡详情时会将此字段返回给商家。
user_card_state 必填 string(32)
【用户会员卡状态】 用户会员卡状态。
枚举值:
NOT_EFFECTIVE:已领卡(未激活)
EFFECTIVE:生效中
EXPIRE:已过期
UNAVAILABLE:已失效
invalid_reason 选填 string(256)
【作废原因】 会员卡作废时传入的原因。当商户作废会员卡时传入,则该值会返回给商户。
invalid_time 选填 string(32)
【作废时间】 会员卡作废时传入的作废时间,遵循RFC3339标准格式(如:2015-05-20T13:29:35+08:00)。当商户作废会员卡时传入,则该值会返回给商户。
对resource中ciphertext进行解密后,得到的资源对象示例