会员卡激活事件通知

更新时间:2023.11.28

注意

  • 同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。 推荐的做法是,当商户系统收到通知进行处理时,先检查对应业务数据的状态,并判断该通知是否已经处理。如果未处理,则再进行处理;如果已处理,则直接返回结果成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。
  • 如果在所有通知频率(4小时)后没有收到微信侧回调,商户应调用查询订单接口确认订单状态。

特别提醒: 商户系统对于开启结果通知的内容一定要做签名验证,并校验通知的信息是否与商户侧的信息一致,防止数据泄露导致出现“假通知”,造成资金损失。

# 接口说明

支持商户: 【普通服务商】

请求URL: 该链接是通过【设置回调地址API】提交notify_url参数设置,必须为HTTPS协议。如果链接无法访问,商户将无法接收到微信通知。 通知URL必须为直接可访问的URL,不能携带参数。示例:http://pay.weixin.qq.com/wxpay/pay.action

# 通知规则

当会员卡批次或者用户的会员卡发生变化时,微信会把相关事件结果和用户信息发送给商户,商户需要接收处理,并按照文档规范返回应答。出于安全的考虑,我们对支付结果数据进行了加密,商户需要先对通知数据进行解密,才能得到支付结果数据。

对后台通知交互时,如果微信收到应答不是成功或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。(通知频率为60s/次 - 总计11次 )

# 通知报文

会员卡事件通知是以POST方法访问商户设置的通知URL,通知的数据以JSON 格式通过请求主体(BODY)传输。通知的数据包括了加密的事件详情。

注意

由于涉及到回调加密和解密,商户必须先设置好APIv3密钥后才能解密回调通知,APIv3密钥设置文档指引详见APIv3密钥设置指引 (opens new window)

# 步骤说明

# 步骤一:验证签名

微信支付会对发送给商户的通知进行签名,并将签名值放在通知的HTTP头Wechatpay-Signature。商户应当验证签名,以确认请求来自微信,而不是其他的第三方。签名验证的算法请参考 《微信支付API v3签名验证》

# 步骤二:参数解密

为了保证安全性,微信支付在回调通知,对关键信息进行了AES-256-GCM加密。商户应当按照以下的流程进行解密关键信息,解密的流程:

  1. 用商户平台上设置的APIv3密钥【微信商户平台 (opens new window)—>账户设置—>API安全—>设置APIv3密钥】,记为key;
  2. 获取resource.algorithm中描述的算法(目前为AEAD_AES_256_GCM),以及resource.nonce和resource.associated_data;
  3. 使用key、nonce和associated_data,对数据密文resource.ciphertext进行解密,得到JSON形式的资源对象。

注意

  • AEAD_AES_256_GCM算法的接口细节,请参考rfc5116 (opens new window)。微信支付使用的密钥key长度为32个字节,随机串nonce长度12个字节,associated_data长度小于16个字节并可能为空。
  • Java回调解密Json取值不带引号。

# 字段说明

# 通知参数

  • id 必填 string(36)
    通知的唯一ID。
  • create_time 必填 string(32)
    通知创建的时间,遵循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秒。
  • event_type 必填 string(32)
    通知的类型,支付成功通知的类型为TRANSACTION.SUCCESS。
    会员卡回调通知类型,枚举值:
    MEMBERCARD.ACCEPT_CARD:领卡
    MEMBERCARD.ACTIVATE_CARD :激活
    MEMBERCARD.USERCARD_MANAGE:用户管理会员卡(查看、删卡)
  • resource_type 必填 string(32)
    通知的资源数据类型,支付成功通知为encrypt-resource。
  • resource 必填 object
    通知资源数据。
    • 属性
  • summary 必填 string(64)
    回调摘要

# 会员卡激活成功通知参数

  • event_type 必填 string(32)
    【事件类型】 业务细分事件类型,枚举值:
    MEMBER_CARD_ACTIVATE:激活会员卡
  • card_id 必填 string(32)
    【会员卡ID】 商户创建微信会员卡模板成功后系统返回的会员卡模板ID
  • code 选填 string(32)
    【会员卡code】 会员在card_id下的唯一标识,如会员卡模板code分配类型为自动分配(SYSTEM_ALLOCATE)或商家预存(MERCHANT_DEPOSIT),则不需要填写。如code分配类型为实时传入(REAL_TIME),则需要传入code
  • event_time 必填 string(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秒。
  • activate_scene 必填 string(32)
    【激活场景】 激活场景,用于区分用户新开卡激活或删卡后重新领取激活。枚举值:
    NEW_ACTIVATE:新开卡激活
    RECOVER:删卡后重新领取激活
  • openid 必填 string(128)
    【用户标识】 微信用户在AppID下的唯一标识。
  • unionid 选填 string(128)
    【用户统一标识】 微信用户在同一个微信开放平台账号下的唯一用户标识,unionid获取方式请参见《UnionID机制说明》文档。
  • outer_str 选填 string(128)
    【自定义场景值】 自定义场景值,商户可以用于标记投放场景,如门店/来源等。只能录入数字及中英文/半角标点
    自定义场景值,商户可以用于标记投放场景,如门店/来源等。只能录入数字及中英文/半角标点
    匹配正则表达式: ^[0-9a-zA-Z\u0000-\u00FF\u4e00-\u9fa5]+$

# 通知应答

接收成功: HTTP应答状态码需返回200或204,无需返回应答报文。

接收失败: HTTP应答状态码需返回5XX或4XX,同时需返回应答报文,格式如下:

    Body 包体参数
  • code 必填 string(32)
    【返回状态码】 错误码,SUCCESS为清算机构接收成功,其他错误码为失败。
  • message 选填 string(256)
    【返回信息】 返回信息,如非空,为错误原因。

# 回调示例

会员卡激活事件通知结果

1{
2 "id":"8b33f79f-8869-5ae5-b41b-3c0b59f957d0",
3 "create_time":"2020-07-13T23:27:38+08:00",
4 "resource_type":"encrypt-resource",
5 "event_type":"MEMBERCARD.ACTIVATE_CARD",
6 "summary":"会员卡激活通知",
7 "resource":{
8 "original_type":"membercard",
9 "algorithm":"AEAD_AES_256_GCM",
10 "ciphertext":"xxx",
11 "associated_data":"membercard",
12 "nonce":"j9g1wAzF9Xn1"
13 }
14}

对resource对象进行解密后,得到的资源对象示例

1{
2 "event_type":"MEMBER_CARD_ACTIVATE",
3 "event_time":"2019-12-17T10:35:53+08:00",
4 "openid":"obLatjnx9gnqzS4myYGmLZ7LgLBA",
5 "unionid":"obLatjvNtj7wO79ewoQBVIUEArg0",
6 "card_id":"paCkC00igoi8VmVpDvapnUhkN99w",
7 "code":"289560490049",
8 "outer_str":"sz_store_001"
9}

应答示例

1{
2 "code": "FAIL",
3 "message": "失败"
4}