txz-mch-pay/doc/order.json

{
  "openapi": "3.0.1",
  "info": {
    "title": "默认模块",
    "description": "",
    "version": "1.0.0"
  },
  "tags": [],
  "paths": {
    "/admin/payOrder/page": {
      "post": {
        "summary": "分页查询列表",
        "deprecated": false,
        "description": "",
        "tags": [],
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PayOrderPageDTO",
                "description": "参数集"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RIPagePayOrder",
                  "description": "用户集合"
                },
                "example": {
                  "ok": false,
                  "code": 0,
                  "msg": "",
                  "data": {}
                }
              }
            },
            "headers": {}
          }
        },
        "security": []
      }
    },
    "/admin/payOrder/statistics": {
      "post": {
        "summary": "代付列表统计",
        "deprecated": false,
        "description": "",
        "tags": [],
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/PayOrderPageDTO",
                "description": "参数集"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RPayOrderStatisticsRO",
                  "description": "用户集合"
                },
                "example": {
                  "ok": false,
                  "code": 0,
                  "msg": "",
                  "data": {}
                }
              }
            },
            "headers": {}
          }
        },
        "security": []
      }
    },
    "/admin/withdrawOrder/page": {
      "post": {
        "summary": "分页查询列表",
        "deprecated": false,
        "description": "",
        "tags": [],
        "parameters": [],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/WithdrawOrderPageDTO",
                "description": "参数集"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RIPageWithdrawOrder",
                  "description": "用户集合"
                },
                "example": {
                  "ok": false,
                  "code": 0,
                  "msg": "",
                  "data": {}
                }
              }
            },
            "headers": {}
          }
        },
        "security": []
      }
    },
    "/admin/payNotify/page": {
      "get": {
        "summary": "分页查询列表",
        "deprecated": false,
        "description": "",
        "tags": [],
        "parameters": [
          {
            "name": "appId",
            "in": "query",
            "description": "",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "orderId",
            "in": "query",
            "description": "",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RPayNotifyRO",
                  "description": "通知记录"
                },
                "example": {
                  "code": 0,
                  "msg": "",
                  "data": {
                    "id": 0,
                    "orderId": "",
                    "status": 0,
                    "nextNotifyTime": "",
                    "lastExecuteTime": "",
                    "notifyTimes": 0,
                    "maxNotifyTimes": 0,
                    "notifyUrl": "",
                    "errorMsg": "",
                    "payNotifyLogs": [
                      {
                        "notifyTimes": 0,
                        "response": "",
                        "status": 0,
                        "createTime": ""
                      }
                    ]
                  }
                }
              }
            },
            "headers": {}
          }
        },
        "security": []
      }
    },
    "/statistisc/index": {
      "get": {
        "summary": "首页数据统计 index_select",
        "deprecated": false,
        "description": "",
        "tags": [],
        "parameters": [],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ROrderStatisticsVO"
                },
                "example": {
                  "code": 0,
                  "msg": "",
                  "data": {
                    "submitCreateNum": 0,
                    "payOrderNum": 0,
                    "submitCreateAmount": 0,
                    "payOrderAmount": 0,
                    "withdrawOrderNum": 0,
                    "withdrawOrderSuccessNum": 0,
                    "withdrawOrderAmount": 0,
                    "withdrawOrderSuccessAmount": 0,
                    "paySuccessRate": 0
                  }
                }
              }
            },
            "headers": {}
          }
        },
        "security": []
      }
    }
  },
  "components": {
    "schemas": {
      "PayNotifyLogRO": {
        "type": "object",
        "properties": {
          "notifyTimes": {
            "type": "integer",
            "description": "第几次被通知\n\n对应到{@link MchPayNotifyTask#getNotifyTimes()}"
          },
          "response": {
            "type": "string",
            "description": "HTTP 响应结果"
          },
          "status": {
            "type": "integer",
            "description": "支付通知状态\n\n枚举{@link PayNotifyStatusEnum}"
          },
          "createTime": {
            "type": "string",
            "description": "创建时间"
          }
        }
      },
      "PayOrder": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "createTime": {
            "type": "string",
            "description": "创建时间"
          },
          "updateTime": {
            "type": "string",
            "description": "修改时间"
          },
          "appId": {
            "type": "string",
            "description": "appId"
          },
          "mchOrderNo": {
            "type": "string",
            "description": "商户订单号"
          },
          "orderStatus": {
            "type": "string",
            "description": "订单状态",
            "enum": [
              "CREATE_ORDER",
              "PAY_SUCCESS",
              "PAY_FAIL",
              "CANCEL_ORDER",
              "PAY_TIMEOUT"
            ]
          },
          "currency": {
            "type": "string",
            "description": "币种"
          },
          "amount": {
            "type": "number",
            "description": "订单原始金额"
          },
          "clientIp": {
            "type": "string",
            "description": "客户端IP"
          },
          "device": {
            "type": "string",
            "description": "设备"
          },
          "returnUrl": {
            "type": "string",
            "description": "支付结果前端跳转URL"
          },
          "notifyUrl": {
            "type": "string",
            "description": "支付结果后台回调URL"
          },
          "subject": {
            "type": "string",
            "description": "主题"
          },
          "body": {
            "type": "string",
            "description": "内容不能为空"
          },
          "extra": {
            "type": "string",
            "description": "扩展参数"
          },
          "reqTime": {
            "type": "string",
            "description": "请求时间"
          },
          "merchantUserId": {
            "type": "integer",
            "description": "商户id",
            "format": "int64"
          },
          "agentUserId": {
            "type": "integer",
            "description": "代理商id",
            "format": "int64"
          },
          "paymentTypeId": {
            "type": "integer",
            "description": "通道类型id",
            "format": "int64"
          },
          "paymentChannelId": {
            "type": "integer",
            "description": "支付通道id",
            "format": "int64"
          },
          "paymentChannelName": {
            "type": "string",
            "description": "支付通道名称"
          },
          "feeStatus": {
            "type": "boolean",
            "description": "获取通道费率成功标识"
          },
          "mFeeType": {
            "type": "string",
            "description": "平台手续费类型",
            "enum": [
              "PERCENTAGE",
              "FIXED",
              "MIXED"
            ]
          },
          "mFeeRate": {
            "type": "number",
            "description": "平台手续费比例（百分比）"
          },
          "mFeeEvery": {
            "type": "number",
            "description": "平台手续费固定金额"
          },
          "mFee": {
            "type": "number",
            "description": "平台手续费"
          },
          "aFeeType": {
            "type": "string",
            "description": "代理商手续费类型",
            "enum": [
              "PERCENTAGE",
              "FIXED",
              "MIXED"
            ]
          },
          "aFeeRate": {
            "type": "number",
            "description": "代理商手续费比例（百分比）"
          },
          "aFeeEvery": {
            "type": "number",
            "description": "代理商手续费固定金额"
          },
          "aFee": {
            "type": "number",
            "description": "代理商手续"
          },
          "noticeDatetime": {
            "type": "string",
            "description": "支付完成时间"
          },
          "noticeAmount": {
            "type": "number",
            "description": "实际支付金额"
          },
          "noticeMFee": {
            "type": "number",
            "description": "实际平台手续费"
          },
          "noticeAFee": {
            "type": "number",
            "description": "实际平台手续费"
          },
          "transactionId": {
            "type": "string",
            "description": "上游三方支付流水号"
          }
        }
      },
      "WithdrawOrder": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "createTime": {
            "type": "string",
            "description": "创建时间"
          },
          "updateTime": {
            "type": "string",
            "description": "修改时间"
          },
          "appId": {
            "type": "string",
            "description": "appId"
          },
          "mchOrderNo": {
            "type": "string",
            "description": "商户订单号"
          },
          "orderStatus": {
            "type": "string",
            "description": "订单状态",
            "enum": [
              "CREATE_ORDER",
              "WITHDRAW_SUCCESS",
              "WITHDRAW_FAIL"
            ]
          },
          "currencyType": {
            "type": "string",
            "description": "币种"
          },
          "amount": {
            "type": "number",
            "description": "订单原始金额"
          },
          "notifyUrl": {
            "type": "string",
            "description": "支付结果后台回调URL"
          },
          "subject": {
            "type": "string",
            "description": "主题"
          },
          "payUsername": {
            "type": "string",
            "description": "用户姓名"
          },
          "payBankNumber": {
            "type": "string",
            "description": "银行账号"
          },
          "payBankName": {
            "type": "string",
            "description": "银行名称"
          },
          "payAttach": {
            "type": "string",
            "description": "扩展参数"
          },
          "payEmail": {
            "type": "string",
            "description": "用户邮箱"
          },
          "payMobile": {
            "type": "string",
            "description": "用户电话"
          },
          "reqTime": {
            "type": "string",
            "description": "请求时间"
          },
          "merchantUserId": {
            "type": "integer",
            "description": "商户id",
            "format": "int64"
          },
          "paymentTypeId": {
            "type": "integer",
            "description": "通道类型id",
            "format": "int64"
          },
          "paymentChannelId": {
            "type": "integer",
            "description": "支付通道id",
            "format": "int64"
          },
          "feeStatus": {
            "type": "boolean",
            "description": "获取通道费率成功标识"
          },
          "mFeeType": {
            "type": "string",
            "description": "平台手续费类型",
            "enum": [
              "PERCENTAGE",
              "FIXED",
              "MIXED"
            ]
          },
          "mFeeRate": {
            "type": "number",
            "description": "平台手续费比例（百分比）"
          },
          "mFeeEvery": {
            "type": "number",
            "description": "平台手续费固定金额"
          },
          "mFee": {
            "type": "number",
            "description": "平台手续费"
          },
          "aFeeType": {
            "type": "string",
            "description": "代理商手续费类型",
            "enum": [
              "PERCENTAGE",
              "FIXED",
              "MIXED"
            ]
          },
          "aFeeRate": {
            "type": "number",
            "description": "代理商手续费比例（百分比）"
          },
          "aFeeEvery": {
            "type": "number",
            "description": "代理商手续费固定金额"
          },
          "aFee": {
            "type": "number",
            "description": "代理商手续"
          },
          "noticeDatetime": {
            "type": "string",
            "description": "支付完成时间"
          },
          "noticeAmount": {
            "type": "number",
            "description": "实际支付金额"
          },
          "noticeMFee": {
            "type": "number",
            "description": "实际平台手续费"
          },
          "noticeAFee": {
            "type": "number",
            "description": "实际平台手续费"
          },
          "transactionId": {
            "type": "string",
            "description": "上游三方支付流水号"
          }
        }
      },
      "OrderStatisticsVO": {
        "type": "object",
        "properties": {
          "submitCreateNum": {
            "type": "integer",
            "description": "提交订单数"
          },
          "payOrderNum": {
            "type": "integer",
            "description": "支付订单数"
          },
          "submitCreateAmount": {
            "type": "number",
            "description": "提交订单金额"
          },
          "payOrderAmount": {
            "type": "number",
            "description": "支付订单金额"
          },
          "withdrawOrderNum": {
            "type": "integer",
            "description": "提现订单数"
          },
          "withdrawOrderSuccessNum": {
            "type": "integer",
            "description": "提现订单成功数"
          },
          "withdrawOrderAmount": {
            "type": "number",
            "description": "提现订单金额"
          },
          "withdrawOrderSuccessAmount": {
            "type": "number",
            "description": "提现订单成功金额"
          },
          "paySuccessRate": {
            "type": "number",
            "description": "支付成功率"
          }
        }
      },
      "": {
        "type": "object",
        "properties": {}
      },
      "PayNotifyRO": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "orderId": {
            "type": "string",
            "description": "平台订单ID"
          },
          "status": {
            "type": "integer",
            "description": "通知状态\n\n枚举{@link PayNotifyStatusEnum}"
          },
          "nextNotifyTime": {
            "type": "string",
            "description": "下一次通知时间"
          },
          "lastExecuteTime": {
            "type": "string",
            "description": "最后一次执行时间"
          },
          "notifyTimes": {
            "type": "integer",
            "description": "当前通知次数"
          },
          "maxNotifyTimes": {
            "type": "integer",
            "description": "最大可通知次数"
          },
          "notifyUrl": {
            "type": "string",
            "description": "通知地址"
          },
          "errorMsg": {
            "type": "string",
            "description": "失败原因"
          },
          "payNotifyLogs": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PayNotifyLogRO",
              "description": "com.mw.bridging.open.ro.PayNotifyLogRO"
            },
            "description": "通知日志"
          }
        }
      },
      "ROrderStatisticsVO": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "返回标记：成功标记=0，失败标记=1"
          },
          "msg": {
            "type": "string",
            "description": "返回信息"
          },
          "data": {
            "$ref": "#/components/schemas/OrderStatisticsVO",
            "description": "数据"
          }
        }
      },
      "RPayNotifyRO": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "返回标记：成功标记=0，失败标记=1"
          },
          "msg": {
            "type": "string",
            "description": "返回信息"
          },
          "data": {
            "$ref": "#/components/schemas/PayNotifyRO",
            "description": "数据"
          }
        }
      },
      "IPagePayOrder": {
        "type": "object",
        "properties": {
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PayOrder",
              "description": ""
            },
            "description": ""
          },
          "total": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "size": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "current": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "orders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderItem",
              "description": "com.baomidou.mybatisplus.core.metadata.OrderItem"
            },
            "description": ""
          },
          "optimizeCountSql": {
            "type": "boolean",
            "description": ""
          },
          "searchCount": {
            "type": "boolean",
            "description": ""
          },
          "optimizeJoinOfCountSql": {
            "type": "boolean",
            "description": ""
          },
          "maxLimit": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "countId": {
            "type": "string",
            "description": ""
          },
          "pages": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "IPageWithdrawOrder": {
        "type": "object",
        "properties": {
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WithdrawOrder",
              "description": ""
            },
            "description": ""
          },
          "total": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "size": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "current": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "orders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderItem",
              "description": "com.baomidou.mybatisplus.core.metadata.OrderItem"
            },
            "description": ""
          },
          "optimizeCountSql": {
            "type": "boolean",
            "description": ""
          },
          "searchCount": {
            "type": "boolean",
            "description": ""
          },
          "optimizeJoinOfCountSql": {
            "type": "boolean",
            "description": ""
          },
          "maxLimit": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "countId": {
            "type": "string",
            "description": ""
          },
          "pages": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "PayOrderPageDTO": {
        "type": "object",
        "properties": {
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/1"
            },
            "description": ""
          },
          "total": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "size": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "current": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "orders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderItem",
              "description": "com.baomidou.mybatisplus.core.metadata.OrderItem"
            },
            "description": ""
          },
          "optimizeCountSql": {
            "type": "boolean",
            "description": ""
          },
          "searchCount": {
            "type": "boolean",
            "description": ""
          },
          "optimizeJoinOfCountSql": {
            "type": "boolean",
            "description": ""
          },
          "maxLimit": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "countId": {
            "type": "string",
            "description": ""
          },
          "mchOrderNo": {
            "type": "string",
            "description": "商户单号"
          },
          "transactionId": {
            "type": "string",
            "description": "支付单号"
          },
          "orderStatus": {
            "type": "string",
            "description": "订单状态",
            "enum": [
              "CREATE_ORDER",
              "PAY_SUCCESS",
              "PAY_FAIL",
              "CANCEL_ORDER",
              "PAY_TIMEOUT"
            ]
          },
          "startTime": {
            "type": "string",
            "description": "开始时间"
          },
          "endTime": {
            "type": "string",
            "description": "结束时间"
          },
          "paymentChannelId": {
            "type": "integer",
            "description": "支付通道id",
            "format": "int64"
          }
        }
      },
      "WithdrawOrderPageDTO": {
        "type": "object",
        "properties": {
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/1"
            },
            "description": ""
          },
          "total": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "size": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "current": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "orders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OrderItem",
              "description": "com.baomidou.mybatisplus.core.metadata.OrderItem"
            },
            "description": ""
          },
          "optimizeCountSql": {
            "type": "boolean",
            "description": ""
          },
          "searchCount": {
            "type": "boolean",
            "description": ""
          },
          "optimizeJoinOfCountSql": {
            "type": "boolean",
            "description": ""
          },
          "maxLimit": {
            "type": "integer",
            "description": "",
            "format": "int64"
          },
          "countId": {
            "type": "string",
            "description": ""
          },
          "mchOrderNo": {
            "type": "string",
            "description": "商户单号"
          },
          "transactionId": {
            "type": "string",
            "description": "支付单号"
          },
          "orderStatus": {
            "type": "string",
            "description": "订单状态",
            "enum": [
              "CREATE_ORDER",
              "WITHDRAW_SUCCESS",
              "WITHDRAW_FAIL"
            ]
          },
          "startTime": {
            "type": "string",
            "description": "开始时间"
          },
          "endTime": {
            "type": "string",
            "description": "结束时间"
          }
        }
      },
      "RIPagePayOrder": {
        "type": "object",
        "properties": {
          "ok": {
            "type": "boolean"
          },
          "code": {
            "type": "integer",
            "description": "返回标记：成功标记=0，失败标记=1"
          },
          "msg": {
            "type": "string",
            "description": "返回信息"
          },
          "data": {
            "$ref": "#/components/schemas/IPagePayOrder",
            "description": "数据"
          }
        }
      },
      "RIPageWithdrawOrder": {
        "type": "object",
        "properties": {
          "ok": {
            "type": "boolean"
          },
          "code": {
            "type": "integer",
            "description": "返回标记：成功标记=0，失败标记=1"
          },
          "msg": {
            "type": "string",
            "description": "返回信息"
          },
          "data": {
            "$ref": "#/components/schemas/IPageWithdrawOrder",
            "description": "数据"
          }
        }
      },
      "OrderItem": {
        "type": "object",
        "properties": {
          "column": {
            "type": "string",
            "description": ""
          },
          "asc": {
            "type": "boolean",
            "description": ""
          }
        }
      },
      "PayOrderStatisticsRO": {
        "type": "object",
        "properties": {
          "numberOrders": {
            "type": "integer",
            "description": "提交订单数"
          },
          "totalOrderAmount": {
            "type": "number",
            "description": "订单总金额"
          },
          "paidOrders": {
            "type": "integer",
            "description": "已付订单数"
          },
          "totalAmountPaid": {
            "type": "number",
            "description": "已付总金额"
          },
          "totalMerchantAmount": {
            "type": "number",
            "description": "商户总收入"
          },
          "totalAgentAmount": {
            "type": "number",
            "description": "代理商总收入"
          },
          "unpaidOrders": {
            "type": "integer",
            "description": "未付订单数"
          },
          "totalAmountUnpaid": {
            "type": "number",
            "description": "未付总金额"
          }
        }
      },
      "RPayOrderStatisticsRO": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "返回标记：成功标记=0，失败标记=1"
          },
          "msg": {
            "type": "string",
            "description": "返回信息"
          },
          "data": {
            "$ref": "#/components/schemas/PayOrderStatisticsRO",
            "description": "数据"
          }
        }
      }
    },
    "securitySchemes": {}
  },
  "servers": [],
  "security": []
}