From 01566b4df8c001ba41b1faca8dec3c39f574b544 Mon Sep 17 00:00:00 2001 From: James ZHNAG Date: Thu, 21 Nov 2024 22:27:47 +0800 Subject: [PATCH] optim: `docs/{v2,v3}/*.yaml` --- docs/v2/face/get_wxpayface_authinfo.yaml | 11 ++++++++--- docs/v3/mch_operate/risk/withdrawl-apply.yaml | 19 ++++++++++--------- docs/v3/merchant-service/complaints-v2.yaml | 4 ++++ .../complaints-v2/{complaint_id}.yaml | 7 +++++-- 4 files changed, 27 insertions(+), 14 deletions(-) diff --git a/docs/v2/face/get_wxpayface_authinfo.yaml b/docs/v2/face/get_wxpayface_authinfo.yaml index 16add409..c4aafbfa 100644 --- a/docs/v2/face/get_wxpayface_authinfo.yaml +++ b/docs/v2/face/get_wxpayface_authinfo.yaml @@ -3,7 +3,7 @@ post: tags: - APIv2∙人脸支付 summary: 人脸识别SDK-获取调用凭证 - description: '[官方文档](https://pay.weixin.qq.com/wiki/doc/wxfacepay/develop/android/faceuser.html)' + description: '人脸识别通过识别用户人脸，获取用户信息（openid）。此功能常用于商户会员、商品推荐等场景， 此流程无法用于支付。FACEID-ONCE为直接启动人脸识别流程。[官方文档](https://pay.weixin.qq.com/wiki/doc/wxfacepay/develop/android/faceuser.html)' consumes: - application/xml produces: @@ -78,11 +78,11 @@ post: example: 1239878956 version: type: string - maxLength: 版本号。固定为1 + description: 版本号。固定为1 example: '1' sign_type: type: string - maxLength: 签名类型，目前支持HMAC-SHA256和MD5，默认为MD5 + description: 签名类型 example: MD5 enum: - MD5 @@ -123,6 +123,11 @@ post: name: xml required: - authinfo + - nonce_str + - sign + - appid + - mch_id + - sub_mch_id properties: authinfo: type: string diff --git a/docs/v3/mch_operate/risk/withdrawl-apply.yaml b/docs/v3/mch_operate/risk/withdrawl-apply.yaml index 3031ff43..b49fb5b9 100644 --- a/docs/v3/mch_operate/risk/withdrawl-apply.yaml +++ b/docs/v3/mch_operate/risk/withdrawl-apply.yaml @@ -1,11 +1,11 @@ post: - x-last-updated-at: 2022.12.01 + x-last-updated-at: 2023.08.21 x-role: - 服务商 tags: - 收付通∙提现 summary: 提交已注销商户号可用余额提现申请单API - description: 针对被微信支付平台不收不付管控的电商子商户，如子商户账户内还有可用余额，且无法解脱（例如.营业执照注销吊销），则服务商可为子商户申请走注销提现的流程，将可用余额进行提现操作。在商户号注销后，电商平台可发起提现申请, 审批通过后, 将会按照指定的收款方式返回给商户。 [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_8_9.shtml) + description: 针对被微信支付平台不收不付管控的电商子商户，如子商户账户内还有可用余额，且无法解脱（例如.营业执照注销吊销），则服务商可为子商户申请走注销提现的流程，将可用余额进行提现操作。在商户号注销后，电商平台可发起提现申请, 审批通过后, 将会按照指定的收款方式返回给商户。[官方文档](https://pay.weixin.qq.com/docs/partner/apis/withdrawal-apply/withdrawal-apply/submit-apply.html) [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter7_8_9.shtml) parameters: - $ref: '../../../definitions/Parameters.yaml#WECHATPAY_CERTIFICATE_SERIAL' - name: _ @@ -67,7 +67,7 @@ post: type: string format: base64 description: 开户名称 - example: AOZdYGISxo4y44/UgZ69bdu9X+tfMUJ9dl+LetjM45/zMbrYu+wWZ8gn4CTdo+D/m9MrPg+V4sm73oxqdQu/hj7aWyDl4GQtPXVdaztB9jVbVZh3QFzV+BEmytMNQp9dt1uWJktlfdDdLR3AMWyMB377xd+m9bSr/ioDTzagEcGe+vLYiKrzcroQv3OR0p3ppFYoQ3IfYeU/04S4t9rNFL+kyblK2FCCqQ11NdbbHoCrJc7NV4oASq6ZFonjTtgjjgKsadIKHXtb3JZKGZjduGdtkRJJp0/0eow96uY1Pk7Rq79Jtt7+I8juwEc4P4TG5xzchG/5IL9DBd+Z0zZXkw== + example: AOZdYGISxo4y44/UgZ69b0zZXkw== account_bank: type: string description: 开户银行 @@ -84,7 +84,7 @@ post: type: string format: base64 description: 银行账号 - example: d+xT+MQCvrLHUVDWv/8MR/dB7TkXM2YYZlokmXzFsWs35NXUot7C0NcxIrUF5FnxqCJHkNgKtxa6RxEYyba1+VBRLnqKG2fSy/Y5qDN08Ej9zHCwJjq52Wg1VG8MRugli9YMI1fI83KGBxhuXyemgS/hqFKsfYGiOkJqjTUpgY5VqjtL2N4l4z11T0ECB/aSyVXUysOFGLVfSrUxMPZy6jWWYGvT1+4P633f+R+ki1gT4WF/2KxZOYmli385ZgVhcR30mr4/G3HBcxi13zp7FnEeOsLlvBmI1PHN4C7Rsu3WL8sPndjXTd75kPkyjqnoMRrEEaYQE8ZRGYoeorwC+w== + example: d+xT+MQCvrLHeorwC+w== identity_info: type: object description: 收款人账号对应的证件信息 @@ -100,12 +100,12 @@ post: type: string format: base64 description: 证件姓名 - example: pVd1HJ6zyvPedzGaV+X3qtmrq9bb9tPROvwia4ibL+F6mfjbzQIzfb3HHLEjZ4YiR/cJiCrZxnAqi+pjeKIEdkwzXRAI7FUhrfPK3SNjaBTEu9GmsugMIA9r3x887Q+ODuC8HH2nzAn7NGpE/e3yiHgWhk0ps5k5DP/2qIdGdONoDzZelrxCl/NWWNUyB93K9F+jC1JX2IMttdY+aQ6zBlw0xnOiNW6Hzy7UtC+xriudjD5APomty7/mYNxLMpRSvWKIjOv/69bDnuC4EL5Kz4jBHLiCyOb+tI0m2qhZ9evAM+Jv1z0NVa8MRtelw/wDa4SzfeespQO/0kjiwfqdfg== + example: pVd1HJ6zyvPedzfg== identification_no: type: string format: base64 description: 证件号码 - example: AOZdYGISxo4y44/UgZ69bdu9X+tfMUJ9dl+LetjM45/zMbrYu+wWZ8gn4CTdo+D/m9MrPg+V4sm73oxqdQu/hj7aWyDl4GQtPXVdaztB9jVbVZh3QFzV+BEmytMNQp9dt1uWJktlfdDdLR3AMWyMB377xd+m9bSr/ioDTzagEcGe+vLYiKrzcroQv3OR0p3ppFYoQ3IfYeU/04S4t9rNFL+kyblK2FCCqQ11NdbbHoCrJc7NV4oASq6ZFonjTtgjjgKsadIKHXtb3JZKGZjduGdtkRJJp0/0eow96uY1Pk7Rq79Jtt7+I8juwEc4P4TG5xzchG/5IL9DBd+Z0zZXkw== + example: AOZdYGISxo4y44/UgZ69bkw== proof_media_list: type: object description: 付款申请证明材料 @@ -127,18 +127,19 @@ post: type: string format: MediaId description: 证明材料照片 - example: jTpGmxUX3FBWVQ5NJTZvlKX_gdU4cRz7z5NxpnFuAxhBTEO_PvWkfSCJ3zVIn001D8daLC-ehEuo0BJqRTvDujqhThn4ReFxikqJ5YW6zFQ + example: jTpGmxUX3FBWVQ5NJTZvlKXQ additional_materials: type: object description: 补充材料 properties: additional_media: type: array - description: 补充材料照片 + description: 补充材料照片列表，最多10张 items: type: string + description: 照片MediaID format: MediaId - example: jTpGmxUX3FBWVQ5NJTZvlKX_gdU4cRz7z5NxpnFuAxhBTEO_PvWkfSCJ3zVIn001D8daLC-ehEuo0BJqRTvDujqhThn4ReFxikqJ5YW6zFQ + example: jTpGmxUX3FBWVQ5NFQ remark: type: string description: 备注 diff --git a/docs/v3/merchant-service/complaints-v2.yaml b/docs/v3/merchant-service/complaints-v2.yaml index 12bf9093..c4f8f7b7 100644 --- a/docs/v3/merchant-service/complaints-v2.yaml +++ b/docs/v3/merchant-service/complaints-v2.yaml @@ -136,11 +136,15 @@ get: type: string description: 媒体文件业务类型 example: USER_COMPLAINT_IMAGE + enum: + - USER_COMPLAINT_IMAGE + - OPERATION_IMAGE media_url: type: array description: 媒体文列表 items: type: string + description: 媒体文件URL example: https://api.mch.weixin.qq.com/v3/merchant-service/images/xxxxx complaint_full_refunded: type: boolean diff --git a/docs/v3/merchant-service/complaints-v2/{complaint_id}.yaml b/docs/v3/merchant-service/complaints-v2/{complaint_id}.yaml index 833a14f3..3434df4b 100644 --- a/docs/v3/merchant-service/complaints-v2/{complaint_id}.yaml +++ b/docs/v3/merchant-service/complaints-v2/{complaint_id}.yaml @@ -7,7 +7,7 @@ get: tags: - 风险合规∙消费者投诉 summary: 查询投诉单详情API - description: 商户可通过调用此接口，查询指定投诉单的用户投诉详情，包含投诉内容、投诉关联订单、投诉人联系方式等信息，方便商户处理投诉。 [官方文档](https://pay.weixin.qq.com/docs/partner/apis/consumer-complaint/complaints/query-complaint-v2.html) [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter10_2_13.shtml) + description: 商户可通过调用此接口，查询指定投诉单的用户投诉详情，包含投诉内容、投诉关联订单、投诉人联系方式等信息，方便商户处理投诉。 [官方文档](https://pay.weixin.qq.com/docs/merchant/apis/consumer-complaint/complaints/query-complaint-v2.html) [官方文档](https://pay.weixin.qq.com/docs/partner/apis/consumer-complaint/complaints/query-complaint-v2.html) [官方文档](https://pay.weixin.qq.com/wiki/doc/apiv3_partner/apis/chapter10_2_13.shtml) parameters: - name: complaint_id in: path @@ -70,11 +70,15 @@ get: type: string description: 媒体文件业务类型 example: USER_COMPLAINT_IMAGE + enum: + - USER_COMPLAINT_IMAGE + - OPERATION_IMAGE media_url: type: array description: 媒体文列表 items: type: string + description: 媒体文件URL example: https://api.mch.weixin.qq.com/v3/merchant-service/images/xxxxx complaint_order_info: type: array @@ -161,7 +165,6 @@ get: return_address_info: type: object description: 归还地点信息 - required: [] properties: return_address: type: string