link FACEPAY.USER_STATE_CHANGE webhook event

TheNorthMemory · Nov 22, 2024 · d741756 · d741756
1 parent 01566b4
commit d741756
Show file tree

Hide file tree

Showing 14 changed files with 263 additions and 32 deletions.
diff --git a/docs/v3/offlineface/authinfo.yaml b/docs/v3/offlineface/authinfo.yaml
@@ -12,23 +12,38 @@ post:
       required: true
       schema:
         type: object
+        required:
+          - sp_appid
+          - sub_mchid
+          - device_id
+          - raw_data
+          - organization_id
         properties:
           sp_appid:
             type: string
+            description: 服务商公众号appid
           sub_appid:
             type: string
+            description: 子商户公众号appid
           sub_mchid:
             type: string
+            description: 子商户商户号
           device_id:
             type: string
+            description: 设备id
           raw_data:
             type: string
+            description: 原始数据
           organization_id:
             type: string
+            description: 机构id
   responses:
     '200':
       schema:
         type: object
+        required:
+          - authinfo
         properties:
           authinfo:
             type: string
+            description: 授权信息
diff --git a/docs/v3/offlineface/contracts/presign.yaml b/docs/v3/offlineface/contracts/presign.yaml
@@ -7,57 +7,96 @@ post:
   summary: 预签约接口
   description: 一键绑卡不是支持所有银行卡，上线前请先测试是否支持该银行卡。[官方文档](https://pay.weixin.qq.com/wiki/doc/wxfacepay/develop/access-specifications.html)
   parameters:
+    - $ref: '../../../definitions/Parameters.yaml#/WECHATPAY_CERTIFICATE_SERIAL'
     - name: _
       in: body
       schema:
         type: object
+        required:
+          - business_name
+          - facepay_user
         properties:
           business_name:
             type: string
+            description: 业务类型
           facepay_user:
             type: object
+            description: 刷脸用户信息
+            required:
+              - out_user_id
+              - organization_id
             properties:
               out_user_id:
                 type: string
+                description: 商户用户ID
               identification_name:
                 type: string
+                description: 刷脸用户名
               organization_id:
                 type: string
+                description: 机构ID
               identification:
                 type: object
+                description: 证件信息
+                required:
+                  - identification_type
+                  - identification_number
                 properties:
                   identification_type:
                     type: string
+                    description: 证件类型
                     enum:
                       - IDCARD
                   identification_number:
                     type: string
+                    format: base64
+                    description: 证件ID
               phone:
                 type: string
+                format: base64
+                description: 手机号码
           limit_bank_card:
             type: object
+            description: 签约指定银行卡
             properties:
               bank_card_number:
                 type: string
+                format: base64
+                description: 银行卡号
               identification_name:
                 type: string
+                format: base64
+                description: 开卡人姓名
               identification:
                 type: object
+                description: 开卡人证件
+                required:
+                  - identification_type
+                  - identification_number
                 properties:
                   identification_type:
                     type: string
+                    description: 证件类型
                     enum:
                       - IDCARD
                   identification_number:
                     type: string
+                    format: base64
+                    description: 证件ID
               valid_thru:
                 type: string
+                format: mm/yy
+                description: 银行卡有效期
               bank_type:
                 type: string
+                description: 银行类型
               phone:
                 type: string
+                format: base64
+                description: 开卡预留手机号
           contract_mode:
             type: string
+            description: 签约模式
             enum:
               - LIMIT_BANK_CARD #指定卡签约
               - PRIORITY_BANK_CARD #优先卡签约
@@ -66,6 +105,9 @@ post:
     '200':
       schema:
         type: object
+        required:
+          - presign_token
         properties:
           presign_token:
             type: string
+            description: 会话ID
diff --git a/docs/v3/offlineface/contracts/{contract_id}.yaml b/docs/v3/offlineface/contracts/{contract_id}.yaml
@@ -11,44 +11,74 @@ get:
       in: path
       type: string
       required: true
+      description: 签约ID
+      example: CI8CD208Z7e9906f89
     - name: appid
       in: query
       type: string
+      description: 商户签约小程序APPID
+      example: wx8888888888
   responses:
     '200':
       schema:
         type: object
+        required:
+          - contract_id
+          - mchid
+          - organization_id
+          - user_id
+          - contract_state
+          - contract_signed_time
+          - contract_mode
+          - contract_bank_card_from
         properties:
           contract_id:
             type: string
+            description: 签约ID
+            example: CI8CD208Z7e9906f89
           mchid:
             type: string
+            description: 商户号
+            example: '2480278041'
           organization_id:
             type: string
+            description: 机构ID
+            example: OAABBCCDDeeff
           use_id:
             type: string
+            description: 用户ID
+            example: FU40F305Z4e2bb7d
           openid:
             type: string
+            description: 签约用户openid
+            example: AFDSJfhdf8744
           contract_state:
             type: string
+            description: 签约状态
             enum:
               - NOT_CONTRACTED #未签约
               - TERMINATED #已解约
               - CONTRACTED #已签约
           contract_signed_time:
             type: string
             format: rfc3339
+            description: 签约时间
+            example: '2018-06-08T10:34:56+08:00'
           contract_terminated_time:
             type: string
             format: rfc3339
+            description: 解约时间
+            example: '2018-06-08T10:34:56+08:00'
           contract_mode:
             type: string
+            description: 签约模式
             enum:
               - LIMIT_BANK_CARD #指定卡签约
               - PRIORITY_BANK_CARD #优先卡签约
               - LIMIT_NONE #任意卡签约
           contract_bank_card_from:
             type: string
+            description: 签约卡来源
             enum:
               - MERCHANT_LIMITED_BANK_CARD #商户指定的签约卡
               - USER_SELECT_FREE #用户选择的签约卡
diff --git a/docs/v3/offlineface/face-collections.yaml b/docs/v3/offlineface/face-collections.yaml
@@ -11,37 +11,58 @@ get:
       in: query
       type: string
       required: true
+      description: 机构ID
+      example: Ofewewfwefweewf
     - name: offset
       in: query
       type: integer
+      description: 列表偏移
+      example: 30
     - name: limit
       in: query
       type: integer
+      description: 资源个数
+      example: 20
   responses:
     '200':
       schema:
         type: object
+        required:
+          - face_collections
         properties:
           face_collections:
             type: array
+            description: 重采列表
             items:
               type: object
+              description: 重采对象
+              required:
+                - collection_id
+                - use_id
+                - organization_id
+                - collection_state
               properties:
                 collection_id:
                   type: string
+                  description: 重采ID
                 use_id:
                   type: string
+                  description: 用户ID
                 organization_id:
                   type: string
+                  description: 机构ID
                 collection_state:
                   type: string
+                  description: 重采状态
                   enum:
                     - COLLECTION_REQUIRED #该刷脸用户需要进行重采
                     - PHOTO_UPLOADED #照片已上传
                     - COMPLETE #支付用户已经确认照片, 重采结束
                 register_photo_upload_time:
                   type: string
                   format: rfc3339
+                  description: 注册照上传时间
                 confirm_time:
                   type: string
                   format: rfc3339
+                  description: 支付用户确认时间
diff --git a/docs/v3/offlineface/face-collections/{collection_id}.yaml b/docs/v3/offlineface/face-collections/{collection_id}.yaml
@@ -11,29 +11,39 @@ get:
       in: path
       type: string
       required: true
-    - name: appid
-      in: query
-      type: string
+      description: 重采ID
+      example: FC2353ZJIHOJKHOIIOIJ
   responses:
     '200':
       schema:
         type: object
+        required:
+          - collection_id
+          - use_id
+          - organization_id
+          - collection_state
         properties:
           collection_id:
             type: string
+            description: 重采ID
           use_id:
             type: string
+            description: 用户ID
           organization_id:
             type: string
+            description: 机构ID
           collection_state:
             type: string
+            description: 重采状态
             enum:
               - COLLECTION_REQUIRED #该刷脸用户需要进行重采
               - PHOTO_UPLOADED #照片已上传
               - COMPLETE #支付用户已经确认照片, 重采结束
           register_photo_upload_time:
             type: string
             format: rfc3339
+            description: 注册照上传时间
           confirm_time:
             type: string
             format: rfc3339
+            description: 支付用户确认时间
diff --git a/docs/v3/offlineface/repayment-url.yaml b/docs/v3/offlineface/repayment-url.yaml
@@ -12,18 +12,28 @@ post:
       required: true
       schema:
         type: object
+        required:
+          - out_user_id
+          - organization_id
         properties:
           out_user_id:
             type: string
+            description: 商户用户ID
           organization_id:
             type: string
+            description: 机构id
   responses:
     '200':
       schema:
         type: object
+        required:
+          - repayment_url
+          - expire_at
         properties:
           repayment_url:
             type: string
+            description: 还款链接
           expire_at:
             type: string
             format: rfc3339
+            description: 链接过期时间