商家转账用户确认模式

TheNorthMemory · Oct 17, 2024 · 5cd0c1d · 5cd0c1d
1 parent e4017ce
commit 5cd0c1d
Show file tree

Hide file tree

Showing 24 changed files with 833 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -22,6 +22,7 @@
 | 免密支付 | ✔️ | ✔️ |
 | 资金应用∙分账 | | ✔️ |
 | 资金应用∙转账 | ✔️ | |
+| 资金应用∙转账∙用户确认模式 | ✔️ | |
 | 资金应用∙转账∙服务商模式 | | ✔️ |
 | 资金应用∙转账∙银行模式 | | ✔️ |
 | 收付通∙进件 | | ✔️ |

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -7,7 +7,7 @@ info:
     整理自[官方文档中心](https://pay.weixin.qq.com/wiki/doc/apiv3/index.shtml)
     本[项目/工具地址](https://github.com/TheNorthMemory/wechatpay-openapi)
     **访问第一次加载比较慢，请耐心等待大约1-2分钟不等(小文件下载比较多)。**
-  version: 0.15.36
+  version: 0.15.37
 schemes:
   - https
 consumes:
@@ -24,6 +24,7 @@ tags:
   - name: 免密支付
   - name: 资金应用∙分账
   - name: 资金应用∙转账
+  - name: 资金应用∙转账∙用户确认模式
   - name: 资金应用∙转账∙服务商模式
   - name: 资金应用∙转账∙银行模式
   - name: 收付通∙进件
@@ -667,6 +668,22 @@ paths:
     $ref: ./v3/express/users/{openid}/transform.yaml
   /v3/facemch/users/{face_sid}:
     $ref: ./v3/facemch/users/{face_sid}.yaml
+  /v3/fund-app/mch-transfer/elecsign/out-bill-no:
+    $ref: ./v3/fund-app/mch-transfer/elecsign/out-bill-no.yaml
+  /v3/fund-app/mch-transfer/elecsign/out-bill-no/{out_bill_no}:
+    $ref: ./v3/fund-app/mch-transfer/elecsign/out-bill-no/{out_bill_no}.yaml
+  /v3/fund-app/mch-transfer/elecsign/transfer-bill-no:
+    $ref: ./v3/fund-app/mch-transfer/elecsign/transfer-bill-no.yaml
+  /v3/fund-app/mch-transfer/elecsign/transfer-bill-no/{transfer_bill_no}:
+    $ref: ./v3/fund-app/mch-transfer/elecsign/transfer-bill-no/{transfer_bill_no}.yaml
+  /v3/fund-app/mch-transfer/transfer-bills:
+    $ref: ./v3/fund-app/mch-transfer/transfer-bills.yaml
+  /v3/fund-app/mch-transfer/transfer-bills/out-bill-no/{out_bill_no}:
+    $ref: ./v3/fund-app/mch-transfer/transfer-bills/out-bill-no/{out_bill_no}.yaml
+  /v3/fund-app/mch-transfer/transfer-bills/out-bill-no/{out_bill_no}/cancel:
+    $ref: ./v3/fund-app/mch-transfer/transfer-bills/out-bill-no/{out_bill_no}/cancel.yaml
+  /v3/fund-app/mch-transfer/transfer-bills/transfer-bill-no/{transfer_bill_no}:
+    $ref: ./v3/fund-app/mch-transfer/transfer-bills/transfer-bill-no/{transfer_bill_no}.yaml
   /v3/funds-to-oversea/bill-download-url:
     $ref: ./v3/funds-to-oversea/bill-download-url.yaml
   /v3/funds-to-oversea/orders:

diff --git a/docs/v3/fund-app/mch-transfer/elecsign/out-bill-no.yaml b/docs/v3/fund-app/mch-transfer/elecsign/out-bill-no.yaml
@@ -0,0 +1,37 @@
+post:
+  x-last-updated-at: 2024.10.14
+  x-role:
+    - 普通商户
+  tags:
+    - 资金应用∙转账∙用户确认模式
+  summary: 商户单号申请电子回单
+  description: 商户可以 指定商户转账单号通过该接口申请 商家转账用户确认模式转账单据 对应的电子回单。微信支付会在校验满足回单申请条件后受理回单的申请，商户后续可以通过电子回单查询接口查询回单处理进度。[官方文档](https://pay.weixin.qq.com/docs/merchant/apis/mch-trans/elecsign/accept-elecsign-by-out-no.html)
+  parameters:
+    - name: _
+      in: body
+      required: true
+      schema:
+        type: object
+        required:
+          - out_bill_no
+        properties:
+          out_bill_no:
+            type: string
+            description: 商户转账单号
+            example: plfk2020042013
+  responses:
+    '200':
+      schema:
+        type: object
+        required:
+          - state
+          - create_time
+        properties:
+          state:
+            type: string
+            description: 申请单状态
+            example: GENERATING
+          create_time:
+            type: string
+            description: 申请单创建时间
+            example: '2015-05-20T13:29:35.120+08:00'
diff --git a/docs/v3/fund-app/mch-transfer/elecsign/out-bill-no/{out_bill_no}.yaml b/docs/v3/fund-app/mch-transfer/elecsign/out-bill-no/{out_bill_no}.yaml
@@ -0,0 +1,52 @@
+get:
+  x-last-updated-at: 2024.10.14
+  x-role:
+    - 普通商户
+  tags:
+    - 资金应用∙转账∙用户确认模式
+  summary: 商户单号查询电子回单
+  description: 商户可以通过该接口查看回单申请进度；请务必对比下载的回单文件的摘要值与查询接口返回的摘要值的一致性，确保得到的回单文件的真实性和完整性。下载地址的有效期为10分钟，超过10分钟后需要重新通过该接口获取下载地址（不需要重新申请）。[官方文档](https://pay.weixin.qq.com/docs/merchant/apis/mch-trans/elecsign/query-elecsign-by-out-no.html)
+  parameters:
+    - name: out_bill_no
+      in: path
+      required: true
+      type: string
+      description: 商户转账单号
+      example: plfk2020042013
+  responses:
+    '200':
+      schema:
+        type: object
+        required:
+          - state
+          - create_time
+          - update_time
+        properties:
+          state:
+            type: string
+            description: 申请单状态
+            example: GENERATING
+          create_time:
+            type: string
+            description: 申请单创建时间
+            example: '2015-05-20T13:29:35.120+08:00'
+          update_time:
+            type: string
+            description: 申请单更新时间
+            example: '2015-05-20T13:29:35.120+08:00'
+          hash_type:
+            type: string
+            description: 回单文件摘要类型
+            example: SHA256
+          hash_value:
+            type: string
+            description: 回单文件摘要值
+            example: DE731F35146A0BEFADE5DB9D1E468D96C01CA8898119C674FEE9F11F4DBE5529
+          download_url:
+            type: string
+            description: 回单文件下载地址
+            example: https://api.mch.weixin.qq.com/v3/transferbilldownload/file?token=xxx
+          fail_reason:
+            type: string
+            description: 失败原因
+            example: 转账单据不存在
diff --git a/docs/v3/fund-app/mch-transfer/elecsign/transfer-bill-no.yaml b/docs/v3/fund-app/mch-transfer/elecsign/transfer-bill-no.yaml
@@ -0,0 +1,37 @@
+post:
+  x-last-updated-at: 2024.10.14
+  x-role:
+    - 普通商户
+  tags:
+    - 资金应用∙转账∙用户确认模式
+  summary: 微信单号申请电子回单
+  description: 商户可以 指定微信转账单号通过该接口申请 **商家转账用户确认模式转账单据** 对应的电子回单。微信支付会在校验满足回单申请条件后受理回单的申请，商户后续可以通过电子回单查询接口查询回单处理进度。[官方文档](https://pay.weixin.qq.com/docs/merchant/apis/mch-trans/elecsign/accept-elecsign-by-no.html)
+  parameters:
+    - name: _
+      in: body
+      required: true
+      schema:
+        type: object
+        required:
+          - transfer_bill_no
+        properties:
+          transfer_bill_no:
+            type: string
+            description: 微信转账单号
+            example: '1330000071100999991182020050700019480001'
+  responses:
+    '200':
+      schema:
+        type: object
+        required:
+          - state
+          - create_time
+        properties:
+          state:
+            type: string
+            description: 申请单状态
+            example: GENERATING
+          create_time:
+            type: string
+            description: 申请单创建时间
+            example: '2015-05-20T13:29:35.120+08:00'
diff --git a/docs/v3/fund-app/mch-transfer/elecsign/transfer-bill-no/{transfer_bill_no}.yaml b/docs/v3/fund-app/mch-transfer/elecsign/transfer-bill-no/{transfer_bill_no}.yaml
@@ -0,0 +1,52 @@
+get:
+  x-last-updated-at: 2024.10.14
+  x-role:
+    - 普通商户
+  tags:
+    - 资金应用∙转账∙用户确认模式
+  summary: 微信单号查询电子回单
+  description: 商户可以通过该接口查看回单申请进度；请务必对比下载的回单文件的摘要值与查询接口返回的摘要值的一致性，确保得到的回单文件的真实性和完整性。下载地址的有效期为10分钟，超过10分钟后需要重新通过该接口获取下载地址（不需要重新申请）。[官方文档](https://pay.weixin.qq.com/docs/merchant/apis/mch-trans/elecsign/query-elecsign-by-no.html)
+  parameters:
+    - name: transfer_bill_no
+      in: path
+      required: true
+      type: string
+      description: 微信转账单号
+      example: '1330000071100999991182020050700019480001'
+  responses:
+    '200':
+      schema:
+        type: object
+        required:
+          - state
+          - create_time
+          - update_time
+        properties:
+          state:
+            type: string
+            description: 申请单状态
+            example: GENERATING
+          create_time:
+            type: string
+            description: 申请单创建时间
+            example: '2015-05-20T13:29:35.120+08:00'
+          update_time:
+            type: string
+            description: 申请单更新时间
+            example: '2015-05-20T13:29:35.120+08:00'
+          hash_type:
+            type: string
+            description: 回单文件摘要类型
+            example: SHA256
+          hash_value:
+            type: string
+            description: 回单文件摘要值
+            example: DE731F35146A0BEFADE5DB9D1E468D96C01CA8898119C674FEE9F11F4DBE5529
+          download_url:
+            type: string
+            description: 回单文件下载地址
+            example: https://api.mch.weixin.qq.com/v3/transferbilldownload/file?token=xxx
+          fail_reason:
+            type: string
+            description: 失败原因
+            example: 转账单据不存在
diff --git a/docs/v3/fund-app/mch-transfer/transfer-bills.yaml b/docs/v3/fund-app/mch-transfer/transfer-bills.yaml
@@ -0,0 +1,107 @@
+post:
+  x-last-updated-at: 2024.10.14
+  x-role:
+    - 普通商户
+  tags:
+    - 资金应用∙转账∙用户确认模式
+  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'
+    - name: _
+      in: body
+      required: true
+      schema:
+        type: object
+        required:
+          - appid
+          - out_bill_no
+          - transfer_scene_id
+          - openid
+          - transfer_amount
+          - transfer_remark
+        properties:
+          appid:
+            type: string
+            description: 商户AppID
+            example: wxf636efh567hg4356
+          out_bill_no:
+            type: string
+            description: 商户单号
+            example: plfk2020042013
+          transfer_scene_id:
+            type: string
+            description: 转账场景ID
+            example: '1000'
+          openid:
+            type: string
+            description: 收款用户OpenID
+            example: o-MYE42l80oelYMDE34nYD456Xoy
+          user_name:
+            type: string
+            description: 收款用户姓名
+            example: 757b340b45ebef5467rter35gf464344v3542sdf4t6re4tb4f54ty45t4yyry45
+          transfer_amount:
+            type: number
+            description: 转账金额
+            example: 400000
+          transfer_remark:
+            type: string
+            description: 转账备注
+            example: 2020年4月报销
+          notify_url:
+            type: string
+            description: 通知地址
+            example: https://www.weixin.qq.com/wxpay/pay.php
+          user_recv_perception:
+            type: string
+            description: 用户收款感知
+            example: 现金奖励
+          transfer_scene_report_infos:
+            type: array
+            description: 转账场景报备信息
+            items:
+              type: object
+              properties:
+                info_type:
+                  type: string
+                  description: 信息类型
+                  example: 活动名称
+                info_content:
+                  type: string
+                  description: 信息内容
+                  example: 注册会员有礼
+  responses:
+    '200':
+      schema:
+        type: object
+        required:
+          - out_bill_no
+          - transfer_bill_no
+          - create_time
+          - state
+        properties:
+          out_bill_no:
+            type: string
+            description: 商户单号
+            example: plfk2020042013
+          transfer_bill_no:
+            type: string
+            description: 微信转账单号
+            example: '1330000071100999991182020050700019480001'
+          create_time:
+            type: string
+            description: 单据创建时间
+            example: '2015-05-20T13:29:35.120+08:00'
+          state:
+            type: string
+            description: 单据状态
+            example: ACCEPTED
+          fail_reason:
+            type: string
+            description: 失败原因
+            example: PAYEE_ACCOUNT_ABNORMAL
+          package_info:
+            type: string
+            description: 跳转领取页面的package信息
+            example: affffddafdfafddffda==