-
Notifications
You must be signed in to change notification settings - Fork 0
/
superfashion-swagger.txt
283 lines (279 loc) · 11 KB
/
superfashion-swagger.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
openapi: 3.0.0
info:
title: SuperFashion Bot Payment API
version: 1.0.0
description: API для интеграции телеграм-бота с внешней платежной системой.
servers:
- url: https://pay.bank.isuct.ru/v2/
description: Сервер оплаты ХимТех Банка
paths:
/payment/process:
post:
tags:
- "Методы"
summary: Обработка платежа через внешнюю платежную систему
description: Передает данные о платеже в платежную систему и возвращает статус операции.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cardNumber:
type: string
description: Номер кредитной карты, зашифрованный.
cvv:
type: string
description: Трехзначный код безопасности, зашифрованный.
example: "123"
amount:
type: number
description: Сумма платежа.
currency:
type: string
description: Валюта платежа.
orderId:
type: string
description: Идентификатор заказа.
paymentMethod:
type: string
enum: [card, paypal, apple_pay, google_pay]
description: Метод оплаты.
payerName:
type: string
description: Имя держателя карты.
payerEmail:
type: string
format: email
description: Email плательщика для отправки квитанции.
requestTimestamp:
type: string
format: date-time
description: Время отправки запроса.
required:
- cardNumber
- cvv
- amount
- currency
- orderId
- paymentMethod
- payerName
- payerEmail
- requestTimestamp
responses:
'200':
description: Платеж успешно обработан.
content:
application/json:
schema:
type: object
properties:
transactionId:
type: string
description: Уникальный идентификатор транзакции.
status:
type: string
enum: [success]
description: Статус успешной обработки платежа.
timestamp:
type: string
format: date-time
description: Время проведения транзакции.
'400':
description: Ошибка запроса.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Код ошибки.
message:
type: string
description: Описание ошибки.
'402':
description: Ошибка платежа.
content:
application/json:
schema:
type: object
properties:
code:
type: string
enum: [INSUFFICIENT_FUNDS, ACCOUNT_BLOCKED, INVALID_CARD_DATA]
description: Код ошибки.
message:
type: string
description: Описание ошибки.
timestamp:
type: string
format: date-time
description: Время попытки проведения транзакции.
'500':
description: Внутренняя ошибка сервера.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Код ошибки.
message:
type: string
description: Описание ошибки.
timestamp:
type: string
format: date-time
description: Время ошибки.
/payment/status/{transactionId}:
get:
tags:
- "Методы"
summary: Получение статуса платежа
description: Позволяет проверить статус ранее выполненной транзакции.
parameters:
- name: transactionId
in: path
required: true
schema:
type: string
description: Уникальный идентификатор транзакции.
responses:
'200':
description: Информация о статусе платежа.
content:
application/json:
schema:
type: object
properties:
transactionId:
type: string
description: Уникальный идентификатор транзакции.
status:
type: string
enum: [success, pending, failed]
description: Текущий статус платежа.
timestamp:
type: string
format: date-time
description: Время запроса.
'404':
description: Транзакция не найдена.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Код ошибки.
message:
type: string
description: Описание ошибки.
timestamp:
type: string
format: date-time
description: Время запроса.
/payment/refund:
post:
tags:
- "Методы"
summary: Запрос на возврат платежа
description: Позволяет инициировать возврат средств по ранее выполненной транзакции.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
transactionId:
type: string
description: Уникальный идентификатор транзакции, по которой запрашивается возврат.
orderId:
type: string
description: Уникальный идентификатор заказа (должен совпадать с тем, что передавался при создании платежа).
refundAmount:
type: number
format: float
description: Сумма возврата.
reason:
type: string
description: Причина возврата.
payerName:
type: string
description: Имя плательщика для проверки соответствия оригинальному платежу.
payerEmail:
type: string
format: email
description: Email плательщика для уведомления.
required:
- transactionId
- orderId
- refundAmount
- reason
- payerName
- payerEmail
responses:
'200':
description: Запрос на возврат успешно обработан.
content:
application/json:
schema:
type: object
properties:
refundId:
type: string
description: Уникальный идентификатор возврата.
status:
type: string
enum: [accepted, rejected, processed, pending]
description: Статус возврата.
timestamp:
type: string
format: date-time
description: Время обработки возврата.
'400':
description: Ошибка запроса на возврат.
content:
application/json:
schema:
type: object
properties:
code:
type: string
description: Код ошибки.
message:
type: string
description: Описание ошибки.
'404':
description: Платеж или заказ не найдены.
content:
application/json:
schema:
type: object
properties:
code:
type: string
enum: [TRANSACTION_NOT_FOUND, ORDER_NOT_FOUND]
description: Код ошибки.
message:
type: string
description: Описание ошибки.
'500':
description: Внутренняя ошибка сервера.
content:
application/json:
schema:
type: object
properties:
code:
type: string
enum: [SERVER_INTERNAL_ERROR]
description: Код ошибки.
message:
type: string
description: Описание ошибки.