payapi-spec/definitions.yaml

components:
  headers:
    TenantId:
      name: X-TENANT-ID
      in: header
      description: 租户ID
      required: true
      schema:
        type: string

  responses:
    CommonError:
      description: 请求失败
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'


  schemas:
    ErrorResponse:
      type: object
      title: 请求错误
      required:
        - message
      properties:
        timestamp:
          type: string
          format: date-time
        code:
          type: string
          title: 错误码
        message:
          type: string
          title: 错误信息
    TransDate:
      type: string
      title: 交易日期
      minLength: 8
      maxLength: 8
      pattern: '[0-9]*'
    TransTime:
      type: string
      title: 交易时间
      minLength: 6
      maxLength: 6
      pattern: '[0-9]*'
    ShopAccNo:
      type: string
      title: 商户号
      pattern: '[0-9]*'
    Refno:
      type: string
      title: 交易号
      minLength: 16
      pattern: '[0-9]*'
    QrcodeFormat:
      type: string
      title: Qrcode格式
      enum:
        - plain
        - base64
        - hex
    TransResult:
      type: string
      enum:
        - success
        - failed
        - already_success
        - require_query
    UserStatus:
      type: string
      description: |
        * normal 正常
        * frozen 冻结
        * canceled 注销
        * closed 关闭
        * notexists 不存在
      enum:
        - normal
        - fronzen
        - canceled
        - closed
        - notexists
    SubAccountBalance:
      type: object
      required:
        - name
        - status
      properties:
        name:
          type: string
          title: 子账户名
        status:
          title: 子账户状态
          $ref: '#/components/schemas/UserStatus'
        offline:
          type: boolean
          title: 是否允许脱机使用
        balance:
          type: integer
          title: 子账户余额
        expire:
          type: string
          title: 余额有效期
          format: date-time
    SubAccountMetadata:
      type: object
      properties:
        name:
          type: string
          title: 账户名
        title:
          type: string
          title: 账户类型
        description:
          type: string
          title: 账户描述
        offline:
          type: boolean
          title: 是否可以脱机使用