renamed Parameters.yaml#/HTTP_WECHATPAY_SERIAL

TheNorthMemory · Dec 28, 2024 · d646f43 · d646f43
1 parent ba60090
commit d646f43
Show file tree

Hide file tree

Showing 58 changed files with 156 additions and 81 deletions.
diff --git a/docs/definitions/Parameters.yaml b/docs/definitions/Parameters.yaml
@@ -1,9 +1,9 @@
 # 对于上行有敏感信息的请求，需要设置此头参数
-WECHATPAY_CERTIFICATE_SERIAL:
+HTTP_WECHATPAY_SERIAL:
   in: header
   required: true
   name: Wechatpay-Serial
-  description: 平台公钥ID/平台公钥证书序列号
+  description: 微信支付公钥ID/平台证书序列号
   example: PUB_KEY_ID_0114232134912410000000000000
 HTTP_ACCEPT_ENCODING:
   in: header

diff --git a/docs/global/v3/customs/verify-certificate.yaml b/docs/global/v3/customs/verify-certificate.yaml
@@ -8,7 +8,7 @@ post:
   summary: 身份信息校验API
   description: 该接口用于商户上传用户身份信息，微信支付会重新校验返回订购人和支付人身份信息校验结果，用于商户纠正报关订单里的信息。 [官方文档](https://pay.weixin.qq.com/wiki/doc/api/wxpay/ch/declarecustom_ch/chapter3_2.shtml)
   parameters:
-    - $ref: '../../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true
@@ -71,10 +71,12 @@ post:
               - IDCARD
           certificate_id:
             type: string
+            format: base64
             description: 证件号
             example: '330821198809085211'
           certificate_name:
             type: string
+            format: base64
             description: 证件姓名
             example: '张三'
   responses:

diff --git a/docs/hk/v3/merchants.yaml b/docs/hk/v3/merchants.yaml
@@ -7,8 +7,8 @@ post:
   summary: 子商户进件（融合钱包）
   description: 机构提交子商户资料，微信支付系统会为每个子商户创建子商户号。 [官方文档](https://pay.weixin.qq.com/wiki/doc/api/wxpay/ch/Onborading_Sub_Merchant/chapter3_1.shtml)
   parameters:
-    - $ref: '../../definitions/Parameters.yaml#HTTP_IDEMPOTENCY_KEY'
-    - $ref: '../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../definitions/Parameters.yaml#/HTTP_IDEMPOTENCY_KEY'
+    - $ref: '../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true
@@ -56,14 +56,17 @@ post:
             properties:
               name:
                 type: string
+                format: base64
                 description: 联系人名称
                 example: 李先生
               phone:
                 type: string
+                format: base64
                 description: 联系人电话
                 example: '075586010000'
               email:
                 type: string
+                format: base64
                 description: 联系人邮箱
                 example: [email protected]
           business_category:
@@ -206,7 +209,7 @@ put:
   summary: 修改子商户（融合钱包）
   description: 用于机构子商户创建成功后，接口提供子商户信息修改 [官方文档](https://pay.weixin.qq.com/wiki/doc/api/wxpay/ch/Onborading_Sub_Merchant/chapter3_3.shtml)
   parameters:
-    - $ref: '../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true
@@ -258,14 +261,17 @@ put:
             properties:
               name:
                 type: string
+                format: base64
                 description: 联系人名称
                 example: 李先生
               phone:
                 type: string
+                format: base64
                 description: 联系人电话
                 example: '075586010000'
               email:
                 type: string
+                format: base64
                 description: 联系人邮箱
                 example: [email protected]
           business_category:

diff --git a/docs/hk/v3/merchants/{sub_mchid}.yaml b/docs/hk/v3/merchants/{sub_mchid}.yaml
@@ -67,14 +67,17 @@ get:
             properties:
               name:
                 type: string
+                format: base64
                 description: 联系人名称
                 example: Bob Zhang
               phone:
                 type: string
+                format: base64
                 description: 联系人电话
                 example: '+8613633334444'
               email:
                 type: string
+                format: base64
                 description: 联系人邮箱
                 example: [email protected]
           merchant_type:

diff --git a/docs/v2/mmpaysptrans/pay_bank.yaml b/docs/v2/mmpaysptrans/pay_bank.yaml
@@ -48,14 +48,16 @@ post:
             maxLength: 32
           enc_bank_no:
             type: string
+            format: base64
             description: 收款方银行卡号
             example: 8609cb22e1774a50a930e414cc71eca06121bcd266335cda230d24a7886a8d9f
-            maxLength: 64
+            maxLength: 384
           enc_true_name:
             type: string
+            format: base64
             description: 收款方用户名
             example: ca775af5f841bdf424b2e6eb86a6e21e
-            maxLength: 64
+            maxLength: 384
           bank_code:
             type: string
             description: 收款方开户行

diff --git a/docs/v3/apply4sub/sub_merchants/{sub_mchid}/modify-settlement.yaml b/docs/v3/apply4sub/sub_merchants/{sub_mchid}/modify-settlement.yaml
@@ -7,7 +7,7 @@ post:
   summary: 修改结算帐号API
   description: 修改结算帐号API [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/tool/applyment4sub/chapter3_3.shtml) [官方文档](https://pay.weixin.qq.com/docs/partner/apis/ecommerce-merchant-application/modify-settlement.html)
   parameters:
-    - $ref: '../../../../definitions/Parameters.yaml#/WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: sub_mchid
       in: path
       type: string

diff --git a/docs/v3/apply4subject/applyment.yaml b/docs/v3/apply4subject/applyment.yaml
@@ -6,7 +6,7 @@ post:
   summary: 提交商户开户意愿申请单API
   description: 服务商可以通过该接口向微信支付提交商户的联系人信息、主体信息以及联系人信息。 [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter10_1_1.shtml)
   parameters:
-    - $ref: '../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: channel_id
       in: query
       type: string

diff --git a/docs/v3/applyment4sub/applyment/{empty}.yaml b/docs/v3/applyment4sub/applyment/{empty}.yaml
@@ -6,7 +6,7 @@ post:
   summary: 提交申请单API
   description: 普通服务商（银行、支付机构、电商平台不可用）使用该接口提交商家资料，帮助商家入驻成为微信支付的特约商户。 [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter11_1_1.shtml)
   parameters:
-    - $ref: '../../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - in: body
       name: _
       required: true

diff --git a/docs/v3/bank-transfer/batches.yaml b/docs/v3/bank-transfer/batches.yaml
@@ -7,7 +7,7 @@ post:
   summary: 发起批量转账API
   description: 服务商可以通过该接口，批量向用户零钱或务工卡进行转账操作。 [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter4_2_1.shtml)
   parameters:
-    - $ref: '../../definitions/Parameters.yaml#/WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true

diff --git a/docs/v3/brand/profitsharing/orders.yaml b/docs/v3/brand/profitsharing/orders.yaml
@@ -7,7 +7,7 @@ post:
   summary: 请求分账API
   description: 微信订单支付成功后，由服务商发起分账请求，将结算后的资金分给分账接收方。 [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/brand/chapter3_1.shtml)
   parameters:
-    - $ref: '../../../definitions/Parameters.yaml#/WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true

diff --git a/docs/v3/capital/capitallhh/banks/search-banks-by-bank-account.yaml b/docs/v3/capital/capitallhh/banks/search-banks-by-bank-account.yaml
@@ -7,11 +7,12 @@ get:
   summary: 获取对私银行卡号开户银行API
   description: 查询对私银行卡号对应的开户银行信息（仅支持部分银行的对私银行卡） [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/Offline/apis/chapter11_2_1.shtml)
   parameters:
-    - $ref: '../../../../definitions/Parameters.yaml#/WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: account_number
       in: query
       required: true
       type: string
+      format: base64
       description: 银行卡号
       example: d+xT+MQCvrLHUVDWv/8MR/dB7TkXLVfSrUxMPZy6jWWYzpRrEEaYQE8ZRGYoeorwC+w==
   responses:

diff --git a/docs/v3/ecommerce/applyments/{empty}.yaml b/docs/v3/ecommerce/applyments/{empty}.yaml
@@ -6,7 +6,7 @@ post:
   summary: 二级商户进件API
   description: 电商平台通过提交二级商户资料，完成二级商户入驻，入驻成为微信支付商户。 [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_1_1.shtml) [官方文档](https://pay.weixin.qq.com/docs/partner/apis/ecommerce-merchant-application/applyment/submit-applyment.html)
   parameters:
-    - $ref: '../../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true

diff --git a/docs/v3/ecommerce/mch-transfer/transfer-bills.yaml b/docs/v3/ecommerce/mch-transfer/transfer-bills.yaml
@@ -7,7 +7,7 @@ post:
   summary: 发起转账
   description: 商户可通过此接口申请创建商家转账订单。[官方文档](https://pay.weixin.qq.com/docs/partner/apis/platsolution-mch-transfer/transfer-bill/transfer-to-user.html)
   parameters:
-    - $ref: ../../../definitions/Parameters.yaml#/WECHATPAY_CERTIFICATE_SERIAL
+    - $ref: ../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL
     - name: _
       in: body
       required: true

diff --git a/docs/v3/ecommerce/profitsharing/receivers/add.yaml b/docs/v3/ecommerce/profitsharing/receivers/add.yaml
@@ -6,7 +6,7 @@ post:
   summary: 添加分账接收方API
   description: 电商平台可通过此接口添加分账接收方，建立分账接收方列表。 [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/ecommerce/profitsharing/chapter3_7.shtml)
   parameters:
-    - $ref: '../../../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true
@@ -38,6 +38,7 @@ post:
             example: 张三网络公司
           encrypted_name:
             type: string
+            format: base64
             description: 接收方名称的密文
             example: hu89ohu89ohu89o
           relation_type:

diff --git a/docs/v3/ecommerce/refunds/{refund_id}/apply-abnormal-refund.yaml b/docs/v3/ecommerce/refunds/{refund_id}/apply-abnormal-refund.yaml
@@ -8,7 +8,7 @@ post:
   summary: 发起异常退款
   description: 提交退款申请后，查询退款确认状态为退款异常，可调用此接口发起异常退款处理。支持退款至用户、退款至交易商户银行账户两种处理方式。 [官方文档](https://pay.weixin.qq.com/docs/partner/apis/ecommerce-refund/refunds/create-abnormal-refund.html)
   parameters:
-    - $ref: '../../../../definitions/Parameters.yaml#/WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: refund_id
       in: path
       required: true

diff --git a/docs/v3/eduschoolpay/contracts/presign.yaml b/docs/v3/eduschoolpay/contracts/presign.yaml
@@ -7,7 +7,7 @@ post:
   summary: 预签约API
   description: 商户调用该接口可获取预签约码（presign_token），预签约码对应用户一次的签约信息，之后用户可以从商户小程序跳转到微信签约小程序时使用该预签约码进行签约。 [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3/wxpay/edu/eduschoolpay/chapter3_1.shtml)
   parameters:
-    - $ref: '../../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true
@@ -61,14 +61,17 @@ post:
             properties:
               real_name:
                 type: string
+                format: base64
                 description: 姓名
                 example: 6TqLAZvNZ4AXLNHLMbjA1yKq2k5krHM09m3tCuR
               credential_type:
                 type: string
+                format: base64
                 description: 证件类型
                 example: IDENTITY_CARD
               id_card_number:
                 type: string
+                format: base64
                 description: 身份证号
                 example: 6TqLAZvNZ4AXLNHLMbjA1yKq2k5krHM09m3tCuR
           bank_card:
@@ -79,6 +82,7 @@ post:
             properties:
               bank_card_no:
                 type: string
+                format: base64
                 description: 签约银行卡号
                 example: 6TqLAZvNZ4AXLNHLMbjA1yKq2k5krHM09m3tCuR
               valid_thru:
@@ -87,6 +91,7 @@ post:
                 example: 08/21
               phone:
                 type: string
+                format: base64
                 description: 银行卡开卡预留手机号
                 example: j6PlFRRJ4nvGSbtDZzXbXScACvDSnIny67zk3BgT5uIbK4VfGmcjPBEk2mt5ASZ6UUHB4Gy0IZpbuanF9
               bank_type:

diff --git a/docs/v3/fund-app/mch-transfer/transfer-bills.yaml b/docs/v3/fund-app/mch-transfer/transfer-bills.yaml
@@ -7,7 +7,7 @@ post:
   summary: 发起转账
   description: 商家转账用户确认模式下，用户申请收款时，商户可通过此接口申请创建转账单 [官方文档](https://pay.weixin.qq.com/docs/merchant/apis/mch-trans/transfer-bill/transfer-to-user.html)
   parameters:
-    - $ref: '../../../definitions/Parameters.yaml#/WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true
@@ -39,6 +39,7 @@ post:
             example: o-MYE42l80oelYMDE34nYD456Xoy
           user_name:
             type: string
+            format: base64
             description: 收款用户姓名
             example: 757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45
           transfer_amount:

diff --git a/docs/v3/global/customs/verify-certificate.yaml b/docs/v3/global/customs/verify-certificate.yaml
@@ -8,7 +8,7 @@ post:
   summary: 身份信息校验API
   description: 该接口用于商户上传用户身份信息，微信支付会重新校验返回订购人和支付人身份信息校验结果，用于商户纠正报关订单里的信息。 [官方文档](https://pay.weixin.qq.com/wiki/doc/api_external/ch/apis/chapter4_3_2.shtml)
   parameters:
-    - $ref: '../../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true
@@ -71,10 +71,12 @@ post:
               - IDCARD
           certificate_id:
             type: string
+            format: base64
             description: 证件号
             example: '330821198809085211'
           certificate_name:
             type: string
+            format: base64
             description: 证件姓名
             example: '张三'
   responses:

diff --git a/docs/v3/global/merchants.yaml b/docs/v3/global/merchants.yaml
@@ -7,8 +7,8 @@ post:
   summary: 子商户进件（融合钱包）
   description: 机构提交子商户资料，微信支付系统会为每个子商户创建子商户号。 [官方文档](https://pay.weixin.qq.com/wiki/doc/api_external/ch/apis/chapter4_2_1.shtml)
   parameters:
-    - $ref: '../../definitions/Parameters.yaml#HTTP_IDEMPOTENCY_KEY'
-    - $ref: '../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL'
+    - $ref: '../../definitions/Parameters.yaml#/HTTP_IDEMPOTENCY_KEY'
+    - $ref: '../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true
@@ -56,14 +56,17 @@ post:
             properties:
               name:
                 type: string
+                format: base64
                 description: 联系人名称
                 example: 李先生
               phone:
                 type: string
+                format: base64
                 description: 联系人电话
                 example: '075586010000'
               email:
                 type: string
+                format: base64
                 description: 联系人邮箱
                 example: [email protected]
           business_category:

diff --git a/docs/v3/global/merchants/{sub_mchid}.yaml b/docs/v3/global/merchants/{sub_mchid}.yaml
@@ -67,14 +67,17 @@ get:
             properties:
               name:
                 type: string
+                format: base64
                 description: 联系人名称
                 example: Bob Zhang
               phone:
                 type: string
+                format: base64
                 description: 联系人电话
                 example: '+8613633334444'
               email:
                 type: string
+                format: base64
                 description: 联系人邮箱
                 example: [email protected]
           merchant_type:
@@ -166,6 +169,7 @@ patch:
   summary: 修改子商户（融合钱包）
   description: 用于机构子商户创建成功后，接口提供子商户信息修改 [官方文档](https://pay.weixin.qq.com/wiki/doc/api_external/ch/apis/chapter4_2_3.shtml)
   parameters:
+    - $ref: '../../../definitions/Parameters.yaml#/HTTP_WECHATPAY_SERIAL'
     - name: _
       in: body
       required: true
@@ -220,14 +224,17 @@ patch:
             properties:
               name:
                 type: string
+                format: base64
                 description: 联系人名称
                 example: 李先生
               phone:
                 type: string
+                format: base64
                 description: 联系人电话
                 example: '075586010000'
               email:
                 type: string
+                format: base64
                 description: 联系人邮箱
                 example: [email protected]
           business_category:

diff --git a/docs/v3/global/profit-sharing/receivers/{account}.yaml b/docs/v3/global/profit-sharing/receivers/{account}.yaml
@@ -69,7 +69,6 @@ get:
             example: '86693852'
           name:
             type: string
-            format: base64
             description: 分账接收方全称
             example: hu89ohu89ohu89o
           relation_type: