-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.yaml
768 lines (753 loc) · 27.7 KB
/
index.yaml
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
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
openapi: 3.0.3
info:
title: Retail Accounts API
description: >-
Endpoints for frontend implementations when it comes to the account space.
Responses can be visualized to give a clearer picture on what responses
provide. This is the new stuff
Make sure to select the respective Environment file when making calls for
the Collection
<img src="https://i.imgur.com/ymcwlzB.gif" alt="Imgur">
Reference image example here:
<img src="https://i.imgur.com/WbEHxDz.jpg" alt="Imgur">
and example of Date
<img src="https://i.imgur.com/zQq3VNF.jpg" alt="Imgur">
version: 1.0.0
contact: {}
x-postman-schemaid: 18f99cd9-728a-47e3-8363-bde2daecc708
x-source-collection: 23889826-b5109b10-1d8d-406f-acfb-828b248e41c5
x-linked-collection: 23889826-1cbee4f0-2ffb-49ce-86bd-bf68301e3cfa
x-postman-apiid: b54fc4ab-0e68-4b79-8e7d-6c1caa54e7be
servers:
- url: https://65dbb390-a892-4b83-a246-5d655f2fb239.mock.pstmn.io
paths:
/accounts/{accountNumber}:
delete:
summary: Delete account
description: Delete an account
operationId: deleteAccount
responses:
'204':
description: 200 OK
content:
text/plain:
examples:
200 OK:
value: ''
parameters:
- name: accountNumber
in: path
required: true
schema:
type: string
example: abc123
description: '(Required)'
/accounts/{accountNumber}/statement/latest:
get:
tags:
- Statement
summary: Latest
description: Use the Statement/Latest to see the account and balance of your user.
operationId: latest
parameters:
- name: accountNumber
in: path
required: true
schema:
type: string
example: 123ABC
responses:
'200':
description: 200 OK
content:
application/json:
schema:
type: object
properties:
balance:
description: The account balance
type: object
properties:
closing:
description: The closing value
type: number
example: 979.96
opening:
type: number
example: 335.77
money:
type: object
properties:
in:
description: The thing
type: number
example: 929.15
out:
type: number
example: 286.06
period:
type: string
example: latest
transactions:
type: array
items:
type: object
properties:
amount:
type: number
example: 402.81
balance:
type: number
example: 871.61
date:
type: string
example: >-
Mon Oct 09 2023 18:38:56 GMT-0500 (Central Daylight
Time)
description:
type: string
example: McLaughlin, Rolfson and Mueller
type:
type: string
example: deposit
example:
- amount: 402.81
balance: 871.61
date: >-
Mon Oct 09 2023 18:38:56 GMT-0500 (Central Daylight
Time)
description: McLaughlin, Rolfson and Mueller
type: deposit
- amount: 84.71
balance: 161.04
date: >-
Mon Oct 09 2023 13:11:29 GMT-0500 (Central Daylight
Time)
description: DuBuque, Crist and Reilly
type: withdrawal
- amount: 428.64
balance: 307.55
date: >-
Mon Oct 09 2023 10:31:58 GMT-0500 (Central Daylight
Time)
description: Thiel - Turcotte
type: payment
- amount: 432.84
balance: 964.86
date: >-
Mon Oct 09 2023 12:07:32 GMT-0500 (Central Daylight
Time)
description: Reichel and Sons
type: deposit
- amount: 693.52
balance: 631.2
date: >-
Mon Oct 09 2023 16:33:45 GMT-0500 (Central Daylight
Time)
description: Gleason, Beatty and Erdman
type: withdrawal
- amount: 486.91
balance: 865.38
date: >-
Mon Oct 09 2023 18:01:47 GMT-0500 (Central Daylight
Time)
description: Lemke, Glover and Frami
type: invoice
- amount: 42.23
balance: 272.76
date: >-
Tue Oct 10 2023 00:58:52 GMT-0500 (Central Daylight
Time)
description: Cartwright - O'Conner
type: invoice
- amount: 231.86
balance: 959.1
date: >-
Mon Oct 09 2023 16:46:21 GMT-0500 (Central Daylight
Time)
description: Adams and Sons
type: payment
- amount: 540.18
balance: 726.1
date: >-
Mon Oct 09 2023 22:40:25 GMT-0500 (Central Daylight
Time)
description: Harvey, Ferry and Bruen
type: withdrawal
- amount: 565.76
balance: 922.8
date: >-
Tue Oct 10 2023 06:14:08 GMT-0500 (Central Daylight
Time)
description: Altenwerth, Rath and Hammes
type: payment
examples:
200 OK:
value:
balance:
closing: 979.96
opening: 335.77
money:
in: 929.15
out: 286.06
period: latest
transactions:
- amount: 402.81
balance: 871.61
date: >-
Mon Oct 09 2023 18:38:56 GMT-0500 (Central Daylight
Time)
description: McLaughlin, Rolfson and Mueller
type: deposit
- amount: 84.71
balance: 161.04
date: >-
Mon Oct 09 2023 13:11:29 GMT-0500 (Central Daylight
Time)
description: DuBuque, Crist and Reilly
type: withdrawal
- amount: 428.64
balance: 307.55
date: >-
Mon Oct 09 2023 10:31:58 GMT-0500 (Central Daylight
Time)
description: Thiel - Turcotte
type: payment
- amount: 432.84
balance: 964.86
date: >-
Mon Oct 09 2023 12:07:32 GMT-0500 (Central Daylight
Time)
description: Reichel and Sons
type: deposit
- amount: 693.52
balance: 631.2
date: >-
Mon Oct 09 2023 16:33:45 GMT-0500 (Central Daylight
Time)
description: Gleason, Beatty and Erdman
type: withdrawal
- amount: 486.91
balance: 865.38
date: >-
Mon Oct 09 2023 18:01:47 GMT-0500 (Central Daylight
Time)
description: Lemke, Glover and Frami
type: invoice
- amount: 42.23
balance: 272.76
date: >-
Tue Oct 10 2023 00:58:52 GMT-0500 (Central Daylight
Time)
description: Cartwright - O'Conner
type: invoice
- amount: 231.86
balance: 959.1
date: >-
Mon Oct 09 2023 16:46:21 GMT-0500 (Central Daylight
Time)
description: Adams and Sons
type: payment
- amount: 540.18
balance: 726.1
date: >-
Mon Oct 09 2023 22:40:25 GMT-0500 (Central Daylight
Time)
description: Harvey, Ferry and Bruen
type: withdrawal
- amount: 565.76
balance: 922.8
date: >-
Tue Oct 10 2023 06:14:08 GMT-0500 (Central Daylight
Time)
description: Altenwerth, Rath and Hammes
type: payment
/accounts/{accountNumber}/statement/date:
get:
tags:
- Statement
summary: Date
description: >-
Use the statement/date endpoint to retrieve the dates of the
transactions
operationId: date
parameters:
- name: accountNumber
in: path
required: true
schema:
type: string
example: 123ABC
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
from:
type: string
example: Wed Jan 11 2023 00:50:06 GMT-0600 (Central Standard Time)
to:
type: string
example: Mon Oct 09 2023 11:06:39 GMT-0500 (Central Daylight Time)
examples:
Date:
value:
from: Wed Jan 11 2023 00:50:06 GMT-0600 (Central Standard Time)
to: Mon Oct 09 2023 11:06:39 GMT-0500 (Central Daylight Time)
responses:
'200':
description: 200 OK
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: close
Content-Encoding:
schema:
type: string
example: gzip
Date:
schema:
type: string
example: Mon, 14 Jun 2021 14:30:25 GMT
ETag:
schema:
type: string
example: W/"96-S/5iQ2y1qqIInh5BwoPc+chvDJU"
Server:
schema:
type: string
example: nginx
Transfer-Encoding:
schema:
type: string
example: chunked
Vary:
schema:
type: string
example: Accept-Encoding
X-RateLimit-Limit:
schema:
type: string
example: '120'
X-RateLimit-Remaining:
schema:
type: string
example: '119'
X-RateLimit-Reset:
schema:
type: string
example: '1623681083'
x-srv-span:
schema:
type: string
example: v=1;s=210e5b055e5bd71e
x-srv-trace:
schema:
type: string
example: v=1;t=d33d68b932344fce
content:
application/json:
schema:
type: object
properties:
balance:
type: object
properties:
closing:
type: number
example: 458.28
opening:
type: number
example: 99.99
money:
type: object
properties:
in:
type: number
example: 164.88
out:
type: number
example: 579.77
period:
type: object
properties:
from:
type: string
example: MK0383607P93WT18330
to:
type: string
example: >-
Mon Oct 09 2023 11:34:41 GMT-0500 (Central Daylight
Time)
transactions:
type: array
items:
type: object
properties:
amount:
type: number
example: 717.65
balance:
type: number
example: 137.07
date:
type: string
example: >-
Mon Oct 09 2023 13:52:40 GMT-0500 (Central Daylight
Time)
description:
type: string
example: MacGyver LLC
type:
type: string
example: invoice
example:
- amount: 717.65
balance: 137.07
date: >-
Mon Oct 09 2023 13:52:40 GMT-0500 (Central Daylight
Time)
description: MacGyver LLC
type: invoice
- amount: 548.43
balance: 153.57
date: >-
Mon Oct 09 2023 16:27:31 GMT-0500 (Central Daylight
Time)
description: Beatty, Paucek and Gulgowski
type: payment
- amount: 141.57
balance: 621.31
date: >-
Tue Oct 10 2023 01:11:40 GMT-0500 (Central Daylight
Time)
description: Baumbach - Feest
type: payment
- amount: 961.64
balance: 673.77
date: >-
Mon Oct 09 2023 22:04:53 GMT-0500 (Central Daylight
Time)
description: Witting and Sons
type: payment
- amount: 283.83
balance: 431.27
date: >-
Mon Oct 09 2023 18:18:37 GMT-0500 (Central Daylight
Time)
description: Hoeger and Sons
type: invoice
- amount: 533.98
balance: 497.56
date: >-
Mon Oct 09 2023 15:10:26 GMT-0500 (Central Daylight
Time)
description: Collins - Rau
type: withdrawal
- amount: 311.25
balance: 309.01
date: >-
Mon Oct 09 2023 11:17:16 GMT-0500 (Central Daylight
Time)
description: Dickens, Goodwin and Swaniawski
type: deposit
- amount: 70.13
balance: 510.07
date: >-
Tue Oct 10 2023 07:51:59 GMT-0500 (Central Daylight
Time)
description: Kemmer - Simonis
type: deposit
- amount: 516.64
balance: 85.61
date: >-
Tue Oct 10 2023 05:18:37 GMT-0500 (Central Daylight
Time)
description: Johnston Inc
type: invoice
- amount: 236.84
balance: 451.95
date: >-
Tue Oct 10 2023 01:58:56 GMT-0500 (Central Daylight
Time)
description: Gulgowski LLC
type: withdrawal
examples:
200 OK:
value:
balance:
closing: 458.28
opening: 99.99
money:
in: 164.88
out: 579.77
period:
from: MK0383607P93WT18330
to: >-
Mon Oct 09 2023 11:34:41 GMT-0500 (Central Daylight
Time)
transactions:
- amount: 717.65
balance: 137.07
date: >-
Mon Oct 09 2023 13:52:40 GMT-0500 (Central Daylight
Time)
description: MacGyver LLC
type: invoice
- amount: 548.43
balance: 153.57
date: >-
Mon Oct 09 2023 16:27:31 GMT-0500 (Central Daylight
Time)
description: Beatty, Paucek and Gulgowski
type: payment
- amount: 141.57
balance: 621.31
date: >-
Tue Oct 10 2023 01:11:40 GMT-0500 (Central Daylight
Time)
description: Baumbach - Feest
type: payment
- amount: 961.64
balance: 673.77
date: >-
Mon Oct 09 2023 22:04:53 GMT-0500 (Central Daylight
Time)
description: Witting and Sons
type: payment
- amount: 283.83
balance: 431.27
date: >-
Mon Oct 09 2023 18:18:37 GMT-0500 (Central Daylight
Time)
description: Hoeger and Sons
type: invoice
- amount: 533.98
balance: 497.56
date: >-
Mon Oct 09 2023 15:10:26 GMT-0500 (Central Daylight
Time)
description: Collins - Rau
type: withdrawal
- amount: 311.25
balance: 309.01
date: >-
Mon Oct 09 2023 11:17:16 GMT-0500 (Central Daylight
Time)
description: Dickens, Goodwin and Swaniawski
type: deposit
- amount: 70.13
balance: 510.07
date: >-
Tue Oct 10 2023 07:51:59 GMT-0500 (Central Daylight
Time)
description: Kemmer - Simonis
type: deposit
- amount: 516.64
balance: 85.61
date: >-
Tue Oct 10 2023 05:18:37 GMT-0500 (Central Daylight
Time)
description: Johnston Inc
type: invoice
- amount: 236.84
balance: 451.95
date: >-
Tue Oct 10 2023 01:58:56 GMT-0500 (Central Daylight
Time)
description: Gulgowski LLC
type: withdrawal
/accounts/create:
post:
summary: Create
description: Hi everyone.
operationId: create
requestBody:
content:
application/json:
schema:
type: object
properties:
holder:
type: object
properties:
address:
type: object
properties:
city:
type: string
example: Hickleton
country:
type: string
example: Saint Vincent and the Grenadines
street:
type: string
example: 3475 King Mill
dob:
type: string
example: >-
Wed Mar 15 2023 10:33:20 GMT-0500 (Central Daylight
Time)
name:
type: object
properties:
first:
type: string
example: Leta
last:
type: string
example: Dickinson
middle:
type: string
example: Bradly
type:
type: string
example: Savings Account
examples:
Create:
value:
holder:
address:
city: Hickleton
country: Saint Vincent and the Grenadines
street: 3475 King Mill
dob: Wed Mar 15 2023 10:33:20 GMT-0500 (Central Daylight Time)
name:
first: Leta
last: Dickinson
middle: Bradly
type: Savings Account
responses:
'201':
description: 200 OK
content:
application/json:
schema:
type: object
properties:
details:
type: object
properties:
domestic:
type: object
properties:
account:
type: string
example: '02560233'
routing:
type: string
example: '71993962'
international:
type: object
properties:
bic:
type: string
example: PYAUISI1
iban:
type: string
example: AT780032406410040055
type:
type: string
example: Investment Account
examples:
200 OK:
value:
details:
domestic:
account: '02560233'
routing: '71993962'
international:
bic: PYAUISI1
iban: AT780032406410040055
type: Investment Account
/accounts/{accountNumber}/overview:
get:
summary: Overview
description: Overview
operationId: overview
parameters:
- name: accountNumber
in: path
required: true
schema:
type: string
example: 123ABC
responses:
'200':
description: 200 OK
content:
application/json:
schema:
type: object
properties:
balance:
type: object
properties:
available:
type: number
example: 109.58
present:
type: number
example: 265.53
details:
type: object
properties:
domestic:
type: object
properties:
account:
type: string
example: '34183769'
routing:
type: string
example: '69437301'
international:
type: object
properties:
bic:
type: string
example: AAQIMWT1
iban:
type: string
example: '{AL10010054848GYQ8536W4967Q3R}'
interestRate:
type: number
example: 0.01
lastStatementDate:
type: string
example: Tue Oct 10 2023 00:41:55 GMT-0500 (Central Daylight Time)
type:
type: string
example: Savings Account
examples:
200 OK:
value:
balance:
available: 109.58
present: 265.53
details:
domestic:
account: '34183769'
routing: '69437301'
international:
bic: AAQIMWT1
iban: '{AL10010054848GYQ8536W4967Q3R}'
interestRate: 0.01
lastStatementDate: Tue Oct 10 2023 00:41:55 GMT-0500 (Central Daylight Time)
type: Savings Account
components:
securitySchemes:
apiKey:
type: apiKey
name: x-api-key
in: header
security:
- apiKey: []
tags:
- name: Statement