-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.yml
362 lines (358 loc) · 11.7 KB
/
api.yml
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
openapi: 3.0.3
info:
title: Repaya REST API
version: 1.1.5
servers:
- url: https://repaya.io/api/public/1
- url: https://goerli.repaya.io/api/public/1
paths:
/session:
post:
summary: Create payment session
security:
- repayaAuth: []
description: Create a payment session to initiate the checkout flow
requestBody:
content:
application/json:
schema:
type: object
required: ["formLinkId"]
properties:
formLinkId:
type: string
example: "jAY7k"
customer:
type: object
properties:
id:
type: string
example: "user_123141"
data:
type: string
description: "Arbitrary customer data"
product:
type: object
properties:
id:
type: string
example: "product_123141"
name:
type: string
example: "Awesome product"
data:
type: string
description: "Arbitrary product data"
price:
type: object
additionalProperties:
type: string
example: {"USD_MULTI_1": "15.0"}
clientId:
type: string
example: "key_1432"
responses:
'200':
description: Payment session created
content:
application/json:
schema:
type: object
required: ["checkoutUrl", "id", "formLinkId", "receiver"]
properties:
checkoutUrl:
type: string
description: "Redirect customer to this url to complete the payment"
example: "https://repaya.io/checkout/id_124124"
id:
type: string
example: "id_124124"
description: "Payment session ID"
formLinkId:
type: string
example: "jAY7k"
receiver:
type: string
example: "0x0000000000000000000000000000000000000000"
customer:
type: object
properties:
id:
type: string
example: "user_123141"
product:
type: object
properties:
id:
type: string
example: "product_123141"
name:
type: string
example: "Awesome product"
price:
type: object
additionalProperties:
type: string
example: {"USD_MULTI_1": "15.0"}
clientId:
type: string
example: "key_1432"
/payment:
get:
summary: Get customer's payment in the given session
security:
- repayaAuth: []
parameters:
- in: query
name: sessionId
description: Payment session ID
required: true
schema:
type: string
example: "id_124124"
responses:
'200':
description: A payment associated with a given session, null if missing
content:
application/json:
schema:
type: object
nullable: true
properties:
id:
type: string
example: "pid_3251"
customer:
type: object
properties:
id:
type: string
nullable: true
example: "user_123141"
data:
type: string
nullable: true
description: "Arbitrary customer data"
product:
type: object
properties:
id:
type: string
nullable: true
example: "product_123141"
name:
type: string
nullable: true
example: "Awesome product"
data:
type: string
nullable: true
description: "Arbitrary product data"
sender:
type: string
example: "0x0000000000000000000000000000000000000000"
receiver:
type: string
example: "0x0000000000000000000000000000000000000000"
amount:
type: string
example: "15.0"
paidAmount:
type: string
example: "5.0"
status:
type: string
enum: ["completed", "pending", "failed", "canceled"]
example: "pending"
coin:
type: object
properties:
code:
type: string
example: "USD_MULTI_1"
name:
type: string
example: "USD Stablecoins"
/payment/list:
get:
summary: List payments
security:
- repayaAuth: []
parameters:
- in: query
name: formId
description: Payment form ID
required: true
schema:
type: string
example: "jAY7k"
- in: query
name: limit
description: Limit the number of results
required: true
schema:
type: number
example: 100
- in: query
name: page
description: Page number
required: true
schema:
type: number
example: 3
- in: query
name: sort
description: Sort direction (by "created")
required: true
schema:
type: string
enum: ['asc', 'desc']
example: "asc"
- in: query
name: fromTimestamp
description: From timestamp in milliseconds
required: true
schema:
type: number
example: 1669839216188
- in: query
name: tillTimestamp
description: Till timestamp in milliseconds
required: true
schema:
type: number
example: 1669839216188
responses:
'200':
description: List of payments filtered by the given parameters.
content:
application/json:
schema:
type: array
items:
type: object
nullable: true
properties:
id:
type: string
example: "pid_3251"
customer:
type: object
properties:
id:
type: string
nullable: true
example: "user_123141"
data:
type: string
nullable: true
description: "Arbitrary customer data"
product:
type: object
properties:
id:
type: string
nullable: true
example: "product_123141"
name:
type: string
nullable: true
example: "Awesome product"
data:
type: string
nullable: true
description: "Arbitrary product data"
sender:
type: string
example: "0x0000000000000000000000000000000000000000"
receiver:
type: string
example: "0x0000000000000000000000000000000000000000"
amount:
type: string
example: "15.0"
paidAmount:
type: string
example: "5.0"
status:
type: string
enum: ["completed", "pending", "failed", "canceled"]
example: "pending"
coin:
type: object
properties:
code:
type: string
example: "USD_MULTI_1"
name:
type: string
example: "USD Stablecoins"
/balance:
get:
summary: Get customer balances
security:
- repayaAuth: []
parameters:
- in: query
name: formLinkId
description: Payment form ID
required: true
schema:
type: string
example: "jAY7k"
- in: query
name: customerId
description: Filter by customer, pass an empty string to get the total balance
schema:
type: string
example: "user_123141"
- in: query
name: productId
description: Filter by product, pass an empty string to get the total balance
schema:
type: string
example: "product_123141"
- in: query
name: coin
description: Filter by coin
schema:
type: string
example: "USD_MULTI_1"
responses:
'200':
description: List of customer balances
content:
application/json:
schema:
type: array
items:
type: object
properties:
customerId:
type: string
nullable: true
example: "user_123141"
description: Customer ID for this balance record. The record represents a total balance if this field is an empty string
productId:
type: string
nullable: true
example: "product_123141"
description: Product ID for this balance record. The record represents a total balance if this field is an empty string
balance:
type: string
example: "123.08"
description: Balance value
coin:
type: object
properties:
code:
type: string
example: "USD_MULTI_1"
name:
type: string
example: "USD Stablecoins"
components:
securitySchemes:
repayaAuth:
type: http
scheme: bearer