接收签约结果通知

更新时间:2023.08.22

签约、解约成功后(包含用户主动解约),微信会把相关签约、解约信息异步通知给商户。

注意

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

特别提醒:

  1. 商户系统对于确认订单通知的内容一定要做签名验证,并校验通知的信息是否与商户侧的信息一致,防止数据泄露导致出现“假通知”,造成资金损失。
  2. 当收到通知进行处理时,首先检查对应业务数据的状态,判断该通知是否已经处理过,如果没有处理过再进行处理,如果处理过直接返回结果成功。在对业务数据进行状态检查和处理之前,要采用数据锁进行并发控制,以避免函数重入造成的数据混乱。

# 接口说明

适用对象: 普通服务商

请求URL: 该链接是通过商户提交申请资料时提交的notify_url参数,必须为HTTPS协议。如果链接无法访问,商户将无法接收到微信通知。 通知URL必须为直接可访问的URL,不能携带参数。示例:https://pay.weixin.qq.com/wxpay/pay.action

# 通知规则

签约状态变更后,微信后台会把相关确认结果和订单信息发送给商户,商户需要接收处理该消息,并返回应答。

对后台通知交互时,如果微信收到商户的应答不符合规范或超时,微信认为通知失败,微信会通过一定的策略定期重新发起通知,尽可能提高通知的成功率,但微信不保证通知最终能成功。 (通知频率为:1/60/60/60/60/60/60/60/60/60/60/300/300/300/300/300/300/300/300/300/300/(单位:秒) )

# 通知报文

签约结果通知是以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取值不带引号。

# 字段说明

# 通知参数

    Body 包体参数
  • 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年5月20日13点29分35秒。
  • event_type 必填 string(32)

    签约成功-通知类型:ENTRUST.SIGNING
    解约成功-通知类型:ENTRUST.RELEASE
    支付成功-通知类型:TRANSACTION.SUCCESS
    支付失败-通知类型:TRANSACTION.FAIL
  • resource_type 必填 string(32)
    通知的资源数据类型,确认成功通知为encrypt-resource。
  • summary 必填 string(64)
    回调摘要
  • resource 必填 object
    通知资源数据。 json格式,见示例
    • 属性

# 回调示例

1{
2 "id":"EV-2018022511223320873",
3 "create_time":"20180225112233",
4 "resource_type":"encrypt-resource",
5 "event_type":"PAYSCORE.USER_CONFIRM",
6 "resource" : {
7 "algorithm":"AEAD_AES_256_GCM",
8 "ciphertext": "...",
9 "nonce": "...",
10 "associated_data": ""
11 }
12 "summary": "签约结果通知"
13}

# 通知签名

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

# 确认订单通知参数

    Body 包体参数
  • sp_mchid 必填 string(32)
    微信支付分配的商户号
  • appid 必填 string(32)
    微信公众平台为商户的应用分配的ID,与服务商商户号存在绑定关系
  • sub_mchid 选填 string(32)
    微信支付分配的商户号,服务商商户号与子商户号存在父子关系,如果是直连商户模式接入,该字段返回为空
  • sub_appid 选填 string(32)
    微信公众平台为商户的应用分配的ID,与子商户号存在绑定关系,如果是直连商户模式接入,该字段返回为空
  • openid 选填 string(128)
    用户在服务商AppID下的唯一标识
  • sub_openid 选填 string(128)
    用户在子商户AppID下的唯一标识,如果是直连商户模式接入,该字段返回为空
  • plan_id 选填 string(32)
    签约模板号,签约模板唯一标识
  • contract_information 选填 object
    签约信息
    • 属性

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

1{
2 "sp_mchid": "1230000109",
3 "appid": "wx8888888888888888",
4 "sub_mchid": "1900000109",
5 "sub_appid": "wx8888888888888888",
6 "openid": "oUpF8uMuAJOM2pxb1Q",
7 "sub_openid": "oUpF8uMuAJOM2pxb1Q",
8 "plan_id": "101164396123311331",
9 "contract_information": {
10 "contract_id": "wx998877665544wx",
11 "contract_status": "ADD",
12 "create_time": "2020-03-26T10:43:39+08:00"
13 }
14}

# 通知应答

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

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

    Body 包体参数
  • code 必填 string(32)
    错误码,SUCCESS为接收成功,其他错误码为失败。
  • message 必填 string(64)
    返回信息,如非空,为错误原因。

# 应答示例

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