wechatpay.im

主题模式

签约成功通知(JSON) ​

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

注意：

  • 同样的通知可能会多次发送给商户系统。商户系统必须能够正确处理重复的通知。 推荐的做法是，当商户系统收到通知进行处理时，先检查对应业务数据的状态，并判断该通知是否已经处理。如果未处理，则再进行处理；如果已处理，则直接返回结果成功。在对业务数据进行状态检查和处理之前，要采用数据锁进行并发控制，以避免函数重入造成的数据混乱。
  • 如果在所有通知频率后没有收到微信侧回调，商户应调用查询订单接口确认订单状态。
  • 特别提醒：商户系统对于开启结果通知的内容一定要做签名验证，并校验通知的信息是否与商户侧的信息一致，防止数据泄露导致出现“假通知”，造成资金损失。
  • 对后台通知交互时，如果微信收到商户的应答不符合规范或超时，微信认为通知失败，微信会通过一定的策略定期重新发起通知，尽可能提高通知的成功率，但微信不保证通知最终能成功。（通知频率为15s/15s/30s/3m/10m/20m/30m/30m/30m/60m/3h/3h/3h/6h/6h - 总计 24h4m）
请求参数类型描述
headersobject通知的头参数
Content-Typestringapplication/json
Request-IDstring通知的唯一标识
Wechatpay-Noncestring数据签名使用的随机串
Wechatpay-Serialstring平台证书序列号/平台公钥ID
Wechatpay-Signaturestring签名串
Wechatpay-Signature-Typestring签名算法
WECHATPAY2-SHA256-RSA2048 枚举值
Wechatpay-Timestampstring时间戳
bodyobject通知的JSON数据结构
idstring通知的唯一ID
create_timestring通知创建的时间
event_typestring通知的类型
ENTRUST.SIGNING 枚举值
resource_typestring通知的资源数据类型
summarystring回调摘要
resourceobject通知资源数据
algorithmstring对数据进行加密的加密算法
AEAD_AES_256_GCM 枚举值
associated_datastring数据加密的附加数据
noncestring加密使用的随机串
ciphertextstring加密后的密文数据
original_typestring原始回调类型
appidstring微信公众平台为商户的应用分配的ID，与服务商商户号存在绑定关系
openidstring用户在服务商AppID下的唯一标识
plan_idstring签约模板号，签约模板唯一标识
contract_informationobject签约信息
contract_idstring标识用户与某签约模板的一次签约，具有唯一性
contract_statusstring枚举值：
ADD：签约
DELETE：解约
create_timestring签约完成时间
out_trade_nostring商户订单号
transaction_idstring微信支付订单号
attachstring附加数据，在查询API和支付通知中原样返回，该字段主要用于商户携带订单的自定义数据
bank_typestring银行类型，采用字符串类型的银行标识
success_timestring支付成功时返回
trade_statestring枚举值：
SUCCESS：支付成功
REFUND：转入退款
ACCEPTED：已受理，未支付
PAY_FAIL：支付失败(其他原因，如银行返回失败)
trade_state_descriptionstring对当前订单状态的描述和下一步操作的指引
payerobject支付者
openidstring用户在服务商AppID下的唯一标识
sub_openidstring用户在子商户AppID下的唯一标识，如果是直连商户模式接入，该字段返回为空
amountobject订单金额信息
totalnumber订单总金额，单位为分，只能为整数
payer_totalnumber用户实际支付金额，单位为分，只能为整数
discount_totalnumber订单折扣
currencystring符合ISO 4217标准的三位字母代码，目前只支持人民币：CNY
device_informationobject设备信息
device_idstring商户设备号
payer_totalstring商户端设备IP（发起扣款请求的商户服务器IP）
promotion_detailobject[]优惠详情
coupon_idstring券ID
namestring优惠名称
scopestring枚举值：
GLOBAL：全场代金券
SINGLE：单品优惠
typestring枚举值：
COUPON：代金券，需要走结算资金的充值型代金券,（境外商户券币种与支付币种一致）
DISCOUNT：优惠券，不走结算资金的免充值型优惠券，（境外商户券币种与标价币种一致）
amountnumber优惠券面额
stock_idstring活动ID，批次ID
wechatpay_contributenumber特指由微信支付商户平台创建的优惠，出资金额等于本项优惠总金额，单位为分
merchant_contributenumber特指商户自己创建的优惠，出资金额等于本项优惠总金额，单位为分
other_contributenumber其他出资方出资金额，单位为分
sp_mchidstring微信支付分配的商户号
sub_mchidstring微信支付分配的商户号，服务商商户号与子商户号存在父子关系，如果是直连商户模式接入，该字段返回为空
sub_appidstring微信公众平台为商户的应用分配的ID，与子商户号存在绑定关系，如果是直连商户模式接入，该字段返回为空
sub_openidstring用户在子商户AppID下的唯一标识，如果是直连商户模式接入，该字段返回为空
php
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'
]);
应答规范类型描述
statusnumberHTTP状态码
20X 4XX 5XX 枚举值之一
bodyobject应答的JSON数据结构
codestring业务处理状态码
SUCCESS | FAIL 枚举值之一
messagestring业务处理附加信息

参阅

Published on the GitHub by TheNorthMemory