Gitiles
Code Review Sign In
source.supwisdom.com / epayment / food_payapi / d500f8b0fb4f386d58611232eb0d730af28d34b7 / . / payapi-spec / definitions.yaml
blob: a72bb5467d8d2c332cd6be6b5cc309b953364f21 [file] [log] [blame]
Tang Chengcc4299d2020-03-12 15:55:12 +0800[diff] [blame]1components:
2 headers:
3 TenantId:
sijun.li2da2d5f2020-03-17 17:33:46 +0800[diff] [blame]4 name: X-TENANT-ID
Tang Chengcc4299d2020-03-12 15:55:12 +0800[diff] [blame]5 in: header
6 description: 租户ID
7 required: true
8 schema:
9 type: string
10
Tang Chengc1b76582020-03-20 15:44:40 +0800[diff] [blame]11 responses:
12 CommonError:
13 description: 请求失败
14 content:
15 application/json:
16 schema:
17 $ref: '#/components/schemas/ErrorResponse'
18
Tang Chengcc4299d2020-03-12 15:55:12 +0800[diff] [blame]19
20 schemas:
Tang Cheng3b2c8202020-03-17 08:45:40 +0800[diff] [blame]21 ErrorResponse:
22 type: object
23 title: 请求错误
24 required:
25 - message
26 properties:
Tang Cheng61a10292020-03-17 11:15:30 +0800[diff] [blame]27 timestamp:
28 type: string
29 format: date-time
Tang Cheng3b2c8202020-03-17 08:45:40 +0800[diff] [blame]30 code:
31 type: string
32 title: 错误码
33 message:
34 type: string
35 title: 错误信息
Tang Chengcc4299d2020-03-12 15:55:12 +0800[diff] [blame]36 TransDate:
37 type: string
38 title: 交易日期
39 minLength: 8
40 maxLength: 8
41 pattern: '[0-9]*'
42 TransTime:
43 type: string
44 title: 交易时间
45 minLength: 6
46 maxLength: 6
47 pattern: '[0-9]*'
48 ShopAccNo:
49 type: string
50 title: 商户号
51 pattern: '[0-9]*'
52 Refno:
53 type: string
54 title: 交易号
55 minLength: 16
56 pattern: '[0-9]*'
57 QrcodeFormat:
58 type: string
59 title: Qrcode格式
60 enum:
61 - plain
62 - base64
63 - hex
Tang Cheng3b2c8202020-03-17 08:45:40 +0800[diff] [blame]64 TransResult:
65 type: string
66 enum:
67 - success
68 - failed
69 - already_success
70 - require_query
Tang Chengc1b76582020-03-20 15:44:40 +0800[diff] [blame]71 UserStatus:
72 type: string
73 description: |
74 * normal 正常
75 * frozen 冻结
76 * canceled 注销
77 * closed 关闭
78 * notexists 不存在
79 enum:
80 - normal
81 - fronzen
82 - canceled
83 - closed
84 - notexists
Tang Chengd500f8b2020-03-24 11:33:30 +0800[diff] [blame^]85 SubAccountBalance:
Tang Chengc1b76582020-03-20 15:44:40 +0800[diff] [blame]86 type: object
87 required:
88 - name
89 - status
90 properties:
91 name:
92 type: string
93 title: 子账户名
94 status:
95 title: 子账户状态
96 $ref: '#/components/schemas/UserStatus'
Tang Chengd500f8b2020-03-24 11:33:30 +0800[diff] [blame^]97 offline:
98 type: boolean
99 title: 是否允许脱机使用
Tang Chengc1b76582020-03-20 15:44:40 +0800[diff] [blame]100 balance:
101 type: integer
102 title: 子账户余额
103 expire:
104 type: string
105 title: 余额有效期
106 format: date-time
Tang Chengd500f8b2020-03-24 11:33:30 +0800[diff] [blame^]107 SubAccountMetadata:
108 type: object
109 properties:
110 name:
111 type: string
112 title: 账户名
113 title:
114 type: string
115 title: 账户类型
116 description:
117 type: string
118 title: 账户描述
119 offline:
120 type: boolean
121 title: 是否可以脱机使用