From 828c85d449b2d21ee6ce7d88188901cbdb1213d8 Mon Sep 17 00:00:00 2001 From: James ZHNAG Date: Sat, 19 Apr 2025 17:55:48 +0800 Subject: [PATCH 1/4] optim the `Rsa` code comment, switch the links by the actives --- README.md | 29 ++++++++++++++++------------- README_APIv2.md | 26 +++++++------------------- src/Crypto/Rsa.php | 5 +---- 3 files changed, 24 insertions(+), 36 deletions(-) diff --git a/README.md b/README.md index 912ac83..077f4ef 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ 项目支持的环境如下： -+ Guzzle 7.0，PHP >= 7.2.5 ++ Guzzle 7，PHP >= 7.2.5 + Guzzle 6.5，PHP >= 7.1.2 我们推荐使用目前处于 [Active Support](https://www.php.net/supported-versions.php) 阶段的 PHP 8 和 Guzzle 7。 @@ -48,7 +48,7 @@ composer require wechatpay/wechatpay ## 开始 -:information_source: 以下是 [微信支付 API v3](https://pay.weixin.qq.com/docs/merchant/development/interface-rules/introduction.html) 的指引。如果你是 API v2 的使用者，请看 [README_APIv2](README_APIv2.md)。 +:information_source: 以下是 [微信支付 API v3](https://pay.weixin.qq.com/doc/v3/merchant/4012081606) 的指引。如果你是 API v2 的使用者，请看 [README_APIv2](README_APIv2.md)。 ### 概念 @@ -78,8 +78,6 @@ require_once('vendor/autoload.php'); use WeChatPay\Builder; use WeChatPay\Crypto\Rsa; -// 设置参数 - // 商户号 $merchantId = '190000****'; @@ -94,10 +92,13 @@ $merchantCertificateSerial = '3775B6A45ACD588826D15E583A95F5DD********'; $platformCertificateFilePath = 'file:///path/to/wechatpay/certificate.pem'; $onePlatformPublicKeyInstance = Rsa::from($platformCertificateFilePath, Rsa::KEY_TYPE_PUBLIC); +// APIv3 的「平台证书」接入模式 {{{ // 「微信支付平台证书」的「平台证书序列号」 // 可以从「微信支付平台证书」文件解析，也可以在 商户平台 -> 账户中心 -> API安全 查询到 $platformCertificateSerial = '7132D72A03E93CDDF8C03BBD1F37EEDF********'; +// }}} +// APIv3 的「微信支付公钥」接入模式 {{{ // 从本地文件中加载「微信支付公钥」，用来验证微信支付应答的签名 $platformPublicKeyFilePath = 'file:///path/to/wechatpay/publickey.pem'; $twoPlatformPublicKeyInstance = Rsa::from($platformPublicKeyFilePath, Rsa::KEY_TYPE_PUBLIC); @@ -105,12 +106,14 @@ $twoPlatformPublicKeyInstance = Rsa::from($platformPublicKeyFilePath, Rsa::KEY_T // 「微信支付公钥」的「微信支付公钥ID」 // 需要在 商户平台 -> 账户中心 -> API安全 查询 $platformPublicKeyId = 'PUB_KEY_ID_01142321349124100000000000********'; +// }}} // 构造一个 APIv3 客户端实例 $instance = Builder::factory([ 'mchid' => $merchantId, 'serial' => $merchantCertificateSerial, 'privateKey' => $merchantPrivateKeyInstance, + // 根据商户号所能接入的APIv3模式(微信支付公钥/平台证书)按需配置certs对象内容 'certs' => [ $platformCertificateSerial => $onePlatformPublicKeyInstance, $platformPublicKeyId => $twoPlatformPublicKeyInstance, @@ -155,7 +158,7 @@ try { ### 同步请求 -使用客户端提供的 `get`、`put`、`post`、`patch` 或 `delete` 方法发送同步请求。以 [Native支付下单](https://pay.weixin.qq.com/docs/merchant/apis/native-payment/direct-jsons/native-prepay.html) 为例。 +使用客户端提供的 `get`、`put`、`post`、`patch` 或 `delete` 方法发送同步请求。以 [Native支付下单](https://pay.weixin.qq.com/doc/v3/merchant/4012791877) 为例。 ```php try { @@ -192,7 +195,7 @@ try { ### 异步请求 -使用客户端提供的 `getAsync`、`putAsync`、`postAsync`、`patchAsync` 或 `deleteAsync` 方法发送异步请求。以 [退款申请](https://pay.weixin.qq.com/docs/merchant/apis/native-payment/create.html) 为例。 +使用客户端提供的 `getAsync`、`putAsync`、`postAsync`、`patchAsync` 或 `deleteAsync` 方法发送异步请求。以 [退款申请](https://pay.weixin.qq.com/doc/v3/merchant/4012791883) 为例。 ```php $promise = $instance @@ -270,7 +273,7 @@ GET /v3/pay/transactions/out-trade-no/{out_trade_no} + Path 变量的值，以同名参数传入执行方法 + Query 参数，以名为 `query` 的参数传入执行方法 -以 [查询订单](https://pay.weixin.qq.com/docs/merchant/apis/native-payment/query-by-wx-trade-no.html) `GET` 方法为例： +以 [查询订单](https://pay.weixin.qq.com/doc/v3/merchant/4012791879) `GET` 方法为例： ```php $promise = $instance @@ -283,7 +286,7 @@ $promise = $instance ]); ``` -以 [关闭订单](https://pay.weixin.qq.com/docs/merchant/apis/native-payment/close-order.html) `POST` 方法为例： +以 [关闭订单](https://pay.weixin.qq.com/doc/v3/merchant/4012791881) `POST` 方法为例： ```php $promise = $instance @@ -298,7 +301,7 @@ $promise = $instance ## 更多例子 -### [视频文件上传](https://pay.weixin.qq.com/docs/partner/apis/contracted-merchant-application/video-upload.html) +### [视频文件上传](https://pay.weixin.qq.com/doc/v3/partner/4012761084) ```php // 参考上述指引说明，并引入 `MediaUtil` 正常初始化，无额外条件 @@ -316,7 +319,7 @@ $resp = $instance- ]); ``` -### [营销图片上传](https://pay.weixin.qq.com/docs/partner/apis/cash-coupons/upload-image.html) +### [营销图片上传](https://pay.weixin.qq.com/doc/v3/partner/4012759802) ```php use WeChatPay\Util\MediaUtil; @@ -338,7 +341,7 @@ $resp = $instance + 微信支付要求加密上送的敏感信息 + 微信支付会加密下行的敏感信息 -下面以 [特约商户进件](https://pay.weixin.qq.com/docs/partner/apis/contracted-merchant-application/applyment/submit.html) 为例，演示如何进行 [敏感信息加解密](https://pay.weixin.qq.com/docs/partner/development/interface-rules/sensitive-data-encryption.html)。 +下面以 [特约商户进件](https://pay.weixin.qq.com/doc/v3/partner/4012719997) 为例，演示如何进行 [敏感信息加解密](https://pay.weixin.qq.com/doc/v3/partner/4013059053)。 ```php use WeChatPay\Crypto\Rsa; @@ -369,7 +372,7 @@ $resp = $instance ## 签名 -你可以使用 `Rsa::sign()` 计算调起支付时所需参数签名。以 [JSAPI支付](https://pay.weixin.qq.com/docs/merchant/apis/jsapi-payment/jsapi-transfer-payment.html) 为例。 +你可以使用 `Rsa::sign()` 计算调起支付时所需参数签名。以 [JSAPI支付](https://pay.weixin.qq.com/doc/v3/merchant/4012791857) 为例。 ```php use WeChatPay\Formatter; @@ -399,7 +402,7 @@ echo json_encode($params); 1. 从请求头部`Headers`，拿到`Wechatpay-Signature`、`Wechatpay-Nonce`、`Wechatpay-Timestamp`、`Wechatpay-Serial`及`Request-ID`，商户侧`Web`解决方案可能有差异，请求头可能大小写不敏感，请根据自身应用来定； 2. 获取请求`body`体的`JSON`纯文本； 3. 检查通知消息头标记的`Wechatpay-Timestamp`偏移量是否在5分钟之内； -4. 调用`SDK`内置方法，[构造验签名串](https://pay.weixin.qq.com/docs/merchant/development/verify-signature-overview/overview-signature-and-verification.html) 然后经`Rsa::verfify`验签； +4. 调用`SDK`内置方法，[构造验签名串](https://pay.weixin.qq.com/doc/v3/merchant/4012365342) 然后经`Rsa::verfify`验签； 5. 消息体需要解密的，调用`SDK`内置方法解密； 6. 如遇到问题，请拿`Request-ID`点击[这里](https://support.pay.weixin.qq.com/online-service?utm_source=github&utm_medium=wechatpay-php&utm_content=apiv3)，联系官方在线技术支持； diff --git a/README_APIv2.md b/README_APIv2.md index 63dabc6..3bb5286 100644 --- a/README_APIv2.md +++ b/README_APIv2.md @@ -44,9 +44,7 @@ $instance = Builder::factory([ **注：** `APIv3`, `APIv2` 以及 `GuzzleHttp\Client` 的 `$config = []` 初始化参数，均融合在一个型参上。 -## 企业付款到零钱 - -[官方开发文档地址](https://pay.weixin.qq.com/wiki/doc/api/tools/mch_pay.php?chapter=14_2) +## [企业付款到零钱](https://pay.weixin.qq.com/doc/v2/merchant/4011989673) ```php use WeChatPay\Transformer; @@ -86,9 +84,7 @@ print_r($res); - `$options['nonceless']` - 标量 `scalar` 任意值，语义上即，本次请求不用自动添加`nonce_str`参数，推荐 `boolean(True)` - `$options['security']` - 布尔量`True`，语义上即，本次请求需要加载ssl证书，对应的是初始化 `array $config['merchant']` 结构体 -## 企业付款到银行卡-获取RSA公钥 - -[官方开发文档地址](https://pay.weixin.qq.com/wiki/doc/api/tools/mch_pay_yhk.php?chapter=24_7&index=4) +## [企业付款到银行卡-获取RSA公钥](https://pay.weixin.qq.com/doc/v2/merchant/4011941097) ```php use WeChatPay\Transformer; @@ -110,9 +106,7 @@ $res = $instance print_r($res); ``` -## 付款到银行卡 - -[官方开发文档地址](https://pay.weixin.qq.com/wiki/doc/api/tools/mch_pay_yhk.php?chapter=24_2) +## [付款到银行卡](https://pay.weixin.qq.com/doc/v2/merchant/4011939840) ```php use WeChatPay\Transformer; @@ -177,9 +171,7 @@ $res = $instance print_r($res); ``` -## v2沙箱环境-获取验签密钥API - -[官方开发文档地址](https://pay.weixin.qq.com/wiki/doc/api/tools/sp_coupon.php?chapter=23_1&index=2) +## [v2沙箱环境-获取验签密钥API](https://pay.weixin.qq.com/doc/v2/merchant/4011984810) ```php use WeChatPay\Transformer; @@ -214,9 +206,7 @@ echo $xml; ## 数据签名 -### 商家券-小程序发券APIv2密钥签名 - -[官方开发文档地址](https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_3_1.shtml) +### [商家券-小程序发券APIv2密钥签名](https://pay.weixin.qq.com/doc/v3/merchant/4012285674) ```php use WeChatPay\Formatter; @@ -252,9 +242,7 @@ $busiFavor += ['sign' => Hash::sign( echo json_encode($busiFavor); ``` -### 商家券-H5发券APIv2密钥签名 - -[官方开发文档地址](https://pay.weixin.qq.com/wiki/doc/apiv3/apis/chapter9_4_1.shtml) +### [商家券-H5发券APIv2密钥签名](https://pay.weixin.qq.com/doc/v3/merchant/4012285783) ```php use WeChatPay\Formatter; @@ -285,7 +273,7 @@ echo json_encode($params); 1. 从请求头`Headers`获取`Request-ID`，商户侧`Web`解决方案可能有差异，请求头的`Request-ID`可能大小写不敏感，请根据自身应用来定； 2. 获取请求`body`体的`XML`纯文本； -3. 调用`SDK`内置方法，根据[签名算法](https://pay.weixin.qq.com/wiki/doc/api/jsapi.php?chapter=4_3)做本地数据签名计算，然后与通知文本的`sign`做`Hash::equals`对比验签； +3. 调用`SDK`内置方法，根据[签名算法](https://pay.weixin.qq.com/doc/v2/merchant/4011985891)做本地数据签名计算，然后与通知文本的`sign`做`Hash::equals`对比验签； 4. 消息体需要解密的，调用`SDK`内置方法解密； 5. 如遇到问题，请拿`Request-ID`点击[这里](https://support.pay.weixin.qq.com/online-service?utm_source=github&utm_medium=wechatpay-php&utm_content=apiv2)，联系官方在线技术支持； diff --git a/src/Crypto/Rsa.php b/src/Crypto/Rsa.php index 2003164..bcfb771 100644 --- a/src/Crypto/Rsa.php +++ b/src/Crypto/Rsa.php @@ -105,7 +105,6 @@ public static function pkcs1ToSpki(string $thing): string * * @param string $thing - The string in `PKCS#8` format. * @return \OpenSSLAsymmetricKey|resource|mixed - * @throws UnexpectedValueException */ public static function fromPkcs8( #[\SensitiveParameter] @@ -121,7 +120,6 @@ public static function fromPkcs8( * @param string $thing - The string in `PKCS#1` format. * @param string $type - Either `self::KEY_TYPE_PUBLIC` or `self::KEY_TYPE_PRIVATE` string, default is `self::KEY_TYPE_PRIVATE`. * @return \OpenSSLAsymmetricKey|resource|mixed - * @throws UnexpectedValueException */ public static function fromPkcs1( #[\SensitiveParameter] @@ -137,7 +135,6 @@ public static function fromPkcs1( * * @param string $thing - The string in `SKPI` format. * @return \OpenSSLAsymmetricKey|resource|mixed - * @throws UnexpectedValueException */ public static function fromSpki(string $thing) { @@ -253,7 +250,7 @@ private static function parse( /** * Check the padding mode whether or nor supported. * - * @param int $padding - The padding mode, only support `OPENSSL_PKCS1_PADDING`, otherwise thrown `\UnexpectedValueException`. + * @param int $padding - The padding mode, only support the `OPENSSL_PKCS1_OAEP_PADDING` mode, otherwise thrown `\UnexpectedValueException`. * * @throws UnexpectedValueException */ From ce131362a0e55c4898ffa9e902861ffecae09f57 Mon Sep 17 00:00:00 2001 From: James ZHNAG Date: Thu, 20 Nov 2025 13:11:52 +0800 Subject: [PATCH 2/4] PHP8.5 support --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 85fddd5..fd9eead 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,7 +11,7 @@ jobs: strategy: fail-fast: false matrix: - php-version: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4'] + php-version: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4', '8.5'] os: [ubuntu-latest, macOS-latest, windows-latest] runs-on: ${{ matrix.os }} steps: @@ -90,7 +90,7 @@ jobs: id: phpstan-php-8_2-8_3 - run: vendor/bin/phpstan analyse --no-progress --memory-limit=-1 -c phpstan.v8.4.neon - if: matrix.php-version == '8.4' + if: matrix.php-version >= '8.4' id: phpstan-php-8_4 - run: | From 61b17cc12700a6af117dbc68fec5e8b21e80e9d2 Mon Sep 17 00:00:00 2001 From: James ZHNAG Date: Fri, 21 Nov 2025 10:30:37 +0800 Subject: [PATCH 3/4] bump to v1.4.13 --- CHANGELOG.md | 7 ++++++- README.md | 2 +- composer.json | 2 +- src/ClientDecoratorInterface.php | 2 +- 4 files changed, 9 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4c9563f..b18274c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,11 @@ # 变更历史 -## [1.4.12](../../compare/v1.4.11...v1.4.12) - 2025-01-27 +## [1.4.13](../../compare/v1.4.12...v1.4.13) - 2025-11-21 + +- 优化代码注释； +- 支持PHP8.5运行时； + +## [1.4.12](../../compare/v1.4.11...v1.4.12) - 2025-01-26 - 修正`APIv2`特殊`GET`请求抛异常问题，相关记录见[这里](https://github.com/wechatpay-apiv3/wechatpay-php/issues/146)。 diff --git a/README.md b/README.md index 077f4ef..ad6da7a 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ ## 项目状态 -当前版本为 `1.4.12` 版。 +当前版本为 `1.4.13` 版。 项目版本遵循 [语义化版本号](https://semver.org/lang/zh-CN/)。 如果你使用的版本 `<=v1.3.2`，升级前请参考 [升级指南](UPGRADING.md)。 diff --git a/composer.json b/composer.json index cb281cc..842395c 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,6 @@ { "name": "wechatpay/wechatpay", - "version": "1.4.12", + "version": "1.4.13", "description": "[A]Sync Chainable WeChatPay v2&v3's OpenAPI SDK for PHP", "type": "library", "keywords": [ diff --git a/src/ClientDecoratorInterface.php b/src/ClientDecoratorInterface.php index 7f0ec23..d0649a9 100644 --- a/src/ClientDecoratorInterface.php +++ b/src/ClientDecoratorInterface.php @@ -14,7 +14,7 @@ interface ClientDecoratorInterface /** * @var string - This library version */ - public const VERSION = '1.4.12'; + public const VERSION = '1.4.13'; /** * @var string - The HTTP transfer `xml` based protocol From 8c36c3c1870267915859b35c822d916b426a5e70 Mon Sep 17 00:00:00 2001 From: James ZHNAG Date: Mon, 29 Dec 2025 18:23:50 +0800 Subject: [PATCH 4/4] refresh the changelog, ref wechatpay-apiv3/wechatpay-php#156 --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b18274c..ec6a4a0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,10 @@ # 变更历史 -## [1.4.13](../../compare/v1.4.12...v1.4.13) - 2025-11-21 +## [1.4.13](../../compare/v1.4.12...v1.4.13) - 2025-12-31 - 优化代码注释； - 支持PHP8.5运行时； +- 修正`APIv2`提交及查询「企业付款到银行卡」接口(内置的无返回值数据签名)URL错误问题； ## [1.4.12](../../compare/v1.4.11...v1.4.12) - 2025-01-26