代扣解约挽留业务-获取解约挽留信息(JSON)

当用户关闭协议时，协议所关联的模板在获取范围内，则主动的获取挽留信息。

注意：

• 对后台交互时，如果微信收到应答不是成功或超时（当前是1秒的超时），微信认为获取失败，不会展示挽留信息。
• 特别提醒：商户系统对于开启结果通知的内容一定要做签名验证，并校验通知的信息是否与商户侧的信息一致，防止数据泄露导致出现“假通知”，造成资金损失。

请求参数	类型	描述
headers	object	通知的头参数
Content-Type	string	application/json
Request-ID	string	通知的唯一标识
Wechatpay-Nonce	string	数据签名使用的随机串
Wechatpay-Serial	string	平台证书序列号/平台公钥ID
Wechatpay-Signature	string	签名串
Wechatpay-Signature-Type	string	签名算法 WECHATPAY2-SHA256-RSA2048 枚举值
Wechatpay-Timestamp	string	时间戳
body	object	通知的JSON数据结构
id	string	通知的唯一ID
create_time	string	通知创建的时间
event_type	string	通知的类型 ENTRUST.TERMINATE_RETENTION 枚举值
resource_type	string	通知的资源数据类型
summary	string	回调摘要
resource	object	通知资源数据
algorithm	string	对数据进行加密的加密算法 AEAD_AES_256_GCM 枚举值
associated_data	string	数据加密的附加数据
nonce	string	加密使用的随机串
ciphertext	string	加密后的密文数据
original_type	string	原始回调类型
mchid	string	普通服务商商户号，微信支付分配的商户号
contract_id	string	委托代扣协议的主键，唯一定义此资源的标识
appid	string	商户在微信申请的公众号或移动应用AppID
plan_id	number	委托代扣协议模板ID
out_contract_code	string	商户侧的签约协议号，商户侧需保证唯一性。只能是数字、大小写字母的组合
openid	string	商户AppID下的用户唯一标识

处理程序

function webhookProcessor(\Psr\Http\Message\RequestInterface $request,
  array $platformPublicKeyMap, string $apiv3Key): array {
  if (!\count($platformPublicKeyMap)) {
    throw new \WeChatPay\Exception\InvalidArgumentException('平台证书或者平台公钥数组不能为空');
  }

  if (\strlen($apiv3Key) !== 32) {
    throw new \WeChatPay\Exception\InvalidArgumentException('APIV3密钥为32字节，长度不对');
  }

  if (!($request->hasHeader(\WeChatPay\WechatpayNonce)
    && $request->hasHeader(\WeChatPay\WechatpaySerial)
    && $request->hasHeader(\WeChatPay\WechatpaySignature)
    && $request->hasHeader(\WeChatPay\WechatpayTimestamp))) {
    throw new \WeChatPay\Exception\InvalidArgumentException('通知的头参数缺失必要参数');
  }

  // 检查通知的时间偏移量，允许5分钟之内的偏移
  [$inWechatpayTimestamp] = $request->getHeader(\WeChatPay\WechatpayTimestamp);
  if (\WeChatPay\MAXIMUM_CLOCK_OFFSET < \abs(
    \WeChatPay\Formatter::timestamp() - (int)$inWechatpayTimestamp)) {
    throw new \WeChatPay\Exception\InvalidArgumentException('通知头参数的时间偏移量超过可信阈值');
  }

  // 检查通知的平台证书/平台公钥实例是否存在
  [$inWechatpaySerial] = $request->getHeader(\WeChatPay\WechatpaySerial);
  if (!\array_key_exists($inWechatpaySerial, $platformPublicKeyMap)) {
    throw new \WeChatPay\Exception\InvalidArgumentException('通知头参数的证书序列号/公钥ID本地不存在');
  }

  // 验证通知的数据签名
  [$inWechatpaySignature] = $request->getHeader(\WeChatPay\WechatpaySignature);
  [$inWechatpayNonce] = $request->getHeader(\WeChatPay\WechatpayNonce);
  $inBody = (string)$request->getBody();
  if (!\WeChatPay\Crypto\Rsa::verify(
    \WeChatPay\Formatter::joinedByLineFeed($inWechatpayTimestamp, $inWechatpayNonce, $inBody),
    $inWechatpaySignature, $platformPublicKeyMap[$inWechatpaySerial]
  )) {
    throw new \WeChatPay\Exception\InvalidArgumentException('通知头参数的数据签名校验未通过');
  }

  // 转换通知的JSON文本消息为PHP Array数组
  $inBodyArray = (array)\json_decode($inBody, true);
  // 使用PHP7+的数据解构语法，从Array中解构并赋值变量
  ['resource' => [
    'ciphertext'      => $ciphertext,
    'nonce'           => $nonce,
    'associated_data' => $aad
  ]] = $inBodyArray;
  // 加密文本消息解密，有可能解密异常(eg: 平台探测流量)会抛 \UnexpectedValueException
  $inBodyResource = \WeChatPay\Crypto\AesGcm::decrypt($ciphertext, $apiv3Key, $nonce, $aad);
  // 把解密后的文本转换为PHP Array数组
  $inBodyResourceArray = (array)\json_decode($inBodyResource, true);
  // 把解密后的数组定义为'original_data'函数返回
  $inBodyArray['resource']['original_data'] = $inBodyResourceArray;

  return [
    'headers' => $request->getHeaders(),
    'body' => $inBodyArray
  ];
}

// do your business
// ...
// ...
$json = \json_encode([
  'code' => 'SUCCESS',
  'message' => 'OK'
]);

应答规范	类型	描述
status	number	HTTP状态码 20X 4XX 5XX 枚举值之一
body	object	应答的JSON数据结构
code	string	业务处理状态码 SUCCESS | FAIL 枚举值之一
message	string	业务处理附加信息
retention_type	string	挽留类型 COUPON 枚举值
coupon_info	object	代金券信息
state	string	状态 SEND_COUPON | UNUSED_COUPON | NOT_SEND_COUPON 枚举值
coupon_id	string	代金券ID

参阅

• 官方文档