@checkdigit/eslint-plugin 7.18.0-PR.143-13e8 → 7.18.0-PR.143-c222

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/LICENSE.txt +1 -1
  2. package/dist-mjs/openapi/service-schema-generator.mjs +26 -64
  3. package/package.json +1 -1
  4. package/src/openapi/service-schema-generator.ts +26 -74
  5. package/src/services/interchange/v1/swagger.schema.deref.json +16 -15
  6. package/src/services/ledger/v1/swagger.schema.deref.json +81 -81
  7. package/src/services/ledger/v2/swagger.schema.deref.json +4119 -0
  8. package/src/services/link/v1/swagger.schema.deref.json +13 -12
  9. package/src/services/link/{v1/swagger.schema.json → v2/swagger.schema.deref.json} +98 -28
  10. package/src/services/message/v1/swagger.schema.deref.json +731 -731
  11. package/src/services/message/v2/swagger.schema.deref.json +1017 -1017
  12. package/src/services/paymentCard/v1/swagger.schema.deref.json +248 -238
  13. package/src/services/paymentCard/v2/swagger.schema.deref.json +257 -274
  14. package/src/services/paymentCard/v3/swagger.schema.deref.json +2843 -0
  15. package/src/services/person/v1/swagger.schema.deref.json +111 -96
  16. package/src/services/person/v2/swagger.schema.deref.json +4931 -0
  17. package/src/services/teampayApproval/v1/swagger.schema.deref.json +2 -165
  18. package/src/services/teampayCardManagement/v1/swagger.schema.deref.json +220 -1768
  19. package/src/services/teampayClientManagement/v1/swagger.schema.deref.json +217 -217
  20. package/src/athena/ATHENA.md +0 -387
  21. package/src/athena/PLAN.md +0 -355
  22. package/src/services/interchange/v1/swagger.schema.json +0 -423
  23. package/src/services/interchange/v1/swagger.yml +0 -414
  24. package/src/services/ledger/v1/swagger.schema.json +0 -1048
  25. package/src/services/ledger/v1/swagger.yml +0 -1094
  26. package/src/services/link/v1/swagger.yml +0 -343
  27. package/src/services/message/v1/swagger.schema.json +0 -2944
  28. package/src/services/message/v1/swagger.yml +0 -2798
  29. package/src/services/message/v2/swagger.schema.json +0 -3040
  30. package/src/services/message/v2/swagger.yml +0 -3009
  31. package/src/services/paymentCard/v1/swagger.schema.json +0 -1687
  32. package/src/services/paymentCard/v1/swagger.yml +0 -1161
  33. package/src/services/paymentCard/v2/swagger.schema.json +0 -1649
  34. package/src/services/paymentCard/v2/swagger.yml +0 -1149
  35. package/src/services/person/v1/swagger.schema.json +0 -979
  36. package/src/services/person/v1/swagger.yml +0 -1157
  37. package/src/services/teampayClientManagement/v1/swagger.schema.json +0 -1598
  38. package/src/services/teampayClientManagement/v1/swagger.yml +0 -1376
package/src/services/teampayClientManagement/v1/swagger.schema.json DELETED
@@ -1,1598 +0,0 @@
1
- {
2
- "apis": {
3
- "/teampay-client-management/v1/ping": {},
4
- "/teampay-client-management/v1/client/:clientId": {
5
- "put": {
6
- "request": {
7
- "$schema": "https://json-schema.org/draft/2020-12/schema",
8
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/ClientPutRequestContext",
9
- "type": "object",
10
- "properties": {
11
- "params": {
12
- "type": "object",
13
- "additionalProperties": false,
14
- "properties": {
15
- "clientId": {
16
- "$ref": "/teampay-client-management/v1/schemas/definitions/ClientId"
17
- }
18
- },
19
- "required": ["clientId"]
20
- },
21
- "headers": {
22
- "type": "object",
23
- "additionalProperties": true,
24
- "properties": {
25
- "if-match": {
26
- "type": "string"
27
- }
28
- }
29
- },
30
- "body": {
31
- "$ref": "/teampay-client-management/v1/schemas/definitions/NewClient"
32
- }
33
- },
34
- "required": ["params", "body"],
35
- "additionalProperties": false
36
- },
37
- "responses": {
38
- "200": {
39
- "$schema": "https://json-schema.org/draft/2020-12/schema",
40
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/ClientPutResponseOK",
41
- "type": "object",
42
- "properties": {
43
- "headers": {
44
- "type": "object",
45
- "properties": {
46
- "last-modified": {
47
- "type": "string",
48
- "format": "date-time"
49
- },
50
- "created-on": {
51
- "type": "string",
52
- "format": "date-time"
53
- },
54
- "updated-on": {
55
- "type": "string",
56
- "format": "date-time"
57
- },
58
- "etag": {
59
- "type": "string"
60
- }
61
- },
62
- "required": ["last-modified", "created-on", "updated-on", "etag"]
63
- },
64
- "body": {
65
- "$ref": "/teampay-client-management/v1/schemas/definitions/Client"
66
- }
67
- },
68
- "required": ["headers", "body"],
69
- "additionalProperties": false
70
- },
71
- "409": {
72
- "$schema": "https://json-schema.org/draft/2020-12/schema",
73
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/ClientPutResponseConflict",
74
- "type": "object",
75
- "properties": {
76
- "headers": {
77
- "type": "object",
78
- "additionalProperties": true
79
- }
80
- },
81
- "required": [],
82
- "additionalProperties": false
83
- },
84
- "412": {
85
- "$schema": "https://json-schema.org/draft/2020-12/schema",
86
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/ClientPutResponsePreconditionFailed",
87
- "type": "object",
88
- "properties": {
89
- "headers": {
90
- "type": "object",
91
- "additionalProperties": true
92
- }
93
- },
94
- "required": [],
95
- "additionalProperties": false
96
- },
97
- "default": {
98
- "$schema": "https://json-schema.org/draft/2020-12/schema",
99
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/ClientPutResponseDefault",
100
- "type": "object",
101
- "properties": {
102
- "headers": {
103
- "type": "object",
104
- "additionalProperties": true
105
- },
106
- "body": {
107
- "$ref": "/teampay-client-management/v1/schemas/definitions/Error"
108
- }
109
- },
110
- "required": ["body"],
111
- "additionalProperties": false
112
- }
113
- }
114
- }
115
- },
116
- "/teampay-client-management/v1/client/:clientId/balance": {},
117
- "/teampay-client-management/v1/ach-payment-source/:achPaymentSourceId": {
118
- "put": {
119
- "request": {
120
- "$schema": "https://json-schema.org/draft/2020-12/schema",
121
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/AchPaymentSourcePutRequestContext",
122
- "type": "object",
123
- "properties": {
124
- "params": {
125
- "type": "object",
126
- "additionalProperties": false,
127
- "properties": {
128
- "achPaymentSourceId": {
129
- "$ref": "/teampay-client-management/v1/schemas/definitions/AchPaymentSourceId"
130
- }
131
- },
132
- "required": ["achPaymentSourceId"]
133
- },
134
- "headers": {
135
- "type": "object",
136
- "additionalProperties": true
137
- },
138
- "body": {
139
- "$ref": "/teampay-client-management/v1/schemas/definitions/NewClientAchPaymentSource"
140
- }
141
- },
142
- "required": ["params", "body"],
143
- "additionalProperties": false
144
- },
145
- "responses": {
146
- "200": {
147
- "$schema": "https://json-schema.org/draft/2020-12/schema",
148
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/AchPaymentSourcePutResponseOK",
149
- "type": "object",
150
- "properties": {
151
- "headers": {
152
- "type": "object",
153
- "properties": {
154
- "last-modified": {
155
- "type": "string",
156
- "format": "date-time"
157
- },
158
- "created-on": {
159
- "type": "string",
160
- "format": "date-time"
161
- },
162
- "updated-on": {
163
- "type": "string",
164
- "format": "date-time"
165
- }
166
- },
167
- "required": ["last-modified", "created-on", "updated-on"]
168
- },
169
- "body": {
170
- "$ref": "/teampay-client-management/v1/schemas/definitions/ClientAchPaymentSource"
171
- }
172
- },
173
- "required": ["headers", "body"],
174
- "additionalProperties": false
175
- },
176
- "409": {
177
- "$schema": "https://json-schema.org/draft/2020-12/schema",
178
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/AchPaymentSourcePutResponseConflict",
179
- "type": "object",
180
- "properties": {
181
- "headers": {
182
- "type": "object",
183
- "additionalProperties": true
184
- }
185
- },
186
- "required": [],
187
- "additionalProperties": false
188
- },
189
- "default": {
190
- "$schema": "https://json-schema.org/draft/2020-12/schema",
191
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/AchPaymentSourcePutResponseDefault",
192
- "type": "object",
193
- "properties": {
194
- "headers": {
195
- "type": "object",
196
- "additionalProperties": true
197
- },
198
- "body": {
199
- "$ref": "/teampay-client-management/v1/schemas/definitions/Error"
200
- }
201
- },
202
- "required": ["body"],
203
- "additionalProperties": false
204
- }
205
- }
206
- }
207
- },
208
- "/teampay-client-management/v1/client/:clientId/ach-payment-sources": {},
209
- "/teampay-client-management/v1/request/:paymentId": {
210
- "put": {
211
- "request": {
212
- "$schema": "https://json-schema.org/draft/2020-12/schema",
213
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/RequestPaymentPutRequestContext",
214
- "type": "object",
215
- "properties": {
216
- "params": {
217
- "type": "object",
218
- "additionalProperties": false,
219
- "properties": {
220
- "paymentId": {
221
- "type": "string",
222
- "format": "uuid"
223
- }
224
- },
225
- "required": ["paymentId"]
226
- },
227
- "headers": {
228
- "type": "object",
229
- "additionalProperties": true
230
- },
231
- "body": {
232
- "$ref": "/teampay-client-management/v1/schemas/definitions/NewPayment"
233
- }
234
- },
235
- "required": ["params", "body"],
236
- "additionalProperties": false
237
- },
238
- "responses": {
239
- "200": {
240
- "$schema": "https://json-schema.org/draft/2020-12/schema",
241
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/RequestPaymentPutResponseOK",
242
- "type": "object",
243
- "properties": {
244
- "headers": {
245
- "type": "object",
246
- "properties": {
247
- "last-modified": {
248
- "type": "string",
249
- "format": "date-time"
250
- },
251
- "created-on": {
252
- "type": "string",
253
- "format": "date-time"
254
- },
255
- "updated-on": {
256
- "type": "string",
257
- "format": "date-time"
258
- }
259
- },
260
- "required": ["last-modified", "created-on", "updated-on"]
261
- },
262
- "body": {
263
- "$ref": "/teampay-client-management/v1/schemas/definitions/PayOrRequestPaymentResponse"
264
- }
265
- },
266
- "required": ["headers", "body"],
267
- "additionalProperties": false
268
- },
269
- "409": {
270
- "$schema": "https://json-schema.org/draft/2020-12/schema",
271
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/RequestPaymentPutResponseConflict",
272
- "type": "object",
273
- "properties": {
274
- "headers": {
275
- "type": "object",
276
- "additionalProperties": true
277
- }
278
- },
279
- "required": [],
280
- "additionalProperties": false
281
- },
282
- "default": {
283
- "$schema": "https://json-schema.org/draft/2020-12/schema",
284
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/RequestPaymentPutResponseDefault",
285
- "type": "object",
286
- "properties": {
287
- "headers": {
288
- "type": "object",
289
- "additionalProperties": true
290
- },
291
- "body": {
292
- "$ref": "/teampay-client-management/v1/schemas/definitions/Error"
293
- }
294
- },
295
- "required": ["body"],
296
- "additionalProperties": false
297
- }
298
- }
299
- }
300
- },
301
- "/teampay-client-management/v1/pay/:paymentId": {
302
- "put": {
303
- "request": {
304
- "$schema": "https://json-schema.org/draft/2020-12/schema",
305
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/PayPaymentPutRequestContext",
306
- "type": "object",
307
- "properties": {
308
- "params": {
309
- "type": "object",
310
- "additionalProperties": false,
311
- "properties": {
312
- "paymentId": {
313
- "type": "string",
314
- "format": "uuid"
315
- }
316
- },
317
- "required": ["paymentId"]
318
- },
319
- "headers": {
320
- "type": "object",
321
- "additionalProperties": true
322
- },
323
- "body": {
324
- "$ref": "/teampay-client-management/v1/schemas/definitions/NewPayment"
325
- }
326
- },
327
- "required": ["params", "body"],
328
- "additionalProperties": false
329
- },
330
- "responses": {
331
- "200": {
332
- "$schema": "https://json-schema.org/draft/2020-12/schema",
333
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/PayPaymentPutResponseOK",
334
- "type": "object",
335
- "properties": {
336
- "headers": {
337
- "type": "object",
338
- "properties": {
339
- "last-modified": {
340
- "type": "string",
341
- "format": "date-time"
342
- },
343
- "created-on": {
344
- "type": "string",
345
- "format": "date-time"
346
- },
347
- "updated-on": {
348
- "type": "string",
349
- "format": "date-time"
350
- }
351
- },
352
- "required": ["last-modified", "created-on", "updated-on"]
353
- },
354
- "body": {
355
- "$ref": "/teampay-client-management/v1/schemas/definitions/PayOrRequestPaymentResponse"
356
- }
357
- },
358
- "required": ["headers", "body"],
359
- "additionalProperties": false
360
- },
361
- "409": {
362
- "$schema": "https://json-schema.org/draft/2020-12/schema",
363
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/PayPaymentPutResponseConflict",
364
- "type": "object",
365
- "properties": {
366
- "headers": {
367
- "type": "object",
368
- "additionalProperties": true
369
- }
370
- },
371
- "required": [],
372
- "additionalProperties": false
373
- },
374
- "default": {
375
- "$schema": "https://json-schema.org/draft/2020-12/schema",
376
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/PayPaymentPutResponseDefault",
377
- "type": "object",
378
- "properties": {
379
- "headers": {
380
- "type": "object",
381
- "additionalProperties": true
382
- },
383
- "body": {
384
- "$ref": "/teampay-client-management/v1/schemas/definitions/Error"
385
- }
386
- },
387
- "required": ["body"],
388
- "additionalProperties": false
389
- }
390
- }
391
- }
392
- },
393
- "/teampay-client-management/v1/cancel/:paymentId": {
394
- "put": {
395
- "request": {
396
- "$schema": "https://json-schema.org/draft/2020-12/schema",
397
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CancelPaymentPutRequestContext",
398
- "type": "object",
399
- "properties": {
400
- "params": {
401
- "type": "object",
402
- "additionalProperties": false,
403
- "properties": {
404
- "paymentId": {
405
- "type": "string",
406
- "format": "uuid"
407
- }
408
- },
409
- "required": ["paymentId"]
410
- },
411
- "headers": {
412
- "type": "object",
413
- "additionalProperties": true
414
- }
415
- },
416
- "required": ["params"],
417
- "additionalProperties": false
418
- },
419
- "responses": {
420
- "200": {
421
- "$schema": "https://json-schema.org/draft/2020-12/schema",
422
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CancelPaymentPutResponseOK",
423
- "type": "object",
424
- "properties": {
425
- "headers": {
426
- "type": "object",
427
- "properties": {
428
- "last-modified": {
429
- "type": "string",
430
- "format": "date-time"
431
- },
432
- "created-on": {
433
- "type": "string",
434
- "format": "date-time"
435
- },
436
- "updated-on": {
437
- "type": "string",
438
- "format": "date-time"
439
- }
440
- },
441
- "required": ["last-modified", "created-on", "updated-on"]
442
- },
443
- "body": {
444
- "$ref": "/teampay-client-management/v1/schemas/definitions/CancelPaymentResponse"
445
- }
446
- },
447
- "required": ["headers", "body"],
448
- "additionalProperties": false
449
- },
450
- "412": {
451
- "$schema": "https://json-schema.org/draft/2020-12/schema",
452
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CancelPaymentPutResponsePreconditionFailed",
453
- "type": "object",
454
- "properties": {
455
- "headers": {
456
- "type": "object",
457
- "additionalProperties": true
458
- }
459
- },
460
- "required": [],
461
- "additionalProperties": false
462
- },
463
- "default": {
464
- "$schema": "https://json-schema.org/draft/2020-12/schema",
465
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CancelPaymentPutResponseDefault",
466
- "type": "object",
467
- "properties": {
468
- "headers": {
469
- "type": "object",
470
- "additionalProperties": true
471
- },
472
- "body": {
473
- "$ref": "/teampay-client-management/v1/schemas/definitions/Error"
474
- }
475
- },
476
- "required": ["body"],
477
- "additionalProperties": false
478
- }
479
- }
480
- }
481
- },
482
- "/teampay-client-management/v1/credit-account-adjustment/:entryId": {
483
- "put": {
484
- "request": {
485
- "$schema": "https://json-schema.org/draft/2020-12/schema",
486
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CreditAccountAdjustmentPutRequestContext",
487
- "type": "object",
488
- "properties": {
489
- "params": {
490
- "type": "object",
491
- "additionalProperties": false,
492
- "properties": {
493
- "entryId": {
494
- "type": "string",
495
- "format": "uuid"
496
- }
497
- },
498
- "required": ["entryId"]
499
- },
500
- "headers": {
501
- "type": "object",
502
- "additionalProperties": true
503
- },
504
- "body": {
505
- "$ref": "/teampay-client-management/v1/schemas/definitions/NewCreditAccountEntry"
506
- }
507
- },
508
- "required": ["params", "body"],
509
- "additionalProperties": false
510
- },
511
- "responses": {
512
- "204": {
513
- "$schema": "https://json-schema.org/draft/2020-12/schema",
514
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CreditAccountAdjustmentPutResponseNoContent",
515
- "type": "object",
516
- "properties": {
517
- "headers": {
518
- "type": "object",
519
- "properties": {
520
- "last-modified": {
521
- "type": "string",
522
- "format": "date-time"
523
- },
524
- "created-on": {
525
- "type": "string",
526
- "format": "date-time"
527
- },
528
- "updated-on": {
529
- "type": "string",
530
- "format": "date-time"
531
- }
532
- },
533
- "required": ["last-modified", "created-on", "updated-on"]
534
- }
535
- },
536
- "required": ["headers"],
537
- "additionalProperties": false
538
- },
539
- "409": {
540
- "$schema": "https://json-schema.org/draft/2020-12/schema",
541
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CreditAccountAdjustmentPutResponseConflict",
542
- "type": "object",
543
- "properties": {
544
- "headers": {
545
- "type": "object",
546
- "additionalProperties": true
547
- }
548
- },
549
- "required": [],
550
- "additionalProperties": false
551
- },
552
- "default": {
553
- "$schema": "https://json-schema.org/draft/2020-12/schema",
554
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CreditAccountAdjustmentPutResponseDefault",
555
- "type": "object",
556
- "properties": {
557
- "headers": {
558
- "type": "object",
559
- "additionalProperties": true
560
- },
561
- "body": {
562
- "$ref": "/teampay-client-management/v1/schemas/definitions/Error"
563
- }
564
- },
565
- "required": ["body"],
566
- "additionalProperties": false
567
- }
568
- }
569
- }
570
- },
571
- "/teampay-client-management/v1/credit-account-payment/:entryId": {
572
- "put": {
573
- "request": {
574
- "$schema": "https://json-schema.org/draft/2020-12/schema",
575
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CreditAccountPaymentPutRequestContext",
576
- "type": "object",
577
- "properties": {
578
- "params": {
579
- "type": "object",
580
- "additionalProperties": false,
581
- "properties": {
582
- "entryId": {
583
- "type": "string",
584
- "format": "uuid"
585
- }
586
- },
587
- "required": ["entryId"]
588
- },
589
- "headers": {
590
- "type": "object",
591
- "additionalProperties": true
592
- },
593
- "body": {
594
- "$ref": "/teampay-client-management/v1/schemas/definitions/NewCreditAccountEntry"
595
- }
596
- },
597
- "required": ["params", "body"],
598
- "additionalProperties": false
599
- },
600
- "responses": {
601
- "204": {
602
- "$schema": "https://json-schema.org/draft/2020-12/schema",
603
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CreditAccountPaymentPutResponseNoContent",
604
- "type": "object",
605
- "properties": {
606
- "headers": {
607
- "type": "object",
608
- "properties": {
609
- "last-modified": {
610
- "type": "string",
611
- "format": "date-time"
612
- },
613
- "created-on": {
614
- "type": "string",
615
- "format": "date-time"
616
- },
617
- "updated-on": {
618
- "type": "string",
619
- "format": "date-time"
620
- }
621
- },
622
- "required": ["last-modified", "created-on", "updated-on"]
623
- }
624
- },
625
- "required": ["headers"],
626
- "additionalProperties": false
627
- },
628
- "409": {
629
- "$schema": "https://json-schema.org/draft/2020-12/schema",
630
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CreditAccountPaymentPutResponseConflict",
631
- "type": "object",
632
- "properties": {
633
- "headers": {
634
- "type": "object",
635
- "additionalProperties": true
636
- }
637
- },
638
- "required": [],
639
- "additionalProperties": false
640
- },
641
- "default": {
642
- "$schema": "https://json-schema.org/draft/2020-12/schema",
643
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CreditAccountPaymentPutResponseDefault",
644
- "type": "object",
645
- "properties": {
646
- "headers": {
647
- "type": "object",
648
- "additionalProperties": true
649
- },
650
- "body": {
651
- "$ref": "/teampay-client-management/v1/schemas/definitions/Error"
652
- }
653
- },
654
- "required": ["body"],
655
- "additionalProperties": false
656
- }
657
- }
658
- }
659
- },
660
- "/teampay-client-management/v1/correction/:entryId": {
661
- "put": {
662
- "request": {
663
- "$schema": "https://json-schema.org/draft/2020-12/schema",
664
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CorrectionPutRequestContext",
665
- "type": "object",
666
- "properties": {
667
- "params": {
668
- "type": "object",
669
- "additionalProperties": false,
670
- "properties": {
671
- "entryId": {
672
- "type": "string",
673
- "format": "uuid"
674
- }
675
- },
676
- "required": ["entryId"]
677
- },
678
- "headers": {
679
- "type": "object",
680
- "additionalProperties": true
681
- },
682
- "body": {
683
- "$ref": "/teampay-client-management/v1/schemas/definitions/NewCorrectionAccountEntry"
684
- }
685
- },
686
- "required": ["params", "body"],
687
- "additionalProperties": false
688
- },
689
- "responses": {
690
- "204": {
691
- "$schema": "https://json-schema.org/draft/2020-12/schema",
692
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CorrectionPutResponseNoContent",
693
- "type": "object",
694
- "properties": {
695
- "headers": {
696
- "type": "object",
697
- "properties": {
698
- "last-modified": {
699
- "type": "string",
700
- "format": "date-time"
701
- },
702
- "created-on": {
703
- "type": "string",
704
- "format": "date-time"
705
- },
706
- "updated-on": {
707
- "type": "string",
708
- "format": "date-time"
709
- }
710
- },
711
- "required": ["last-modified", "created-on", "updated-on"]
712
- }
713
- },
714
- "required": ["headers"],
715
- "additionalProperties": false
716
- },
717
- "409": {
718
- "$schema": "https://json-schema.org/draft/2020-12/schema",
719
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CorrectionPutResponseConflict",
720
- "type": "object",
721
- "properties": {
722
- "headers": {
723
- "type": "object",
724
- "additionalProperties": true
725
- }
726
- },
727
- "required": [],
728
- "additionalProperties": false
729
- },
730
- "default": {
731
- "$schema": "https://json-schema.org/draft/2020-12/schema",
732
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/api/CorrectionPutResponseDefault",
733
- "type": "object",
734
- "properties": {
735
- "headers": {
736
- "type": "object",
737
- "additionalProperties": true
738
- },
739
- "body": {
740
- "$ref": "/teampay-client-management/v1/schemas/definitions/Error"
741
- }
742
- },
743
- "required": ["body"],
744
- "additionalProperties": false
745
- }
746
- }
747
- }
748
- }
749
- },
750
- "definitions": {
751
- "Ping": {
752
- "$schema": "https://json-schema.org/draft/2020-12/schema",
753
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Ping",
754
- "type": "object",
755
- "additionalProperties": false,
756
- "required": ["serverTime"],
757
- "properties": {
758
- "serverTime": {
759
- "type": "string",
760
- "format": "date-time",
761
- "description": "Current server time"
762
- }
763
- }
764
- },
765
- "Error": {
766
- "$schema": "https://json-schema.org/draft/2020-12/schema",
767
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Error",
768
- "type": "object",
769
- "additionalProperties": false,
770
- "description": "Server error message",
771
- "properties": {
772
- "message": {
773
- "type": "string"
774
- },
775
- "code": {
776
- "type": "string"
777
- }
778
- }
779
- },
780
- "NewClient": {
781
- "$schema": "https://json-schema.org/draft/2020-12/schema",
782
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/NewClient",
783
- "type": "object",
784
- "additionalProperties": false,
785
- "description": "New client request schema.",
786
- "required": ["name", "address", "issuingCountryCode", "products", "limits"],
787
- "properties": {
788
- "name": {
789
- "$ref": "/teampay-client-management/v1/schemas/definitions/Name"
790
- },
791
- "address": {
792
- "$ref": "/teampay-client-management/v1/schemas/definitions/Address"
793
- },
794
- "issuingCountryCode": {
795
- "$ref": "/teampay-client-management/v1/schemas/definitions/IssuingCountryCode"
796
- },
797
- "products": {
798
- "$ref": "/teampay-client-management/v1/schemas/definitions/Products"
799
- },
800
- "limits": {
801
- "$ref": "/teampay-client-management/v1/schemas/definitions/Limits"
802
- },
803
- "funding": {
804
- "$ref": "/teampay-client-management/v1/schemas/definitions/Funding"
805
- },
806
- "active": {
807
- "$ref": "/teampay-client-management/v1/schemas/definitions/ActiveStatus"
808
- },
809
- "subsidiaryOf": {
810
- "$ref": "/teampay-client-management/v1/schemas/definitions/SubsidiaryOf"
811
- }
812
- }
813
- },
814
- "Client": {
815
- "$schema": "https://json-schema.org/draft/2020-12/schema",
816
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Client",
817
- "type": "object",
818
- "additionalProperties": false,
819
- "description": "Client Schema.",
820
- "required": [
821
- "name",
822
- "address",
823
- "issuingCountryCode",
824
- "limits",
825
- "products",
826
- "clientAccountId",
827
- "lastModified",
828
- "createdOn",
829
- "funding",
830
- "active",
831
- "configurationId"
832
- ],
833
- "properties": {
834
- "name": {
835
- "$ref": "/teampay-client-management/v1/schemas/definitions/Name"
836
- },
837
- "address": {
838
- "$ref": "/teampay-client-management/v1/schemas/definitions/Address"
839
- },
840
- "issuingCountryCode": {
841
- "$ref": "/teampay-client-management/v1/schemas/definitions/IssuingCountryCode"
842
- },
843
- "limits": {
844
- "$ref": "/teampay-client-management/v1/schemas/definitions/Limits"
845
- },
846
- "products": {
847
- "$ref": "/teampay-client-management/v1/schemas/definitions/Products"
848
- },
849
- "clientAccountId": {
850
- "type": "string",
851
- "description": "The ledger account that holds the funds which are spendable by cardholders linked to the client."
852
- },
853
- "lastModified": {
854
- "$ref": "/teampay-client-management/v1/schemas/definitions/LastModified"
855
- },
856
- "createdOn": {
857
- "$ref": "/teampay-client-management/v1/schemas/definitions/CreatedOn"
858
- },
859
- "updatedOn": {
860
- "$ref": "/teampay-client-management/v1/schemas/definitions/UpdatedOn"
861
- },
862
- "funding": {
863
- "$ref": "/teampay-client-management/v1/schemas/definitions/Funding"
864
- },
865
- "active": {
866
- "$ref": "/teampay-client-management/v1/schemas/definitions/ActiveStatus"
867
- },
868
- "configurationId": {
869
- "type": "string",
870
- "description": "The unique identifier for the client's configuration data."
871
- },
872
- "subsidiaryOf": {
873
- "$ref": "/teampay-client-management/v1/schemas/definitions/SubsidiaryOf"
874
- }
875
- }
876
- },
877
- "Products": {
878
- "$schema": "https://json-schema.org/draft/2020-12/schema",
879
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Products",
880
- "type": "array",
881
- "minItems": 1,
882
- "description": "Array of products that are applicable to the client",
883
- "items": {
884
- "$ref": "/teampay-client-management/v1/schemas/definitions/Product"
885
- }
886
- },
887
- "IssuingCountryCode": {
888
- "$schema": "https://json-schema.org/draft/2020-12/schema",
889
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/IssuingCountryCode",
890
- "type": "string",
891
- "description": "The country in which the cards are issued",
892
- "enum": ["US", "CA"]
893
- },
894
- "Limits": {
895
- "$schema": "https://json-schema.org/draft/2020-12/schema",
896
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Limits",
897
- "type": "array",
898
- "minItems": 0,
899
- "description": "An array of limits that apply at the organization level.\nThe organization level represents the combined total of all card transactions for the client.\n",
900
- "items": {
901
- "$ref": "/teampay-client-management/v1/schemas/definitions/Limit"
902
- }
903
- },
904
- "Limit": {
905
- "$schema": "https://json-schema.org/draft/2020-12/schema",
906
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Limit",
907
- "type": "object",
908
- "additionalProperties": false,
909
- "description": "Limit Details\n- There can only be one limit per client for each period, periodLength, and limitFunction combination.\n Multiple limits with the same values for the combination of properties listed above will result in a 400 Bad Request.\n",
910
- "required": ["period", "periodLength", "limitFunction", "value"],
911
- "properties": {
912
- "period": {
913
- "$ref": "/teampay-client-management/v1/schemas/definitions/Period"
914
- },
915
- "periodLength": {
916
- "$ref": "/teampay-client-management/v1/schemas/definitions/PeriodLength"
917
- },
918
- "limitFunction": {
919
- "$ref": "/teampay-client-management/v1/schemas/definitions/LimitFunction"
920
- },
921
- "value": {
922
- "$ref": "/teampay-client-management/v1/schemas/definitions/LimitValue"
923
- }
924
- }
925
- },
926
- "Period": {
927
- "$schema": "https://json-schema.org/draft/2020-12/schema",
928
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Period",
929
- "type": "string",
930
- "description": "DAY is a calendar day and will begin at 00:00:00 UTC.\nMONTH is a calendar month and will begin on the first day of the month at 00:00:00 UTC.\nAll periods are rolling if the associated periodLength is greater than 1\n",
931
- "enum": ["DAY", "MONTH"]
932
- },
933
- "LimitFunction": {
934
- "$schema": "https://json-schema.org/draft/2020-12/schema",
935
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/LimitFunction",
936
- "type": "string",
937
- "description": "AMOUNT functions by summing up the aggregate data point values.",
938
- "enum": ["AMOUNT"]
939
- },
940
- "Product": {
941
- "$schema": "https://json-schema.org/draft/2020-12/schema",
942
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Product",
943
- "type": "string",
944
- "description": "Type of card product",
945
- "enum": ["VIRTUAL", "STANDARD", "PREMIUM"]
946
- },
947
- "PeriodLength": {
948
- "$schema": "https://json-schema.org/draft/2020-12/schema",
949
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/PeriodLength",
950
- "type": "string",
951
- "pattern": "^\\d+$",
952
- "minLength": 1,
953
- "description": "How long the period lasts"
954
- },
955
- "LimitValue": {
956
- "$schema": "https://json-schema.org/draft/2020-12/schema",
957
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/LimitValue",
958
- "type": "string",
959
- "pattern": "^\\d+$",
960
- "minLength": 1,
961
- "description": "Limit value to use. The value is expected to be in cents."
962
- },
963
- "Name": {
964
- "$schema": "https://json-schema.org/draft/2020-12/schema",
965
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Name",
966
- "type": "string",
967
- "description": "The name of the client.",
968
- "minLength": 1
969
- },
970
- "NewClientAchPaymentSource": {
971
- "$schema": "https://json-schema.org/draft/2020-12/schema",
972
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/NewClientAchPaymentSource",
973
- "type": "object",
974
- "additionalProperties": false,
975
- "description": "New client ACH payment source details",
976
- "required": ["clientId", "achPaymentSource", "transmissionKey"],
977
- "properties": {
978
- "clientId": {
979
- "$ref": "/teampay-client-management/v1/schemas/definitions/ClientId"
980
- },
981
- "achPaymentSource": {
982
- "$ref": "/teampay-client-management/v1/schemas/definitions/AchPaymentSource"
983
- },
984
- "transmissionKey": {
985
- "$ref": "/teampay-client-management/v1/schemas/definitions/TransmissionKey"
986
- }
987
- }
988
- },
989
- "ClientId": {
990
- "$schema": "https://json-schema.org/draft/2020-12/schema",
991
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/ClientId",
992
- "type": "string",
993
- "description": "The Unique identifier for the client in uuid format",
994
- "format": "uuid"
995
- },
996
- "CreatedOn": {
997
- "$schema": "https://json-schema.org/draft/2020-12/schema",
998
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/CreatedOn",
999
- "type": "string",
1000
- "format": "date-time",
1001
- "description": "Original created on date time"
1002
- },
1003
- "LastModified": {
1004
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1005
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/LastModified",
1006
- "type": "string",
1007
- "format": "date-time",
1008
- "description": "Resource last modified date time"
1009
- },
1010
- "UpdatedOn": {
1011
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1012
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/UpdatedOn",
1013
- "type": "string",
1014
- "format": "date-time",
1015
- "description": "Resource last modified date time"
1016
- },
1017
- "AchPaymentSource": {
1018
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1019
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/AchPaymentSource",
1020
- "type": "object",
1021
- "additionalProperties": false,
1022
- "description": "ACH Payment Source",
1023
- "required": ["accountName", "accountType", "accountNumber", "routingNumber"],
1024
- "properties": {
1025
- "accountName": {
1026
- "$ref": "/teampay-client-management/v1/schemas/definitions/AccountName"
1027
- },
1028
- "accountType": {
1029
- "$ref": "/teampay-client-management/v1/schemas/definitions/AccountType"
1030
- },
1031
- "accountNumber": {
1032
- "$ref": "/teampay-client-management/v1/schemas/definitions/AccountNumber"
1033
- },
1034
- "routingNumber": {
1035
- "$ref": "/teampay-client-management/v1/schemas/definitions/RoutingNumber"
1036
- }
1037
- }
1038
- },
1039
- "AccountName": {
1040
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1041
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/AccountName",
1042
- "type": "string",
1043
- "description": "Name of the account owner, encrypted. The following conditions not being met will result in a 400 Bad Request:\n- Must be less than or equal to 22 characters long\n- Must contain only alphanumeric and space characters\n",
1044
- "minLength": 1
1045
- },
1046
- "AccountType": {
1047
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1048
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/AccountType",
1049
- "type": "string",
1050
- "description": "Type of account",
1051
- "minLength": 1,
1052
- "enum": ["CHECKING", "SAVINGS"]
1053
- },
1054
- "AccountNumber": {
1055
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1056
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/AccountNumber",
1057
- "type": "string",
1058
- "description": "Account number, encrypted. The following conditions not being met will result in a 400 Bad Request:\n- Must be less than or equal to 17 characters long\n- Must contain only numerical digits\n- Must not only contain zeros\n",
1059
- "minLength": 1
1060
- },
1061
- "RoutingNumber": {
1062
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1063
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/RoutingNumber",
1064
- "type": "string",
1065
- "description": "Routing number, encrypted. The following conditions not being met will result in a 400 Bad Request:\n- Must be a valid bank routing number\n- Must be 9 characters\n- Must contain only numerical digits\n- Must not only contain zeros\n",
1066
- "minLength": 1
1067
- },
1068
- "ClientAchPaymentSource": {
1069
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1070
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/ClientAchPaymentSource",
1071
- "type": "object",
1072
- "additionalProperties": false,
1073
- "description": "Client ACH Payment Source Details",
1074
- "required": [
1075
- "achPaymentSourceId",
1076
- "clientId",
1077
- "transmissionKey",
1078
- "storageKeyId",
1079
- "achPaymentSource",
1080
- "lastModified",
1081
- "createdOn"
1082
- ],
1083
- "properties": {
1084
- "achPaymentSourceId": {
1085
- "$ref": "/teampay-client-management/v1/schemas/definitions/AchPaymentSourceId"
1086
- },
1087
- "clientId": {
1088
- "$ref": "/teampay-client-management/v1/schemas/definitions/ClientId"
1089
- },
1090
- "transmissionKey": {
1091
- "$ref": "/teampay-client-management/v1/schemas/definitions/TransmissionKey"
1092
- },
1093
- "storageKeyId": {
1094
- "$ref": "/teampay-client-management/v1/schemas/definitions/StorageKeyId"
1095
- },
1096
- "achPaymentSource": {
1097
- "$ref": "/teampay-client-management/v1/schemas/definitions/AchPaymentSource"
1098
- },
1099
- "lastModified": {
1100
- "$ref": "/teampay-client-management/v1/schemas/definitions/LastModified"
1101
- },
1102
- "createdOn": {
1103
- "$ref": "/teampay-client-management/v1/schemas/definitions/CreatedOn"
1104
- },
1105
- "updatedOn": {
1106
- "$ref": "/teampay-client-management/v1/schemas/definitions/UpdatedOn"
1107
- }
1108
- }
1109
- },
1110
- "NewPayment": {
1111
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1112
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/NewPayment",
1113
- "type": "object",
1114
- "additionalProperties": false,
1115
- "description": "Payment details",
1116
- "required": ["paymentSourceId", "clientId", "amount"],
1117
- "properties": {
1118
- "paymentSourceId": {
1119
- "type": "string",
1120
- "description": "Identifier of a payment source from/to which funds are requested/paid.\nThe payment source must be associated with the client whose clientId is being submitted in the request or\na 400 Bad Request will be returned.\n"
1121
- },
1122
- "clientId": {
1123
- "type": "string",
1124
- "description": "The client whose account will be DEBITED/CREDITED funds from/to when the request/pay transaction is accepted."
1125
- },
1126
- "amount": {
1127
- "type": "string",
1128
- "pattern": "^[1-9]\\d*$",
1129
- "minLength": 1,
1130
- "maxLength": 9,
1131
- "description": "The amount to be credited or debited.\nThe value is expected to be in cents.\nAs an example, a value of 100 would be equal to 1 dollar\n"
1132
- },
1133
- "companyEntryDescription": {
1134
- "$ref": "/teampay-client-management/v1/schemas/definitions/CompanyEntryDescription"
1135
- }
1136
- }
1137
- },
1138
- "AchPaymentSourceId": {
1139
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1140
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/AchPaymentSourceId",
1141
- "type": "string",
1142
- "description": "Identifier for the ACH payment source",
1143
- "format": "uuid"
1144
- },
1145
- "Address": {
1146
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1147
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Address",
1148
- "description": "The business address of the client. This will be the address used by the Address Verification Service",
1149
- "required": ["country", "streetLines"],
1150
- "type": "object",
1151
- "properties": {
1152
- "streetLines": {
1153
- "maxItems": 4,
1154
- "minItems": 1,
1155
- "type": "array",
1156
- "description": "Street lines",
1157
- "items": {
1158
- "minLength": 1,
1159
- "type": "string",
1160
- "description": "Street line"
1161
- }
1162
- },
1163
- "city": {
1164
- "minLength": 1,
1165
- "type": "string",
1166
- "description": "City"
1167
- },
1168
- "region": {
1169
- "minLength": 1,
1170
- "type": "string",
1171
- "description": "Region, State or Provence"
1172
- },
1173
- "postalCode": {
1174
- "minLength": 1,
1175
- "type": "string",
1176
- "description": "Postal or zip code"
1177
- },
1178
- "reportablePostalCode": {
1179
- "type": "string",
1180
- "description": "Postal code for reporting purposes."
1181
- },
1182
- "country": {
1183
- "type": "string",
1184
- "description": "Country ISO 3166-1 alpha-2 codes",
1185
- "enum": [
1186
- "AD",
1187
- "AE",
1188
- "AF",
1189
- "AG",
1190
- "AI",
1191
- "AL",
1192
- "AM",
1193
- "AO",
1194
- "AQ",
1195
- "AR",
1196
- "AS",
1197
- "AT",
1198
- "AU",
1199
- "AW",
1200
- "AX",
1201
- "AZ",
1202
- "BA",
1203
- "BB",
1204
- "BD",
1205
- "BE",
1206
- "BF",
1207
- "BG",
1208
- "BH",
1209
- "BI",
1210
- "BJ",
1211
- "BL",
1212
- "BM",
1213
- "BN",
1214
- "BO",
1215
- "BQ",
1216
- "BR",
1217
- "BS",
1218
- "BT",
1219
- "BV",
1220
- "BW",
1221
- "BY",
1222
- "BZ",
1223
- "CA",
1224
- "CC",
1225
- "CD",
1226
- "CF",
1227
- "CG",
1228
- "CH",
1229
- "CI",
1230
- "CK",
1231
- "CL",
1232
- "CM",
1233
- "CN",
1234
- "CO",
1235
- "CR",
1236
- "CU",
1237
- "CV",
1238
- "CW",
1239
- "CX",
1240
- "CY",
1241
- "CZ",
1242
- "DE",
1243
- "DJ",
1244
- "DK",
1245
- "DM",
1246
- "DO",
1247
- "DZ",
1248
- "EC",
1249
- "EE",
1250
- "EG",
1251
- "EH",
1252
- "ER",
1253
- "ES",
1254
- "ET",
1255
- "FI",
1256
- "FJ",
1257
- "FK",
1258
- "FM",
1259
- "FO",
1260
- "FR",
1261
- "GA",
1262
- "GB",
1263
- "GD",
1264
- "GE",
1265
- "GF",
1266
- "GG",
1267
- "GH",
1268
- "GI",
1269
- "GL",
1270
- "GM",
1271
- "GN",
1272
- "GP",
1273
- "GQ",
1274
- "GR",
1275
- "GS",
1276
- "GT",
1277
- "GU",
1278
- "GW",
1279
- "GY",
1280
- "HK",
1281
- "HM",
1282
- "HN",
1283
- "HR",
1284
- "HT",
1285
- "HU",
1286
- "ID",
1287
- "IE",
1288
- "IL",
1289
- "IM",
1290
- "IN",
1291
- "IO",
1292
- "IQ",
1293
- "IR",
1294
- "IS",
1295
- "IT",
1296
- "JE",
1297
- "JM",
1298
- "JO",
1299
- "JP",
1300
- "KE",
1301
- "KG",
1302
- "KH",
1303
- "KI",
1304
- "KM",
1305
- "KN",
1306
- "KP",
1307
- "KR",
1308
- "KW",
1309
- "KY",
1310
- "KZ",
1311
- "LA",
1312
- "LB",
1313
- "LC",
1314
- "LI",
1315
- "LK",
1316
- "LR",
1317
- "LS",
1318
- "LT",
1319
- "LU",
1320
- "LV",
1321
- "LY",
1322
- "MA",
1323
- "MC",
1324
- "MD",
1325
- "ME",
1326
- "MF",
1327
- "MG",
1328
- "MH",
1329
- "MK",
1330
- "ML",
1331
- "MM",
1332
- "MN",
1333
- "MO",
1334
- "MP",
1335
- "MQ",
1336
- "MR",
1337
- "MS",
1338
- "MT",
1339
- "MU",
1340
- "MV",
1341
- "MW",
1342
- "MX",
1343
- "MY",
1344
- "MZ",
1345
- "NA",
1346
- "NC",
1347
- "NE",
1348
- "NF",
1349
- "NG",
1350
- "NI",
1351
- "NL",
1352
- "NO",
1353
- "NP",
1354
- "NR",
1355
- "NU",
1356
- "NZ",
1357
- "OM",
1358
- "PA",
1359
- "PE",
1360
- "PF",
1361
- "PG",
1362
- "PH",
1363
- "PK",
1364
- "PL",
1365
- "PM",
1366
- "PN",
1367
- "PR",
1368
- "PS",
1369
- "PT",
1370
- "PW",
1371
- "PY",
1372
- "QA",
1373
- "RE",
1374
- "RO",
1375
- "RS",
1376
- "RU",
1377
- "RW",
1378
- "SA",
1379
- "SB",
1380
- "SC",
1381
- "SD",
1382
- "SE",
1383
- "SG",
1384
- "SH",
1385
- "SI",
1386
- "SJ",
1387
- "SK",
1388
- "SL",
1389
- "SM",
1390
- "SN",
1391
- "SO",
1392
- "SR",
1393
- "SS",
1394
- "ST",
1395
- "SV",
1396
- "SX",
1397
- "SY",
1398
- "SZ",
1399
- "TC",
1400
- "TD",
1401
- "TF",
1402
- "TG",
1403
- "TH",
1404
- "TJ",
1405
- "TK",
1406
- "TL",
1407
- "TM",
1408
- "TN",
1409
- "TO",
1410
- "TR",
1411
- "TT",
1412
- "TV",
1413
- "TW",
1414
- "TZ",
1415
- "UA",
1416
- "UG",
1417
- "UM",
1418
- "US",
1419
- "UY",
1420
- "UZ",
1421
- "VA",
1422
- "VC",
1423
- "VE",
1424
- "VG",
1425
- "VI",
1426
- "VN",
1427
- "VU",
1428
- "WF",
1429
- "WS",
1430
- "YE",
1431
- "YT",
1432
- "ZA",
1433
- "ZM",
1434
- "ZW"
1435
- ]
1436
- }
1437
- }
1438
- },
1439
- "StorageKeyId": {
1440
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1441
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/StorageKeyId",
1442
- "type": "string",
1443
- "description": "DEK's non-derived identifier to be used by Check Digit services only.\n"
1444
- },
1445
- "TransmissionKey": {
1446
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1447
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/TransmissionKey",
1448
- "description": "The Encrypted version of the AES-256 DEK",
1449
- "type": "string"
1450
- },
1451
- "ClientBalance": {
1452
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1453
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/ClientBalance",
1454
- "type": "object",
1455
- "additionalProperties": false,
1456
- "description": "Client account balance details.\n- The currency of the balances are according to the issuingCountryCode of the client: USD for 'US' and CAD for 'CA'.\n- The balance values are to the smallest decimal place for that currency. For example, 100 US Dollars would show as 10000.\n- Negative balance values will have a '-' character in front of the value.\n",
1457
- "required": ["at", "ledgerBalance", "availableBalance"],
1458
- "properties": {
1459
- "at": {
1460
- "type": "string",
1461
- "format": "date-time",
1462
- "description": "The date/time that the balances apply to."
1463
- },
1464
- "ledgerBalance": {
1465
- "type": "string",
1466
- "minLength": 1,
1467
- "description": "Ledger balance of the client account. This value does not take into account any pending transactions."
1468
- },
1469
- "availableBalance": {
1470
- "type": "string",
1471
- "minLength": 1,
1472
- "description": "Available balance of the client account. This value takes into account pending transactions."
1473
- }
1474
- }
1475
- },
1476
- "Funding": {
1477
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1478
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/Funding",
1479
- "type": "string",
1480
- "description": "The way in which client accounts will be funded.\n- The default value is ACH if not supplied when creating a client\n- Credit clients are not permitted to create ach payment sources, a 400 Bad Request will be returned\n- ACH clients are not permitted to create credit account entries, a 400 Bad request will be returned\n",
1481
- "enum": ["ACH", "CREDIT"]
1482
- },
1483
- "NewCreditAccountEntry": {
1484
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1485
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/NewCreditAccountEntry",
1486
- "type": "object",
1487
- "additionalProperties": false,
1488
- "description": "Credit account entry details",
1489
- "required": ["clientId", "transactionType", "amount"],
1490
- "properties": {
1491
- "clientId": {
1492
- "type": "string",
1493
- "description": "The client whose credit balance will be adjusted by the specified amount."
1494
- },
1495
- "transactionType": {
1496
- "type": "string",
1497
- "description": "Credit or Debit. Please note that the available credit balance may go negative if the DEBIT amount is greater than the current available credit balance.\n- CREDIT will raise the available credit balance by the requested amount\n- DEBIT will lower the available credit balance by the requested amount\n",
1498
- "enum": ["CREDIT", "DEBIT"]
1499
- },
1500
- "amount": {
1501
- "type": "string",
1502
- "pattern": "^[1-9]\\d*$",
1503
- "minLength": 1,
1504
- "description": "The amount to be credited to or debited from the available credit balance\nThe value is expected to be in cents.\nAs an example, a value of 100 would be equal to 1 dollar\n"
1505
- }
1506
- }
1507
- },
1508
- "NewCorrectionAccountEntry": {
1509
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1510
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/NewCorrectionAccountEntry",
1511
- "type": "object",
1512
- "additionalProperties": false,
1513
- "description": "Correction account entry details",
1514
- "required": ["clientId", "transactionType", "amount", "purpose"],
1515
- "properties": {
1516
- "clientId": {
1517
- "type": "string",
1518
- "description": "The client whose available balance will be adjusted by the specified amount."
1519
- },
1520
- "transactionType": {
1521
- "type": "string",
1522
- "description": "Credit or Debit. Please note that the client balance may go negative if the DEBIT amount is greater than the current available client balance.\n- CREDIT will raise the available client balance by the requested amount\n- DEBIT will lower the available client balance by the requested amount\n",
1523
- "enum": ["CREDIT", "DEBIT"]
1524
- },
1525
- "amount": {
1526
- "type": "string",
1527
- "pattern": "^[1-9]\\d*$",
1528
- "minLength": 1,
1529
- "description": "The amount to be credited to or debited from the available client balance\nThe value is expected to be in cents.\nAs an example, a value of 100 would be equal to 1 dollar\n"
1530
- },
1531
- "purpose": {
1532
- "type": "object",
1533
- "description": "The purpose for the correction. This will be JSON stringified to form the name of the correction entry account."
1534
- }
1535
- }
1536
- },
1537
- "EntryId": {
1538
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1539
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/EntryId",
1540
- "type": "string",
1541
- "description": "Ledger entryId associated with a paymentId"
1542
- },
1543
- "PayOrRequestPaymentResponse": {
1544
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1545
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/PayOrRequestPaymentResponse",
1546
- "type": "object",
1547
- "additionalProperties": false,
1548
- "required": ["entryId", "traceNumber"],
1549
- "properties": {
1550
- "entryId": {
1551
- "$ref": "/teampay-client-management/v1/schemas/definitions/EntryId"
1552
- },
1553
- "referenceId": {
1554
- "type": "string",
1555
- "description": "Hash value of the paymentId, if the payment source destination does not allow passing in the UUID"
1556
- },
1557
- "traceNumber": {
1558
- "type": "string",
1559
- "description": "Uniquely identifies each Entry Detail Record within an ACH batch file."
1560
- }
1561
- }
1562
- },
1563
- "CancelPaymentResponse": {
1564
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1565
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/CancelPaymentResponse",
1566
- "type": "object",
1567
- "additionalProperties": false,
1568
- "required": ["entryId"],
1569
- "properties": {
1570
- "entryId": {
1571
- "$ref": "/teampay-client-management/v1/schemas/definitions/EntryId"
1572
- }
1573
- }
1574
- },
1575
- "ActiveStatus": {
1576
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1577
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/ActiveStatus",
1578
- "type": "string",
1579
- "description": "The client's active status\n- The value is set to ACTIVE by default if not present when creating a client\n- All new incoming card preauthorization and tokenization requests will be declined for INACTIVE clients\n",
1580
- "enum": ["ACTIVE", "INACTIVE"]
1581
- },
1582
- "SubsidiaryOf": {
1583
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1584
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/SubsidiaryOf",
1585
- "type": "string",
1586
- "description": "Used to indicate the client is a subsidiary of another client\n- This value must be set to a client ID of a client that is not already a subsidiary of another client\n- An attempt to change the value of this field once set will result in a 400 Bad Request\n",
1587
- "format": "uuid"
1588
- },
1589
- "CompanyEntryDescription": {
1590
- "$schema": "https://json-schema.org/draft/2020-12/schema",
1591
- "$id": "https://eslint-plugin.checkdigit/teampay-client-management/v1/schemas/definitions/CompanyEntryDescription",
1592
- "type": "string",
1593
- "description": "Purpose or intent of the payment",
1594
- "minLength": 1,
1595
- "maxLength": 10
1596
- }
1597
- }
1598
- }