领卡事件通知
更新时间:2026.01.13
|
接口说明
适用对象: 服务商
请求URL:该链接是通过【设置回调地址API】提交notify_url参数设置,必须为https协议。如果链接无法访问,商户将无法接收到微信通知。 通知url必须为直接可访问的url,不能携带参数。示例:“http://pay.weixin.qq.com/wxpay/pay.action”
通知规则
当会员卡批次或者用户的会员卡发生变化时,微信会把相关事件结果和用户信息发送给商户,商户需要接收处理,并按照文档规范返回应答。出于安全的考虑,我们对支付结果数据进行了加密,商户需要先对通知数据进行解密,才能得到支付结果数据。
对后台通知交互时,如果微信收到应答不是成功或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。(通知频率为60s/次 - 总计11次 )
通知报文
会员卡事件通知是以POST 方法访问商户设置的通知url,通知的数据以JSON 格式通过请求主体(BODY)传输。通知的数据包括了加密的事件详情。
下面详细描述对通知数据进行解密的流程:
1、用商户平台上设置的APIv3密钥【微信商户平台—>账户设置—>API安全—>设置APIv3密钥】,记为key。
2、针对resource.algorithm中描述的算法(目前为AEAD_AES_256_GCM),取得对应的参数nonce和associated_data。
3、使用key、nonce和associated_data,对数据密文resource.ciphertext进行解密,得到JSON形式的资源对象。
注: AEAD_AES_256_GCM算法的接口细节,请参考rfc5116。微信支付使用的密钥key长度为32个字节,随机串nonce长度12个字节,associated_data长度小于16个字节并可能为空。
通知参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 | |||
|---|---|---|---|---|---|---|---|
通知ID | id | string[1,32] | 是 | 通知的唯一id。 | |||
通知创建时间 | create_time | string[1,16] | 是 | 通知创建的时间,遵循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年5月20日13点29分35秒。 | |||
通知类型 | event_type | string[1,32] | 是 | 券的回调通知类型,枚举值: | |||
通知数据类型 | resource_type | string[1,32] | 是 | 通知的资源数据类型,券的回调通知为encrypt-resource。 | |||
回调摘要 | summary | string[1,64] | 是 | 回调摘要 | |||
通知数据 | resource | object | 是 | 通知资源数据。 | |||
| |||||||
通知签名
加密不能保证通知请求来自微信。微信会对发送给商户的通知进行签名,并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名,以确认请求来自微信,而不是其他的第三方。签名验证的算法请参考 《微信支付API v3签名验证》。
回调示例
领卡事件通知结果
商户对resource对象进行解密后,得到的资源对象示例
领券成功通知参数
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
事件类型 | event_type | string[1,32] | 是 | 业务细分事件类型,枚举值: |
会员卡id | card_id | string[1, 32] | 是 | 商户创建微信会员卡模板成功后系统返回的会员卡模板id |
会员卡code | code | string[1, 32] | 否 | 会员在card_id下的唯一标识,如会员卡模板code分配类型为自动分配(SYSTEM_ALLOCATE)或商家预存(MERCHANT_DEPOSIT),则不需要填写。如code分配类型为实时传入(REAL_TIME),则需要传入code |
会员卡领取时间 | event_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小时,即北京时间)。 例如:2020-05-20T13:29:35.120+08:00表示北京时间2020年05月20日13点29分35秒。 |
用户标识 | openid | string[1, 128] | 是 | 微信用户在appid下的唯一标识。 |
用户统一标识 | unionid | string[1, 128] | 否 | 微信用户在同一个微信开放平台账号下的唯一用户标识,unionid获取方式请参见《UnionID机制说明》文档。 |
手机号 | phone_number | string[1,512] | 是 | 注册会员的手机号码 |
自定义场景值 | outer_str | string[1,128] | 否 | 自定义场景值,商户可以用于标记投放场景,如门店/来源等。只能录入数字及中英文/半角标点 |
通知应答
接收成功:HTTP应答状态码需返回200或204,无需返回应答报文。
接收失败:HTTP应答状态码需返回5XX或4XX,同时需返回应答报文,格式如下:
参数名 | 变量 | 类型[长度限制] | 必填 | 描述 |
|---|---|---|---|---|
返回状态码 | code | string[1,32] | 是 | 错误码,SUCCESS为接收成功,其他错误码为失败。 |
返回信息 | message | string[1,64] | 是 | 返回信息,如非空,为错误原因。 |
文档反馈

