@checkdigit/eslint-plugin 7.18.0-PR.143-b064 → 7.18.0-PR.143-b6d4
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.
- package/dist-mjs/athena/athena.mjs +82 -36
- package/dist-mjs/athena/visitor.mjs +27 -1
- package/dist-mjs/openapi/service-schema-generator.mjs +26 -64
- package/dist-types/athena/visitor.d.ts +4 -0
- package/package.json +1 -1
- package/src/athena/athena.ts +93 -43
- package/src/athena/visitor.ts +28 -0
- package/src/openapi/service-schema-generator.ts +26 -74
- package/src/services/interchange/v1/swagger.schema.deref.json +16 -15
- package/src/services/ledger/v1/swagger.schema.deref.json +81 -81
- package/src/services/ledger/v2/swagger.schema.deref.json +4119 -0
- package/src/services/link/v1/swagger.schema.deref.json +13 -12
- package/src/services/link/{v1/swagger.schema.json → v2/swagger.schema.deref.json} +98 -28
- package/src/services/message/v1/swagger.schema.deref.json +731 -731
- package/src/services/message/v2/swagger.schema.deref.json +1017 -1017
- package/src/services/paymentCard/v1/swagger.schema.deref.json +248 -238
- package/src/services/paymentCard/v2/swagger.schema.deref.json +257 -274
- package/src/services/paymentCard/v3/swagger.schema.deref.json +2843 -0
- package/src/services/person/v1/swagger.schema.deref.json +111 -96
- package/src/services/person/v2/swagger.schema.deref.json +4931 -0
- package/src/services/teampayApproval/v1/swagger.schema.deref.json +2 -165
- package/src/services/teampayCardManagement/v1/swagger.schema.deref.json +220 -1768
- package/src/services/teampayClientManagement/v1/swagger.schema.deref.json +217 -217
- package/src/services/interchange/v1/swagger.schema.json +0 -423
- package/src/services/interchange/v1/swagger.yml +0 -414
- package/src/services/ledger/v1/swagger.schema.json +0 -1048
- package/src/services/ledger/v1/swagger.yml +0 -1094
- package/src/services/link/v1/swagger.yml +0 -343
- package/src/services/message/v1/swagger.schema.json +0 -2944
- package/src/services/message/v1/swagger.yml +0 -2798
- package/src/services/message/v2/swagger.schema.json +0 -3040
- package/src/services/message/v2/swagger.yml +0 -3009
- package/src/services/paymentCard/v1/swagger.schema.json +0 -1687
- package/src/services/paymentCard/v1/swagger.yml +0 -1161
- package/src/services/paymentCard/v2/swagger.schema.json +0 -1649
- package/src/services/paymentCard/v2/swagger.yml +0 -1149
- package/src/services/person/v1/swagger.schema.json +0 -979
- package/src/services/person/v1/swagger.yml +0 -1157
- package/src/services/teampayClientManagement/v1/swagger.schema.json +0 -1598
- package/src/services/teampayClientManagement/v1/swagger.yml +0 -1376
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
"put": {
|
|
7
7
|
"request": {
|
|
8
8
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
9
|
-
"$id": "https://
|
|
9
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/DataEncryptionKeyPutRequestContext",
|
|
10
10
|
"type": "object",
|
|
11
11
|
"properties": {
|
|
12
12
|
"params": {
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
},
|
|
27
27
|
"body": {
|
|
28
28
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
29
|
-
"$id": "https://
|
|
29
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyRequest",
|
|
30
30
|
"type": "object",
|
|
31
31
|
"additionalProperties": false,
|
|
32
32
|
"required": ["publicKeys"],
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"description": "List of public keys in PEM format.\n\nAssociated private keys can be used to decrypt card data encrypted by Payment Card Service.\n",
|
|
38
38
|
"items": {
|
|
39
39
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
40
|
-
"$id": "https://
|
|
40
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PublicKey",
|
|
41
41
|
"description": "Public key in PEM format",
|
|
42
42
|
"type": "string",
|
|
43
43
|
"example": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwm2sxmRdTF7ZIBA6+ngO\n8jOTCHmID0PpQB1q85+hrcLSfB1rWY9bzNNLabBo/ajDnA4Pcadq/x6gpg70qZcR\n9Wxm6TttKzBPZsxasGXgSTDqEi2KcYZgq1mL4qyxUvyIms7/llGy+W9b5huZaVcO\nxdT1tw/zctbOhb6S2t5vH+zkta/2ncUXjG7i8XdLsJ1qe4K1kYbA4KVkOMmAtw7O\n4STk0TZDD0YARdmrciorJjbIVt0Xj1CrYQ5QbDGrlfeXgrcZwX5f9wT2MnKlY5oZ\n5Wtb57oGtLkVf8g6vN/2jGtAmOmHK2hHwNd/+zUet5G/S5uwEli4RgMPP4pUoKgd\nGQIDAQAB\n-----END PUBLIC KEY-----\n"
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
"responses": {
|
|
53
53
|
"200": {
|
|
54
54
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
55
|
-
"$id": "https://
|
|
55
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/DataEncryptionKeyPutResponseOK",
|
|
56
56
|
"type": "object",
|
|
57
57
|
"properties": {
|
|
58
58
|
"headers": {
|
|
@@ -66,11 +66,12 @@
|
|
|
66
66
|
"type": "string",
|
|
67
67
|
"format": "date-time"
|
|
68
68
|
}
|
|
69
|
-
}
|
|
69
|
+
},
|
|
70
|
+
"required": ["created-on", "updated-on"]
|
|
70
71
|
},
|
|
71
72
|
"body": {
|
|
72
73
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
73
|
-
"$id": "https://
|
|
74
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyResponse",
|
|
74
75
|
"type": "object",
|
|
75
76
|
"required": ["transmissionKey", "encryptedDataEncryptionKeys", "createdOn", "lastModified"],
|
|
76
77
|
"properties": {
|
|
@@ -94,7 +95,7 @@
|
|
|
94
95
|
"properties": {
|
|
95
96
|
"publicKeyHash": {
|
|
96
97
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
97
|
-
"$id": "https://
|
|
98
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Hash",
|
|
98
99
|
"type": "string",
|
|
99
100
|
"format": "uuid",
|
|
100
101
|
"example": "15a85f64-5717-4562-b3fc-2c963f66afa6",
|
|
@@ -114,12 +115,12 @@
|
|
|
114
115
|
}
|
|
115
116
|
}
|
|
116
117
|
},
|
|
117
|
-
"required": ["body"],
|
|
118
|
+
"required": ["headers", "body"],
|
|
118
119
|
"additionalProperties": false
|
|
119
120
|
},
|
|
120
121
|
"default": {
|
|
121
122
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
122
|
-
"$id": "https://
|
|
123
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/DataEncryptionKeyPutResponseDefault",
|
|
123
124
|
"type": "object",
|
|
124
125
|
"properties": {
|
|
125
126
|
"headers": {
|
|
@@ -128,7 +129,7 @@
|
|
|
128
129
|
},
|
|
129
130
|
"body": {
|
|
130
131
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
131
|
-
"$id": "https://
|
|
132
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
132
133
|
"type": "object",
|
|
133
134
|
"additionalProperties": false,
|
|
134
135
|
"description": "Server error message",
|
|
@@ -153,7 +154,7 @@
|
|
|
153
154
|
"put": {
|
|
154
155
|
"request": {
|
|
155
156
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
156
|
-
"$id": "https://
|
|
157
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardPutRequestContext",
|
|
157
158
|
"type": "object",
|
|
158
159
|
"properties": {
|
|
159
160
|
"params": {
|
|
@@ -162,7 +163,7 @@
|
|
|
162
163
|
"properties": {
|
|
163
164
|
"cardId": {
|
|
164
165
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
165
|
-
"$id": "https://
|
|
166
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
166
167
|
"type": "string",
|
|
167
168
|
"description": "Card identifier",
|
|
168
169
|
"format": "uuid"
|
|
@@ -186,14 +187,14 @@
|
|
|
186
187
|
},
|
|
187
188
|
"body": {
|
|
188
189
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
189
|
-
"$id": "https://
|
|
190
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/NewCardRequest",
|
|
190
191
|
"type": "object",
|
|
191
192
|
"required": ["dataEncryptionKeyId", "cardNumberLength", "newCard"],
|
|
192
193
|
"additionalProperties": false,
|
|
193
194
|
"properties": {
|
|
194
195
|
"dataEncryptionKeyId": {
|
|
195
196
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
196
|
-
"$id": "https://
|
|
197
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyId",
|
|
197
198
|
"type": "string",
|
|
198
199
|
"description": "Reference to encryption keys Payment Card Service will use to encrypt the Card object.\n",
|
|
199
200
|
"format": "uuid"
|
|
@@ -206,7 +207,7 @@
|
|
|
206
207
|
},
|
|
207
208
|
"newCard": {
|
|
208
209
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
209
|
-
"$id": "https://
|
|
210
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/NewCard",
|
|
210
211
|
"type": "object",
|
|
211
212
|
"additionalProperties": false,
|
|
212
213
|
"required": [
|
|
@@ -222,7 +223,7 @@
|
|
|
222
223
|
"properties": {
|
|
223
224
|
"bin": {
|
|
224
225
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
225
|
-
"$id": "https://
|
|
226
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
226
227
|
"type": "string",
|
|
227
228
|
"pattern": "^\\d+$",
|
|
228
229
|
"description": "Bank Identification Number",
|
|
@@ -231,7 +232,7 @@
|
|
|
231
232
|
},
|
|
232
233
|
"expirationDate": {
|
|
233
234
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
234
|
-
"$id": "https://
|
|
235
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
235
236
|
"type": "string",
|
|
236
237
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
237
238
|
"format": "YYMM",
|
|
@@ -254,28 +255,28 @@
|
|
|
254
255
|
},
|
|
255
256
|
"state": {
|
|
256
257
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
257
|
-
"$id": "https://
|
|
258
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
258
259
|
"description": "The current state of the card",
|
|
259
260
|
"type": "string",
|
|
260
261
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
261
262
|
},
|
|
262
263
|
"active": {
|
|
263
264
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
264
|
-
"$id": "https://
|
|
265
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
265
266
|
"description": "The active/inactive status for the card",
|
|
266
267
|
"type": "string",
|
|
267
268
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
268
269
|
},
|
|
269
270
|
"block": {
|
|
270
271
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
271
|
-
"$id": "https://
|
|
272
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
272
273
|
"type": "string",
|
|
273
274
|
"description": "Whether the card is open or blocked for various reasons",
|
|
274
275
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
275
276
|
},
|
|
276
277
|
"lock": {
|
|
277
278
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
278
|
-
"$id": "https://
|
|
279
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
279
280
|
"type": "string",
|
|
280
281
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
281
282
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -291,7 +292,7 @@
|
|
|
291
292
|
"responses": {
|
|
292
293
|
"200": {
|
|
293
294
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
294
|
-
"$id": "https://
|
|
295
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardPutResponseOK",
|
|
295
296
|
"type": "object",
|
|
296
297
|
"properties": {
|
|
297
298
|
"headers": {
|
|
@@ -312,25 +313,26 @@
|
|
|
312
313
|
"etag": {
|
|
313
314
|
"type": "string"
|
|
314
315
|
}
|
|
315
|
-
}
|
|
316
|
+
},
|
|
317
|
+
"required": ["last-modified", "created-on", "updated-on", "etag"]
|
|
316
318
|
},
|
|
317
319
|
"body": {
|
|
318
320
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
319
|
-
"$id": "https://
|
|
321
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardResponse",
|
|
320
322
|
"type": "object",
|
|
321
323
|
"additionalProperties": false,
|
|
322
324
|
"required": ["dataEncryptionKeyId", "storageKeyId", "card"],
|
|
323
325
|
"properties": {
|
|
324
326
|
"dataEncryptionKeyId": {
|
|
325
327
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
326
|
-
"$id": "https://
|
|
328
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyId",
|
|
327
329
|
"type": "string",
|
|
328
330
|
"description": "Reference to encryption keys Payment Card Service will use to encrypt the Card object.\n",
|
|
329
331
|
"format": "uuid"
|
|
330
332
|
},
|
|
331
333
|
"storageKeyId": {
|
|
332
334
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
333
|
-
"$id": "https://
|
|
335
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StorageKeyId",
|
|
334
336
|
"type": "string",
|
|
335
337
|
"description": "DEK's non-derived identifier to be used by Check Digit services only.\n"
|
|
336
338
|
},
|
|
@@ -340,7 +342,7 @@
|
|
|
340
342
|
},
|
|
341
343
|
"card": {
|
|
342
344
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
343
|
-
"$id": "https://
|
|
345
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Card",
|
|
344
346
|
"type": "object",
|
|
345
347
|
"additionalProperties": false,
|
|
346
348
|
"required": [
|
|
@@ -364,7 +366,7 @@
|
|
|
364
366
|
"properties": {
|
|
365
367
|
"bin": {
|
|
366
368
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
367
|
-
"$id": "https://
|
|
369
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
368
370
|
"type": "string",
|
|
369
371
|
"pattern": "^\\d+$",
|
|
370
372
|
"description": "Bank Identification Number",
|
|
@@ -380,7 +382,7 @@
|
|
|
380
382
|
},
|
|
381
383
|
"expirationDate": {
|
|
382
384
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
383
|
-
"$id": "https://
|
|
385
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
384
386
|
"type": "string",
|
|
385
387
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
386
388
|
"format": "YYMM",
|
|
@@ -413,28 +415,28 @@
|
|
|
413
415
|
},
|
|
414
416
|
"state": {
|
|
415
417
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
416
|
-
"$id": "https://
|
|
418
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
417
419
|
"description": "The current state of the card",
|
|
418
420
|
"type": "string",
|
|
419
421
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
420
422
|
},
|
|
421
423
|
"active": {
|
|
422
424
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
423
|
-
"$id": "https://
|
|
425
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
424
426
|
"description": "The active/inactive status for the card",
|
|
425
427
|
"type": "string",
|
|
426
428
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
427
429
|
},
|
|
428
430
|
"block": {
|
|
429
431
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
430
|
-
"$id": "https://
|
|
432
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
431
433
|
"type": "string",
|
|
432
434
|
"description": "Whether the card is open or blocked for various reasons",
|
|
433
435
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
434
436
|
},
|
|
435
437
|
"lock": {
|
|
436
438
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
437
|
-
"$id": "https://
|
|
439
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
438
440
|
"type": "string",
|
|
439
441
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
440
442
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -463,12 +465,12 @@
|
|
|
463
465
|
}
|
|
464
466
|
}
|
|
465
467
|
},
|
|
466
|
-
"required": ["body"],
|
|
468
|
+
"required": ["headers", "body"],
|
|
467
469
|
"additionalProperties": false
|
|
468
470
|
},
|
|
469
471
|
"409": {
|
|
470
472
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
471
|
-
"$id": "https://
|
|
473
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardPutResponseConflict",
|
|
472
474
|
"type": "object",
|
|
473
475
|
"properties": {
|
|
474
476
|
"headers": {
|
|
@@ -481,7 +483,7 @@
|
|
|
481
483
|
},
|
|
482
484
|
"412": {
|
|
483
485
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
484
|
-
"$id": "https://
|
|
486
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardPutResponsePreconditionFailed",
|
|
485
487
|
"type": "object",
|
|
486
488
|
"properties": {
|
|
487
489
|
"headers": {
|
|
@@ -494,7 +496,7 @@
|
|
|
494
496
|
},
|
|
495
497
|
"default": {
|
|
496
498
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
497
|
-
"$id": "https://
|
|
499
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardPutResponseDefault",
|
|
498
500
|
"type": "object",
|
|
499
501
|
"properties": {
|
|
500
502
|
"headers": {
|
|
@@ -503,7 +505,7 @@
|
|
|
503
505
|
},
|
|
504
506
|
"body": {
|
|
505
507
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
506
|
-
"$id": "https://
|
|
508
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
507
509
|
"type": "object",
|
|
508
510
|
"additionalProperties": false,
|
|
509
511
|
"description": "Server error message",
|
|
@@ -527,7 +529,7 @@
|
|
|
527
529
|
"put": {
|
|
528
530
|
"request": {
|
|
529
531
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
530
|
-
"$id": "https://
|
|
532
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardNumberPutRequestContext",
|
|
531
533
|
"type": "object",
|
|
532
534
|
"properties": {
|
|
533
535
|
"params": {
|
|
@@ -536,7 +538,7 @@
|
|
|
536
538
|
"properties": {
|
|
537
539
|
"cardId": {
|
|
538
540
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
539
|
-
"$id": "https://
|
|
541
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
540
542
|
"type": "string",
|
|
541
543
|
"description": "Card identifier",
|
|
542
544
|
"format": "uuid"
|
|
@@ -560,7 +562,7 @@
|
|
|
560
562
|
},
|
|
561
563
|
"body": {
|
|
562
564
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
563
|
-
"$id": "https://
|
|
565
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/NewCardRequestWithCardNumber",
|
|
564
566
|
"type": "object",
|
|
565
567
|
"required": ["encryptedCardNumber", "encryptedDataEncryptionKey", "dataEncryptionKeyId", "newCard"],
|
|
566
568
|
"properties": {
|
|
@@ -573,14 +575,14 @@
|
|
|
573
575
|
},
|
|
574
576
|
"dataEncryptionKeyId": {
|
|
575
577
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
576
|
-
"$id": "https://
|
|
578
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyId",
|
|
577
579
|
"type": "string",
|
|
578
580
|
"description": "Reference to encryption keys Payment Card Service will use to encrypt the Card object.\n",
|
|
579
581
|
"format": "uuid"
|
|
580
582
|
},
|
|
581
583
|
"newCard": {
|
|
582
584
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
583
|
-
"$id": "https://
|
|
585
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/NewCard",
|
|
584
586
|
"type": "object",
|
|
585
587
|
"additionalProperties": false,
|
|
586
588
|
"required": [
|
|
@@ -596,7 +598,7 @@
|
|
|
596
598
|
"properties": {
|
|
597
599
|
"bin": {
|
|
598
600
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
599
|
-
"$id": "https://
|
|
601
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
600
602
|
"type": "string",
|
|
601
603
|
"pattern": "^\\d+$",
|
|
602
604
|
"description": "Bank Identification Number",
|
|
@@ -605,7 +607,7 @@
|
|
|
605
607
|
},
|
|
606
608
|
"expirationDate": {
|
|
607
609
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
608
|
-
"$id": "https://
|
|
610
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
609
611
|
"type": "string",
|
|
610
612
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
611
613
|
"format": "YYMM",
|
|
@@ -628,28 +630,28 @@
|
|
|
628
630
|
},
|
|
629
631
|
"state": {
|
|
630
632
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
631
|
-
"$id": "https://
|
|
633
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
632
634
|
"description": "The current state of the card",
|
|
633
635
|
"type": "string",
|
|
634
636
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
635
637
|
},
|
|
636
638
|
"active": {
|
|
637
639
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
638
|
-
"$id": "https://
|
|
640
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
639
641
|
"description": "The active/inactive status for the card",
|
|
640
642
|
"type": "string",
|
|
641
643
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
642
644
|
},
|
|
643
645
|
"block": {
|
|
644
646
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
645
|
-
"$id": "https://
|
|
647
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
646
648
|
"type": "string",
|
|
647
649
|
"description": "Whether the card is open or blocked for various reasons",
|
|
648
650
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
649
651
|
},
|
|
650
652
|
"lock": {
|
|
651
653
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
652
|
-
"$id": "https://
|
|
654
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
653
655
|
"type": "string",
|
|
654
656
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
655
657
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -666,7 +668,7 @@
|
|
|
666
668
|
"responses": {
|
|
667
669
|
"200": {
|
|
668
670
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
669
|
-
"$id": "https://
|
|
671
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardNumberPutResponseOK",
|
|
670
672
|
"type": "object",
|
|
671
673
|
"properties": {
|
|
672
674
|
"headers": {
|
|
@@ -687,25 +689,26 @@
|
|
|
687
689
|
"etag": {
|
|
688
690
|
"type": "string"
|
|
689
691
|
}
|
|
690
|
-
}
|
|
692
|
+
},
|
|
693
|
+
"required": ["last-modified", "created-on", "updated-on", "etag"]
|
|
691
694
|
},
|
|
692
695
|
"body": {
|
|
693
696
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
694
|
-
"$id": "https://
|
|
697
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardResponse",
|
|
695
698
|
"type": "object",
|
|
696
699
|
"additionalProperties": false,
|
|
697
700
|
"required": ["dataEncryptionKeyId", "storageKeyId", "card"],
|
|
698
701
|
"properties": {
|
|
699
702
|
"dataEncryptionKeyId": {
|
|
700
703
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
701
|
-
"$id": "https://
|
|
704
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyId",
|
|
702
705
|
"type": "string",
|
|
703
706
|
"description": "Reference to encryption keys Payment Card Service will use to encrypt the Card object.\n",
|
|
704
707
|
"format": "uuid"
|
|
705
708
|
},
|
|
706
709
|
"storageKeyId": {
|
|
707
710
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
708
|
-
"$id": "https://
|
|
711
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StorageKeyId",
|
|
709
712
|
"type": "string",
|
|
710
713
|
"description": "DEK's non-derived identifier to be used by Check Digit services only.\n"
|
|
711
714
|
},
|
|
@@ -715,7 +718,7 @@
|
|
|
715
718
|
},
|
|
716
719
|
"card": {
|
|
717
720
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
718
|
-
"$id": "https://
|
|
721
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Card",
|
|
719
722
|
"type": "object",
|
|
720
723
|
"additionalProperties": false,
|
|
721
724
|
"required": [
|
|
@@ -739,7 +742,7 @@
|
|
|
739
742
|
"properties": {
|
|
740
743
|
"bin": {
|
|
741
744
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
742
|
-
"$id": "https://
|
|
745
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
743
746
|
"type": "string",
|
|
744
747
|
"pattern": "^\\d+$",
|
|
745
748
|
"description": "Bank Identification Number",
|
|
@@ -755,7 +758,7 @@
|
|
|
755
758
|
},
|
|
756
759
|
"expirationDate": {
|
|
757
760
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
758
|
-
"$id": "https://
|
|
761
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
759
762
|
"type": "string",
|
|
760
763
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
761
764
|
"format": "YYMM",
|
|
@@ -788,28 +791,28 @@
|
|
|
788
791
|
},
|
|
789
792
|
"state": {
|
|
790
793
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
791
|
-
"$id": "https://
|
|
794
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
792
795
|
"description": "The current state of the card",
|
|
793
796
|
"type": "string",
|
|
794
797
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
795
798
|
},
|
|
796
799
|
"active": {
|
|
797
800
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
798
|
-
"$id": "https://
|
|
801
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
799
802
|
"description": "The active/inactive status for the card",
|
|
800
803
|
"type": "string",
|
|
801
804
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
802
805
|
},
|
|
803
806
|
"block": {
|
|
804
807
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
805
|
-
"$id": "https://
|
|
808
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
806
809
|
"type": "string",
|
|
807
810
|
"description": "Whether the card is open or blocked for various reasons",
|
|
808
811
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
809
812
|
},
|
|
810
813
|
"lock": {
|
|
811
814
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
812
|
-
"$id": "https://
|
|
815
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
813
816
|
"type": "string",
|
|
814
817
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
815
818
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -838,12 +841,12 @@
|
|
|
838
841
|
}
|
|
839
842
|
}
|
|
840
843
|
},
|
|
841
|
-
"required": ["body"],
|
|
844
|
+
"required": ["headers", "body"],
|
|
842
845
|
"additionalProperties": false
|
|
843
846
|
},
|
|
844
847
|
"409": {
|
|
845
848
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
846
|
-
"$id": "https://
|
|
849
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardNumberPutResponseConflict",
|
|
847
850
|
"type": "object",
|
|
848
851
|
"properties": {
|
|
849
852
|
"headers": {
|
|
@@ -856,7 +859,7 @@
|
|
|
856
859
|
},
|
|
857
860
|
"412": {
|
|
858
861
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
859
|
-
"$id": "https://
|
|
862
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardNumberPutResponsePreconditionFailed",
|
|
860
863
|
"type": "object",
|
|
861
864
|
"properties": {
|
|
862
865
|
"headers": {
|
|
@@ -869,7 +872,7 @@
|
|
|
869
872
|
},
|
|
870
873
|
"default": {
|
|
871
874
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
872
|
-
"$id": "https://
|
|
875
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardNumberPutResponseDefault",
|
|
873
876
|
"type": "object",
|
|
874
877
|
"properties": {
|
|
875
878
|
"headers": {
|
|
@@ -878,7 +881,7 @@
|
|
|
878
881
|
},
|
|
879
882
|
"body": {
|
|
880
883
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
881
|
-
"$id": "https://
|
|
884
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
882
885
|
"type": "object",
|
|
883
886
|
"additionalProperties": false,
|
|
884
887
|
"description": "Server error message",
|
|
@@ -902,7 +905,7 @@
|
|
|
902
905
|
"put": {
|
|
903
906
|
"request": {
|
|
904
907
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
905
|
-
"$id": "https://
|
|
908
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardActivePutRequestContext",
|
|
906
909
|
"type": "object",
|
|
907
910
|
"properties": {
|
|
908
911
|
"params": {
|
|
@@ -911,14 +914,14 @@
|
|
|
911
914
|
"properties": {
|
|
912
915
|
"cardId": {
|
|
913
916
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
914
|
-
"$id": "https://
|
|
917
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
915
918
|
"type": "string",
|
|
916
919
|
"description": "Card identifier",
|
|
917
920
|
"format": "uuid"
|
|
918
921
|
},
|
|
919
922
|
"activeStatus": {
|
|
920
923
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
921
|
-
"$id": "https://
|
|
924
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
922
925
|
"description": "The active/inactive status for the card",
|
|
923
926
|
"type": "string",
|
|
924
927
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
@@ -951,7 +954,7 @@
|
|
|
951
954
|
"responses": {
|
|
952
955
|
"204": {
|
|
953
956
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
954
|
-
"$id": "https://
|
|
957
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardActivePutResponseNoContent",
|
|
955
958
|
"type": "object",
|
|
956
959
|
"properties": {
|
|
957
960
|
"headers": {
|
|
@@ -972,15 +975,16 @@
|
|
|
972
975
|
"etag": {
|
|
973
976
|
"type": "string"
|
|
974
977
|
}
|
|
975
|
-
}
|
|
978
|
+
},
|
|
979
|
+
"required": ["last-modified", "created-on", "updated-on", "etag"]
|
|
976
980
|
}
|
|
977
981
|
},
|
|
978
|
-
"required": [],
|
|
982
|
+
"required": ["headers"],
|
|
979
983
|
"additionalProperties": false
|
|
980
984
|
},
|
|
981
985
|
"409": {
|
|
982
986
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
983
|
-
"$id": "https://
|
|
987
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardActivePutResponseConflict",
|
|
984
988
|
"type": "object",
|
|
985
989
|
"properties": {
|
|
986
990
|
"headers": {
|
|
@@ -993,7 +997,7 @@
|
|
|
993
997
|
},
|
|
994
998
|
"412": {
|
|
995
999
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
996
|
-
"$id": "https://
|
|
1000
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardActivePutResponsePreconditionFailed",
|
|
997
1001
|
"type": "object",
|
|
998
1002
|
"properties": {
|
|
999
1003
|
"headers": {
|
|
@@ -1006,7 +1010,7 @@
|
|
|
1006
1010
|
},
|
|
1007
1011
|
"default": {
|
|
1008
1012
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1009
|
-
"$id": "https://
|
|
1013
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardActivePutResponseDefault",
|
|
1010
1014
|
"type": "object",
|
|
1011
1015
|
"properties": {
|
|
1012
1016
|
"headers": {
|
|
@@ -1015,7 +1019,7 @@
|
|
|
1015
1019
|
},
|
|
1016
1020
|
"body": {
|
|
1017
1021
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1018
|
-
"$id": "https://
|
|
1022
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
1019
1023
|
"type": "object",
|
|
1020
1024
|
"additionalProperties": false,
|
|
1021
1025
|
"description": "Server error message",
|
|
@@ -1039,7 +1043,7 @@
|
|
|
1039
1043
|
"put": {
|
|
1040
1044
|
"request": {
|
|
1041
1045
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1042
|
-
"$id": "https://
|
|
1046
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardApplicationTransactionCounterPutRequestContext",
|
|
1043
1047
|
"type": "object",
|
|
1044
1048
|
"properties": {
|
|
1045
1049
|
"params": {
|
|
@@ -1048,7 +1052,7 @@
|
|
|
1048
1052
|
"properties": {
|
|
1049
1053
|
"cardId": {
|
|
1050
1054
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1051
|
-
"$id": "https://
|
|
1055
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
1052
1056
|
"type": "string",
|
|
1053
1057
|
"description": "Card identifier",
|
|
1054
1058
|
"format": "uuid"
|
|
@@ -1084,7 +1088,7 @@
|
|
|
1084
1088
|
"responses": {
|
|
1085
1089
|
"204": {
|
|
1086
1090
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1087
|
-
"$id": "https://
|
|
1091
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardApplicationTransactionCounterPutResponseNoContent",
|
|
1088
1092
|
"type": "object",
|
|
1089
1093
|
"properties": {
|
|
1090
1094
|
"headers": {
|
|
@@ -1105,15 +1109,16 @@
|
|
|
1105
1109
|
"etag": {
|
|
1106
1110
|
"type": "string"
|
|
1107
1111
|
}
|
|
1108
|
-
}
|
|
1112
|
+
},
|
|
1113
|
+
"required": ["last-modified", "created-on", "updated-on", "etag"]
|
|
1109
1114
|
}
|
|
1110
1115
|
},
|
|
1111
|
-
"required": [],
|
|
1116
|
+
"required": ["headers"],
|
|
1112
1117
|
"additionalProperties": false
|
|
1113
1118
|
},
|
|
1114
1119
|
"409": {
|
|
1115
1120
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1116
|
-
"$id": "https://
|
|
1121
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardApplicationTransactionCounterPutResponseConflict",
|
|
1117
1122
|
"type": "object",
|
|
1118
1123
|
"properties": {
|
|
1119
1124
|
"headers": {
|
|
@@ -1126,7 +1131,7 @@
|
|
|
1126
1131
|
},
|
|
1127
1132
|
"412": {
|
|
1128
1133
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1129
|
-
"$id": "https://
|
|
1134
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardApplicationTransactionCounterPutResponsePreconditionFailed",
|
|
1130
1135
|
"type": "object",
|
|
1131
1136
|
"properties": {
|
|
1132
1137
|
"headers": {
|
|
@@ -1139,7 +1144,7 @@
|
|
|
1139
1144
|
},
|
|
1140
1145
|
"default": {
|
|
1141
1146
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1142
|
-
"$id": "https://
|
|
1147
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardApplicationTransactionCounterPutResponseDefault",
|
|
1143
1148
|
"type": "object",
|
|
1144
1149
|
"properties": {
|
|
1145
1150
|
"headers": {
|
|
@@ -1148,7 +1153,7 @@
|
|
|
1148
1153
|
},
|
|
1149
1154
|
"body": {
|
|
1150
1155
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1151
|
-
"$id": "https://
|
|
1156
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
1152
1157
|
"type": "object",
|
|
1153
1158
|
"additionalProperties": false,
|
|
1154
1159
|
"description": "Server error message",
|
|
@@ -1172,7 +1177,7 @@
|
|
|
1172
1177
|
"put": {
|
|
1173
1178
|
"request": {
|
|
1174
1179
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1175
|
-
"$id": "https://
|
|
1180
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardBlockPutRequestContext",
|
|
1176
1181
|
"type": "object",
|
|
1177
1182
|
"properties": {
|
|
1178
1183
|
"params": {
|
|
@@ -1181,14 +1186,14 @@
|
|
|
1181
1186
|
"properties": {
|
|
1182
1187
|
"cardId": {
|
|
1183
1188
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1184
|
-
"$id": "https://
|
|
1189
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
1185
1190
|
"type": "string",
|
|
1186
1191
|
"description": "Card identifier",
|
|
1187
1192
|
"format": "uuid"
|
|
1188
1193
|
},
|
|
1189
1194
|
"blockStatus": {
|
|
1190
1195
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1191
|
-
"$id": "https://
|
|
1196
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
1192
1197
|
"type": "string",
|
|
1193
1198
|
"description": "Whether the card is open or blocked for various reasons",
|
|
1194
1199
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
@@ -1221,7 +1226,7 @@
|
|
|
1221
1226
|
"responses": {
|
|
1222
1227
|
"204": {
|
|
1223
1228
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1224
|
-
"$id": "https://
|
|
1229
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardBlockPutResponseNoContent",
|
|
1225
1230
|
"type": "object",
|
|
1226
1231
|
"properties": {
|
|
1227
1232
|
"headers": {
|
|
@@ -1242,15 +1247,16 @@
|
|
|
1242
1247
|
"etag": {
|
|
1243
1248
|
"type": "string"
|
|
1244
1249
|
}
|
|
1245
|
-
}
|
|
1250
|
+
},
|
|
1251
|
+
"required": ["last-modified", "created-on", "updated-on", "etag"]
|
|
1246
1252
|
}
|
|
1247
1253
|
},
|
|
1248
|
-
"required": [],
|
|
1254
|
+
"required": ["headers"],
|
|
1249
1255
|
"additionalProperties": false
|
|
1250
1256
|
},
|
|
1251
1257
|
"409": {
|
|
1252
1258
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1253
|
-
"$id": "https://
|
|
1259
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardBlockPutResponseConflict",
|
|
1254
1260
|
"type": "object",
|
|
1255
1261
|
"properties": {
|
|
1256
1262
|
"headers": {
|
|
@@ -1263,7 +1269,7 @@
|
|
|
1263
1269
|
},
|
|
1264
1270
|
"412": {
|
|
1265
1271
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1266
|
-
"$id": "https://
|
|
1272
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardBlockPutResponsePreconditionFailed",
|
|
1267
1273
|
"type": "object",
|
|
1268
1274
|
"properties": {
|
|
1269
1275
|
"headers": {
|
|
@@ -1276,7 +1282,7 @@
|
|
|
1276
1282
|
},
|
|
1277
1283
|
"default": {
|
|
1278
1284
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1279
|
-
"$id": "https://
|
|
1285
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardBlockPutResponseDefault",
|
|
1280
1286
|
"type": "object",
|
|
1281
1287
|
"properties": {
|
|
1282
1288
|
"headers": {
|
|
@@ -1285,7 +1291,7 @@
|
|
|
1285
1291
|
},
|
|
1286
1292
|
"body": {
|
|
1287
1293
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1288
|
-
"$id": "https://
|
|
1294
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
1289
1295
|
"type": "object",
|
|
1290
1296
|
"additionalProperties": false,
|
|
1291
1297
|
"description": "Server error message",
|
|
@@ -1309,7 +1315,7 @@
|
|
|
1309
1315
|
"put": {
|
|
1310
1316
|
"request": {
|
|
1311
1317
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1312
|
-
"$id": "https://
|
|
1318
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardCapturePutRequestContext",
|
|
1313
1319
|
"type": "object",
|
|
1314
1320
|
"properties": {
|
|
1315
1321
|
"params": {
|
|
@@ -1318,7 +1324,7 @@
|
|
|
1318
1324
|
"properties": {
|
|
1319
1325
|
"cardId": {
|
|
1320
1326
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1321
|
-
"$id": "https://
|
|
1327
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
1322
1328
|
"type": "string",
|
|
1323
1329
|
"description": "Card identifier",
|
|
1324
1330
|
"format": "uuid"
|
|
@@ -1354,7 +1360,7 @@
|
|
|
1354
1360
|
"responses": {
|
|
1355
1361
|
"204": {
|
|
1356
1362
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1357
|
-
"$id": "https://
|
|
1363
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardCapturePutResponseNoContent",
|
|
1358
1364
|
"type": "object",
|
|
1359
1365
|
"properties": {
|
|
1360
1366
|
"headers": {
|
|
@@ -1375,15 +1381,16 @@
|
|
|
1375
1381
|
"etag": {
|
|
1376
1382
|
"type": "string"
|
|
1377
1383
|
}
|
|
1378
|
-
}
|
|
1384
|
+
},
|
|
1385
|
+
"required": ["last-modified", "created-on", "updated-on", "etag"]
|
|
1379
1386
|
}
|
|
1380
1387
|
},
|
|
1381
|
-
"required": [],
|
|
1388
|
+
"required": ["headers"],
|
|
1382
1389
|
"additionalProperties": false
|
|
1383
1390
|
},
|
|
1384
1391
|
"409": {
|
|
1385
1392
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1386
|
-
"$id": "https://
|
|
1393
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardCapturePutResponseConflict",
|
|
1387
1394
|
"type": "object",
|
|
1388
1395
|
"properties": {
|
|
1389
1396
|
"headers": {
|
|
@@ -1396,7 +1403,7 @@
|
|
|
1396
1403
|
},
|
|
1397
1404
|
"412": {
|
|
1398
1405
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1399
|
-
"$id": "https://
|
|
1406
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardCapturePutResponsePreconditionFailed",
|
|
1400
1407
|
"type": "object",
|
|
1401
1408
|
"properties": {
|
|
1402
1409
|
"headers": {
|
|
@@ -1409,7 +1416,7 @@
|
|
|
1409
1416
|
},
|
|
1410
1417
|
"default": {
|
|
1411
1418
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1412
|
-
"$id": "https://
|
|
1419
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardCapturePutResponseDefault",
|
|
1413
1420
|
"type": "object",
|
|
1414
1421
|
"properties": {
|
|
1415
1422
|
"headers": {
|
|
@@ -1418,7 +1425,7 @@
|
|
|
1418
1425
|
},
|
|
1419
1426
|
"body": {
|
|
1420
1427
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1421
|
-
"$id": "https://
|
|
1428
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
1422
1429
|
"type": "object",
|
|
1423
1430
|
"additionalProperties": false,
|
|
1424
1431
|
"description": "Server error message",
|
|
@@ -1443,7 +1450,7 @@
|
|
|
1443
1450
|
"put": {
|
|
1444
1451
|
"request": {
|
|
1445
1452
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1446
|
-
"$id": "https://
|
|
1453
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardLockPutRequestContext",
|
|
1447
1454
|
"type": "object",
|
|
1448
1455
|
"properties": {
|
|
1449
1456
|
"params": {
|
|
@@ -1452,14 +1459,14 @@
|
|
|
1452
1459
|
"properties": {
|
|
1453
1460
|
"cardId": {
|
|
1454
1461
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1455
|
-
"$id": "https://
|
|
1462
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
1456
1463
|
"type": "string",
|
|
1457
1464
|
"description": "Card identifier",
|
|
1458
1465
|
"format": "uuid"
|
|
1459
1466
|
},
|
|
1460
1467
|
"lockStatus": {
|
|
1461
1468
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1462
|
-
"$id": "https://
|
|
1469
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
1463
1470
|
"type": "string",
|
|
1464
1471
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
1465
1472
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -1492,7 +1499,7 @@
|
|
|
1492
1499
|
"responses": {
|
|
1493
1500
|
"204": {
|
|
1494
1501
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1495
|
-
"$id": "https://
|
|
1502
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardLockPutResponseNoContent",
|
|
1496
1503
|
"type": "object",
|
|
1497
1504
|
"properties": {
|
|
1498
1505
|
"headers": {
|
|
@@ -1513,15 +1520,16 @@
|
|
|
1513
1520
|
"etag": {
|
|
1514
1521
|
"type": "string"
|
|
1515
1522
|
}
|
|
1516
|
-
}
|
|
1523
|
+
},
|
|
1524
|
+
"required": ["last-modified", "created-on", "updated-on", "etag"]
|
|
1517
1525
|
}
|
|
1518
1526
|
},
|
|
1519
|
-
"required": [],
|
|
1527
|
+
"required": ["headers"],
|
|
1520
1528
|
"additionalProperties": false
|
|
1521
1529
|
},
|
|
1522
1530
|
"409": {
|
|
1523
1531
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1524
|
-
"$id": "https://
|
|
1532
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardLockPutResponseConflict",
|
|
1525
1533
|
"type": "object",
|
|
1526
1534
|
"properties": {
|
|
1527
1535
|
"headers": {
|
|
@@ -1534,7 +1542,7 @@
|
|
|
1534
1542
|
},
|
|
1535
1543
|
"412": {
|
|
1536
1544
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1537
|
-
"$id": "https://
|
|
1545
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardLockPutResponsePreconditionFailed",
|
|
1538
1546
|
"type": "object",
|
|
1539
1547
|
"properties": {
|
|
1540
1548
|
"headers": {
|
|
@@ -1547,7 +1555,7 @@
|
|
|
1547
1555
|
},
|
|
1548
1556
|
"default": {
|
|
1549
1557
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1550
|
-
"$id": "https://
|
|
1558
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardLockPutResponseDefault",
|
|
1551
1559
|
"type": "object",
|
|
1552
1560
|
"properties": {
|
|
1553
1561
|
"headers": {
|
|
@@ -1556,7 +1564,7 @@
|
|
|
1556
1564
|
},
|
|
1557
1565
|
"body": {
|
|
1558
1566
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1559
|
-
"$id": "https://
|
|
1567
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
1560
1568
|
"type": "object",
|
|
1561
1569
|
"additionalProperties": false,
|
|
1562
1570
|
"description": "Server error message",
|
|
@@ -1580,7 +1588,7 @@
|
|
|
1580
1588
|
"put": {
|
|
1581
1589
|
"request": {
|
|
1582
1590
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1583
|
-
"$id": "https://
|
|
1591
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardPinOffsetPutRequestContext",
|
|
1584
1592
|
"type": "object",
|
|
1585
1593
|
"properties": {
|
|
1586
1594
|
"params": {
|
|
@@ -1589,7 +1597,7 @@
|
|
|
1589
1597
|
"properties": {
|
|
1590
1598
|
"cardId": {
|
|
1591
1599
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1592
|
-
"$id": "https://
|
|
1600
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
1593
1601
|
"type": "string",
|
|
1594
1602
|
"description": "Card identifier",
|
|
1595
1603
|
"format": "uuid"
|
|
@@ -1617,14 +1625,14 @@
|
|
|
1617
1625
|
},
|
|
1618
1626
|
"body": {
|
|
1619
1627
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1620
|
-
"$id": "https://
|
|
1628
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PinOffsetRequest",
|
|
1621
1629
|
"type": "object",
|
|
1622
1630
|
"additionalProperties": false,
|
|
1623
1631
|
"required": ["encryptedDataEncryptionKey", "pinOffsetKeyId", "encryptedUserDefinedPin"],
|
|
1624
1632
|
"properties": {
|
|
1625
1633
|
"pinOffsetKeyId": {
|
|
1626
1634
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1627
|
-
"$id": "https://
|
|
1635
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PinOffsetKeyId",
|
|
1628
1636
|
"type": "string",
|
|
1629
1637
|
"format": "uuid",
|
|
1630
1638
|
"description": "Identifier for the PinOffsetKey used to encrypt the data encryption key."
|
|
@@ -1646,7 +1654,7 @@
|
|
|
1646
1654
|
"responses": {
|
|
1647
1655
|
"204": {
|
|
1648
1656
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1649
|
-
"$id": "https://
|
|
1657
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardPinOffsetPutResponseNoContent",
|
|
1650
1658
|
"type": "object",
|
|
1651
1659
|
"properties": {
|
|
1652
1660
|
"headers": {
|
|
@@ -1667,15 +1675,16 @@
|
|
|
1667
1675
|
"etag": {
|
|
1668
1676
|
"type": "string"
|
|
1669
1677
|
}
|
|
1670
|
-
}
|
|
1678
|
+
},
|
|
1679
|
+
"required": ["last-modified", "created-on", "updated-on", "etag"]
|
|
1671
1680
|
}
|
|
1672
1681
|
},
|
|
1673
|
-
"required": [],
|
|
1682
|
+
"required": ["headers"],
|
|
1674
1683
|
"additionalProperties": false
|
|
1675
1684
|
},
|
|
1676
1685
|
"default": {
|
|
1677
1686
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1678
|
-
"$id": "https://
|
|
1687
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardPinOffsetPutResponseDefault",
|
|
1679
1688
|
"type": "object",
|
|
1680
1689
|
"properties": {
|
|
1681
1690
|
"headers": {
|
|
@@ -1684,7 +1693,7 @@
|
|
|
1684
1693
|
},
|
|
1685
1694
|
"body": {
|
|
1686
1695
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1687
|
-
"$id": "https://
|
|
1696
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
1688
1697
|
"type": "object",
|
|
1689
1698
|
"additionalProperties": false,
|
|
1690
1699
|
"description": "Server error message",
|
|
@@ -1708,7 +1717,7 @@
|
|
|
1708
1717
|
"put": {
|
|
1709
1718
|
"request": {
|
|
1710
1719
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1711
|
-
"$id": "https://
|
|
1720
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardStatePutRequestContext",
|
|
1712
1721
|
"type": "object",
|
|
1713
1722
|
"properties": {
|
|
1714
1723
|
"params": {
|
|
@@ -1717,14 +1726,14 @@
|
|
|
1717
1726
|
"properties": {
|
|
1718
1727
|
"cardId": {
|
|
1719
1728
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1720
|
-
"$id": "https://
|
|
1729
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
1721
1730
|
"type": "string",
|
|
1722
1731
|
"description": "Card identifier",
|
|
1723
1732
|
"format": "uuid"
|
|
1724
1733
|
},
|
|
1725
1734
|
"stateStatus": {
|
|
1726
1735
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1727
|
-
"$id": "https://
|
|
1736
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
1728
1737
|
"description": "The current state of the card",
|
|
1729
1738
|
"type": "string",
|
|
1730
1739
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
@@ -1757,7 +1766,7 @@
|
|
|
1757
1766
|
"responses": {
|
|
1758
1767
|
"204": {
|
|
1759
1768
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1760
|
-
"$id": "https://
|
|
1769
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardStatePutResponseNoContent",
|
|
1761
1770
|
"type": "object",
|
|
1762
1771
|
"properties": {
|
|
1763
1772
|
"headers": {
|
|
@@ -1778,15 +1787,16 @@
|
|
|
1778
1787
|
"etag": {
|
|
1779
1788
|
"type": "string"
|
|
1780
1789
|
}
|
|
1781
|
-
}
|
|
1790
|
+
},
|
|
1791
|
+
"required": ["last-modified", "created-on", "updated-on", "etag"]
|
|
1782
1792
|
}
|
|
1783
1793
|
},
|
|
1784
|
-
"required": [],
|
|
1794
|
+
"required": ["headers"],
|
|
1785
1795
|
"additionalProperties": false
|
|
1786
1796
|
},
|
|
1787
1797
|
"409": {
|
|
1788
1798
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1789
|
-
"$id": "https://
|
|
1799
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardStatePutResponseConflict",
|
|
1790
1800
|
"type": "object",
|
|
1791
1801
|
"properties": {
|
|
1792
1802
|
"headers": {
|
|
@@ -1799,7 +1809,7 @@
|
|
|
1799
1809
|
},
|
|
1800
1810
|
"412": {
|
|
1801
1811
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1802
|
-
"$id": "https://
|
|
1812
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardStatePutResponsePreconditionFailed",
|
|
1803
1813
|
"type": "object",
|
|
1804
1814
|
"properties": {
|
|
1805
1815
|
"headers": {
|
|
@@ -1812,7 +1822,7 @@
|
|
|
1812
1822
|
},
|
|
1813
1823
|
"default": {
|
|
1814
1824
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1815
|
-
"$id": "https://
|
|
1825
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/CardStatePutResponseDefault",
|
|
1816
1826
|
"type": "object",
|
|
1817
1827
|
"properties": {
|
|
1818
1828
|
"headers": {
|
|
@@ -1821,7 +1831,7 @@
|
|
|
1821
1831
|
},
|
|
1822
1832
|
"body": {
|
|
1823
1833
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1824
|
-
"$id": "https://
|
|
1834
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
1825
1835
|
"type": "object",
|
|
1826
1836
|
"additionalProperties": false,
|
|
1827
1837
|
"description": "Server error message",
|
|
@@ -1846,7 +1856,7 @@
|
|
|
1846
1856
|
"put": {
|
|
1847
1857
|
"request": {
|
|
1848
1858
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1849
|
-
"$id": "https://
|
|
1859
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/PinOffsetKeyPutRequestContext",
|
|
1850
1860
|
"type": "object",
|
|
1851
1861
|
"properties": {
|
|
1852
1862
|
"params": {
|
|
@@ -1855,7 +1865,7 @@
|
|
|
1855
1865
|
"properties": {
|
|
1856
1866
|
"pinOffsetKeyId": {
|
|
1857
1867
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1858
|
-
"$id": "https://
|
|
1868
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PinOffsetKeyId",
|
|
1859
1869
|
"type": "string",
|
|
1860
1870
|
"format": "uuid",
|
|
1861
1871
|
"description": "Identifier for the PinOffsetKey used to encrypt the data encryption key."
|
|
@@ -1874,7 +1884,7 @@
|
|
|
1874
1884
|
"responses": {
|
|
1875
1885
|
"200": {
|
|
1876
1886
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1877
|
-
"$id": "https://
|
|
1887
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/PinOffsetKeyPutResponseOK",
|
|
1878
1888
|
"type": "object",
|
|
1879
1889
|
"properties": {
|
|
1880
1890
|
"headers": {
|
|
@@ -1883,7 +1893,7 @@
|
|
|
1883
1893
|
},
|
|
1884
1894
|
"body": {
|
|
1885
1895
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1886
|
-
"$id": "https://
|
|
1896
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PinOffsetKey",
|
|
1887
1897
|
"type": "object",
|
|
1888
1898
|
"additionalProperties": false,
|
|
1889
1899
|
"required": ["transmissionKey"],
|
|
@@ -1900,7 +1910,7 @@
|
|
|
1900
1910
|
},
|
|
1901
1911
|
"default": {
|
|
1902
1912
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1903
|
-
"$id": "https://
|
|
1913
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/api/PinOffsetKeyPutResponseDefault",
|
|
1904
1914
|
"type": "object",
|
|
1905
1915
|
"properties": {
|
|
1906
1916
|
"headers": {
|
|
@@ -1909,7 +1919,7 @@
|
|
|
1909
1919
|
},
|
|
1910
1920
|
"body": {
|
|
1911
1921
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1912
|
-
"$id": "https://
|
|
1922
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
1913
1923
|
"type": "object",
|
|
1914
1924
|
"additionalProperties": false,
|
|
1915
1925
|
"description": "Server error message",
|
|
@@ -1933,14 +1943,14 @@
|
|
|
1933
1943
|
"definitions": {
|
|
1934
1944
|
"ActiveStatus": {
|
|
1935
1945
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1936
|
-
"$id": "https://
|
|
1946
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
1937
1947
|
"description": "The active/inactive status for the card",
|
|
1938
1948
|
"type": "string",
|
|
1939
1949
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
1940
1950
|
},
|
|
1941
1951
|
"Bin": {
|
|
1942
1952
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1943
|
-
"$id": "https://
|
|
1953
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
1944
1954
|
"type": "string",
|
|
1945
1955
|
"pattern": "^\\d+$",
|
|
1946
1956
|
"description": "Bank Identification Number",
|
|
@@ -1949,14 +1959,14 @@
|
|
|
1949
1959
|
},
|
|
1950
1960
|
"BlockStatus": {
|
|
1951
1961
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1952
|
-
"$id": "https://
|
|
1962
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
1953
1963
|
"type": "string",
|
|
1954
1964
|
"description": "Whether the card is open or blocked for various reasons",
|
|
1955
1965
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
1956
1966
|
},
|
|
1957
1967
|
"Card": {
|
|
1958
1968
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1959
|
-
"$id": "https://
|
|
1969
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Card",
|
|
1960
1970
|
"type": "object",
|
|
1961
1971
|
"additionalProperties": false,
|
|
1962
1972
|
"required": [
|
|
@@ -1980,7 +1990,7 @@
|
|
|
1980
1990
|
"properties": {
|
|
1981
1991
|
"bin": {
|
|
1982
1992
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1983
|
-
"$id": "https://
|
|
1993
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
1984
1994
|
"type": "string",
|
|
1985
1995
|
"pattern": "^\\d+$",
|
|
1986
1996
|
"description": "Bank Identification Number",
|
|
@@ -1996,7 +2006,7 @@
|
|
|
1996
2006
|
},
|
|
1997
2007
|
"expirationDate": {
|
|
1998
2008
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1999
|
-
"$id": "https://
|
|
2009
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
2000
2010
|
"type": "string",
|
|
2001
2011
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
2002
2012
|
"format": "YYMM",
|
|
@@ -2029,28 +2039,28 @@
|
|
|
2029
2039
|
},
|
|
2030
2040
|
"state": {
|
|
2031
2041
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2032
|
-
"$id": "https://
|
|
2042
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
2033
2043
|
"description": "The current state of the card",
|
|
2034
2044
|
"type": "string",
|
|
2035
2045
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
2036
2046
|
},
|
|
2037
2047
|
"active": {
|
|
2038
2048
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2039
|
-
"$id": "https://
|
|
2049
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
2040
2050
|
"description": "The active/inactive status for the card",
|
|
2041
2051
|
"type": "string",
|
|
2042
2052
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
2043
2053
|
},
|
|
2044
2054
|
"block": {
|
|
2045
2055
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2046
|
-
"$id": "https://
|
|
2056
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
2047
2057
|
"type": "string",
|
|
2048
2058
|
"description": "Whether the card is open or blocked for various reasons",
|
|
2049
2059
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
2050
2060
|
},
|
|
2051
2061
|
"lock": {
|
|
2052
2062
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2053
|
-
"$id": "https://
|
|
2063
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
2054
2064
|
"type": "string",
|
|
2055
2065
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
2056
2066
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -2078,21 +2088,21 @@
|
|
|
2078
2088
|
},
|
|
2079
2089
|
"CardResponse": {
|
|
2080
2090
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2081
|
-
"$id": "https://
|
|
2091
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardResponse",
|
|
2082
2092
|
"type": "object",
|
|
2083
2093
|
"additionalProperties": false,
|
|
2084
2094
|
"required": ["dataEncryptionKeyId", "storageKeyId", "card"],
|
|
2085
2095
|
"properties": {
|
|
2086
2096
|
"dataEncryptionKeyId": {
|
|
2087
2097
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2088
|
-
"$id": "https://
|
|
2098
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyId",
|
|
2089
2099
|
"type": "string",
|
|
2090
2100
|
"description": "Reference to encryption keys Payment Card Service will use to encrypt the Card object.\n",
|
|
2091
2101
|
"format": "uuid"
|
|
2092
2102
|
},
|
|
2093
2103
|
"storageKeyId": {
|
|
2094
2104
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2095
|
-
"$id": "https://
|
|
2105
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StorageKeyId",
|
|
2096
2106
|
"type": "string",
|
|
2097
2107
|
"description": "DEK's non-derived identifier to be used by Check Digit services only.\n"
|
|
2098
2108
|
},
|
|
@@ -2102,7 +2112,7 @@
|
|
|
2102
2112
|
},
|
|
2103
2113
|
"card": {
|
|
2104
2114
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2105
|
-
"$id": "https://
|
|
2115
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Card",
|
|
2106
2116
|
"type": "object",
|
|
2107
2117
|
"additionalProperties": false,
|
|
2108
2118
|
"required": [
|
|
@@ -2126,7 +2136,7 @@
|
|
|
2126
2136
|
"properties": {
|
|
2127
2137
|
"bin": {
|
|
2128
2138
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2129
|
-
"$id": "https://
|
|
2139
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
2130
2140
|
"type": "string",
|
|
2131
2141
|
"pattern": "^\\d+$",
|
|
2132
2142
|
"description": "Bank Identification Number",
|
|
@@ -2142,7 +2152,7 @@
|
|
|
2142
2152
|
},
|
|
2143
2153
|
"expirationDate": {
|
|
2144
2154
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2145
|
-
"$id": "https://
|
|
2155
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
2146
2156
|
"type": "string",
|
|
2147
2157
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
2148
2158
|
"format": "YYMM",
|
|
@@ -2175,28 +2185,28 @@
|
|
|
2175
2185
|
},
|
|
2176
2186
|
"state": {
|
|
2177
2187
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2178
|
-
"$id": "https://
|
|
2188
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
2179
2189
|
"description": "The current state of the card",
|
|
2180
2190
|
"type": "string",
|
|
2181
2191
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
2182
2192
|
},
|
|
2183
2193
|
"active": {
|
|
2184
2194
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2185
|
-
"$id": "https://
|
|
2195
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
2186
2196
|
"description": "The active/inactive status for the card",
|
|
2187
2197
|
"type": "string",
|
|
2188
2198
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
2189
2199
|
},
|
|
2190
2200
|
"block": {
|
|
2191
2201
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2192
|
-
"$id": "https://
|
|
2202
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
2193
2203
|
"type": "string",
|
|
2194
2204
|
"description": "Whether the card is open or blocked for various reasons",
|
|
2195
2205
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
2196
2206
|
},
|
|
2197
2207
|
"lock": {
|
|
2198
2208
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2199
|
-
"$id": "https://
|
|
2209
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
2200
2210
|
"type": "string",
|
|
2201
2211
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
2202
2212
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -2226,21 +2236,21 @@
|
|
|
2226
2236
|
},
|
|
2227
2237
|
"CardQueryResponse": {
|
|
2228
2238
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2229
|
-
"$id": "https://
|
|
2239
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardQueryResponse",
|
|
2230
2240
|
"type": "object",
|
|
2231
2241
|
"additionalProperties": false,
|
|
2232
2242
|
"required": ["dataEncryptionKeyId", "storageKeyId", "cardId", "card"],
|
|
2233
2243
|
"properties": {
|
|
2234
2244
|
"dataEncryptionKeyId": {
|
|
2235
2245
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2236
|
-
"$id": "https://
|
|
2246
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyId",
|
|
2237
2247
|
"type": "string",
|
|
2238
2248
|
"description": "Reference to encryption keys Payment Card Service will use to encrypt the Card object.\n",
|
|
2239
2249
|
"format": "uuid"
|
|
2240
2250
|
},
|
|
2241
2251
|
"storageKeyId": {
|
|
2242
2252
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2243
|
-
"$id": "https://
|
|
2253
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StorageKeyId",
|
|
2244
2254
|
"type": "string",
|
|
2245
2255
|
"description": "DEK's non-derived identifier to be used by Check Digit services only.\n"
|
|
2246
2256
|
},
|
|
@@ -2250,14 +2260,14 @@
|
|
|
2250
2260
|
},
|
|
2251
2261
|
"cardId": {
|
|
2252
2262
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2253
|
-
"$id": "https://
|
|
2263
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
2254
2264
|
"type": "string",
|
|
2255
2265
|
"description": "Card identifier",
|
|
2256
2266
|
"format": "uuid"
|
|
2257
2267
|
},
|
|
2258
2268
|
"card": {
|
|
2259
2269
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2260
|
-
"$id": "https://
|
|
2270
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Card",
|
|
2261
2271
|
"type": "object",
|
|
2262
2272
|
"additionalProperties": false,
|
|
2263
2273
|
"required": [
|
|
@@ -2281,7 +2291,7 @@
|
|
|
2281
2291
|
"properties": {
|
|
2282
2292
|
"bin": {
|
|
2283
2293
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2284
|
-
"$id": "https://
|
|
2294
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
2285
2295
|
"type": "string",
|
|
2286
2296
|
"pattern": "^\\d+$",
|
|
2287
2297
|
"description": "Bank Identification Number",
|
|
@@ -2297,7 +2307,7 @@
|
|
|
2297
2307
|
},
|
|
2298
2308
|
"expirationDate": {
|
|
2299
2309
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2300
|
-
"$id": "https://
|
|
2310
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
2301
2311
|
"type": "string",
|
|
2302
2312
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
2303
2313
|
"format": "YYMM",
|
|
@@ -2330,28 +2340,28 @@
|
|
|
2330
2340
|
},
|
|
2331
2341
|
"state": {
|
|
2332
2342
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2333
|
-
"$id": "https://
|
|
2343
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
2334
2344
|
"description": "The current state of the card",
|
|
2335
2345
|
"type": "string",
|
|
2336
2346
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
2337
2347
|
},
|
|
2338
2348
|
"active": {
|
|
2339
2349
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2340
|
-
"$id": "https://
|
|
2350
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
2341
2351
|
"description": "The active/inactive status for the card",
|
|
2342
2352
|
"type": "string",
|
|
2343
2353
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
2344
2354
|
},
|
|
2345
2355
|
"block": {
|
|
2346
2356
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2347
|
-
"$id": "https://
|
|
2357
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
2348
2358
|
"type": "string",
|
|
2349
2359
|
"description": "Whether the card is open or blocked for various reasons",
|
|
2350
2360
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
2351
2361
|
},
|
|
2352
2362
|
"lock": {
|
|
2353
2363
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2354
|
-
"$id": "https://
|
|
2364
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
2355
2365
|
"type": "string",
|
|
2356
2366
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
2357
2367
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -2381,14 +2391,14 @@
|
|
|
2381
2391
|
},
|
|
2382
2392
|
"CardId": {
|
|
2383
2393
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2384
|
-
"$id": "https://
|
|
2394
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
2385
2395
|
"type": "string",
|
|
2386
2396
|
"description": "Card identifier",
|
|
2387
2397
|
"format": "uuid"
|
|
2388
2398
|
},
|
|
2389
2399
|
"Query": {
|
|
2390
2400
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2391
|
-
"$id": "https://
|
|
2401
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Query",
|
|
2392
2402
|
"description": "Response from querying /card by cardNumberHash",
|
|
2393
2403
|
"type": "object",
|
|
2394
2404
|
"required": ["cards"],
|
|
@@ -2397,21 +2407,21 @@
|
|
|
2397
2407
|
"type": "array",
|
|
2398
2408
|
"items": {
|
|
2399
2409
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2400
|
-
"$id": "https://
|
|
2410
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardQueryResponse",
|
|
2401
2411
|
"type": "object",
|
|
2402
2412
|
"additionalProperties": false,
|
|
2403
2413
|
"required": ["dataEncryptionKeyId", "storageKeyId", "cardId", "card"],
|
|
2404
2414
|
"properties": {
|
|
2405
2415
|
"dataEncryptionKeyId": {
|
|
2406
2416
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2407
|
-
"$id": "https://
|
|
2417
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyId",
|
|
2408
2418
|
"type": "string",
|
|
2409
2419
|
"description": "Reference to encryption keys Payment Card Service will use to encrypt the Card object.\n",
|
|
2410
2420
|
"format": "uuid"
|
|
2411
2421
|
},
|
|
2412
2422
|
"storageKeyId": {
|
|
2413
2423
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2414
|
-
"$id": "https://
|
|
2424
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StorageKeyId",
|
|
2415
2425
|
"type": "string",
|
|
2416
2426
|
"description": "DEK's non-derived identifier to be used by Check Digit services only.\n"
|
|
2417
2427
|
},
|
|
@@ -2421,14 +2431,14 @@
|
|
|
2421
2431
|
},
|
|
2422
2432
|
"cardId": {
|
|
2423
2433
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2424
|
-
"$id": "https://
|
|
2434
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardId",
|
|
2425
2435
|
"type": "string",
|
|
2426
2436
|
"description": "Card identifier",
|
|
2427
2437
|
"format": "uuid"
|
|
2428
2438
|
},
|
|
2429
2439
|
"card": {
|
|
2430
2440
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2431
|
-
"$id": "https://
|
|
2441
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Card",
|
|
2432
2442
|
"type": "object",
|
|
2433
2443
|
"additionalProperties": false,
|
|
2434
2444
|
"required": [
|
|
@@ -2452,7 +2462,7 @@
|
|
|
2452
2462
|
"properties": {
|
|
2453
2463
|
"bin": {
|
|
2454
2464
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2455
|
-
"$id": "https://
|
|
2465
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
2456
2466
|
"type": "string",
|
|
2457
2467
|
"pattern": "^\\d+$",
|
|
2458
2468
|
"description": "Bank Identification Number",
|
|
@@ -2468,7 +2478,7 @@
|
|
|
2468
2478
|
},
|
|
2469
2479
|
"expirationDate": {
|
|
2470
2480
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2471
|
-
"$id": "https://
|
|
2481
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
2472
2482
|
"type": "string",
|
|
2473
2483
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
2474
2484
|
"format": "YYMM",
|
|
@@ -2501,28 +2511,28 @@
|
|
|
2501
2511
|
},
|
|
2502
2512
|
"state": {
|
|
2503
2513
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2504
|
-
"$id": "https://
|
|
2514
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
2505
2515
|
"description": "The current state of the card",
|
|
2506
2516
|
"type": "string",
|
|
2507
2517
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
2508
2518
|
},
|
|
2509
2519
|
"active": {
|
|
2510
2520
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2511
|
-
"$id": "https://
|
|
2521
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
2512
2522
|
"description": "The active/inactive status for the card",
|
|
2513
2523
|
"type": "string",
|
|
2514
2524
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
2515
2525
|
},
|
|
2516
2526
|
"block": {
|
|
2517
2527
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2518
|
-
"$id": "https://
|
|
2528
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
2519
2529
|
"type": "string",
|
|
2520
2530
|
"description": "Whether the card is open or blocked for various reasons",
|
|
2521
2531
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
2522
2532
|
},
|
|
2523
2533
|
"lock": {
|
|
2524
2534
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2525
|
-
"$id": "https://
|
|
2535
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
2526
2536
|
"type": "string",
|
|
2527
2537
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
2528
2538
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -2555,14 +2565,14 @@
|
|
|
2555
2565
|
},
|
|
2556
2566
|
"CardNumberRequest": {
|
|
2557
2567
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2558
|
-
"$id": "https://
|
|
2568
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/CardNumberRequest",
|
|
2559
2569
|
"type": "object",
|
|
2560
2570
|
"additionalProperties": false,
|
|
2561
2571
|
"required": ["publicKey"],
|
|
2562
2572
|
"properties": {
|
|
2563
2573
|
"publicKey": {
|
|
2564
2574
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2565
|
-
"$id": "https://
|
|
2575
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PublicKey",
|
|
2566
2576
|
"description": "Public key in PEM format",
|
|
2567
2577
|
"type": "string",
|
|
2568
2578
|
"example": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwm2sxmRdTF7ZIBA6+ngO\n8jOTCHmID0PpQB1q85+hrcLSfB1rWY9bzNNLabBo/ajDnA4Pcadq/x6gpg70qZcR\n9Wxm6TttKzBPZsxasGXgSTDqEi2KcYZgq1mL4qyxUvyIms7/llGy+W9b5huZaVcO\nxdT1tw/zctbOhb6S2t5vH+zkta/2ncUXjG7i8XdLsJ1qe4K1kYbA4KVkOMmAtw7O\n4STk0TZDD0YARdmrciorJjbIVt0Xj1CrYQ5QbDGrlfeXgrcZwX5f9wT2MnKlY5oZ\n5Wtb57oGtLkVf8g6vN/2jGtAmOmHK2hHwNd/+zUet5G/S5uwEli4RgMPP4pUoKgd\nGQIDAQAB\n-----END PUBLIC KEY-----\n"
|
|
@@ -2571,7 +2581,7 @@
|
|
|
2571
2581
|
},
|
|
2572
2582
|
"EncryptedCardNumber": {
|
|
2573
2583
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2574
|
-
"$id": "https://
|
|
2584
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/EncryptedCardNumber",
|
|
2575
2585
|
"type": "object",
|
|
2576
2586
|
"additionalProperties": false,
|
|
2577
2587
|
"required": ["encryptedDataEncryptionKey", "cardNumber"],
|
|
@@ -2588,7 +2598,7 @@
|
|
|
2588
2598
|
},
|
|
2589
2599
|
"Error": {
|
|
2590
2600
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2591
|
-
"$id": "https://
|
|
2601
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Error",
|
|
2592
2602
|
"type": "object",
|
|
2593
2603
|
"additionalProperties": false,
|
|
2594
2604
|
"description": "Server error message",
|
|
@@ -2603,7 +2613,7 @@
|
|
|
2603
2613
|
},
|
|
2604
2614
|
"ExpirationDate": {
|
|
2605
2615
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2606
|
-
"$id": "https://
|
|
2616
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
2607
2617
|
"type": "string",
|
|
2608
2618
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
2609
2619
|
"format": "YYMM",
|
|
@@ -2613,14 +2623,14 @@
|
|
|
2613
2623
|
},
|
|
2614
2624
|
"DataEncryptionKeyId": {
|
|
2615
2625
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2616
|
-
"$id": "https://
|
|
2626
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyId",
|
|
2617
2627
|
"type": "string",
|
|
2618
2628
|
"description": "Reference to encryption keys Payment Card Service will use to encrypt the Card object.\n",
|
|
2619
2629
|
"format": "uuid"
|
|
2620
2630
|
},
|
|
2621
2631
|
"DataEncryptionKeyRequest": {
|
|
2622
2632
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2623
|
-
"$id": "https://
|
|
2633
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyRequest",
|
|
2624
2634
|
"type": "object",
|
|
2625
2635
|
"additionalProperties": false,
|
|
2626
2636
|
"required": ["publicKeys"],
|
|
@@ -2631,7 +2641,7 @@
|
|
|
2631
2641
|
"description": "List of public keys in PEM format.\n\nAssociated private keys can be used to decrypt card data encrypted by Payment Card Service.\n",
|
|
2632
2642
|
"items": {
|
|
2633
2643
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2634
|
-
"$id": "https://
|
|
2644
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PublicKey",
|
|
2635
2645
|
"description": "Public key in PEM format",
|
|
2636
2646
|
"type": "string",
|
|
2637
2647
|
"example": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwm2sxmRdTF7ZIBA6+ngO\n8jOTCHmID0PpQB1q85+hrcLSfB1rWY9bzNNLabBo/ajDnA4Pcadq/x6gpg70qZcR\n9Wxm6TttKzBPZsxasGXgSTDqEi2KcYZgq1mL4qyxUvyIms7/llGy+W9b5huZaVcO\nxdT1tw/zctbOhb6S2t5vH+zkta/2ncUXjG7i8XdLsJ1qe4K1kYbA4KVkOMmAtw7O\n4STk0TZDD0YARdmrciorJjbIVt0Xj1CrYQ5QbDGrlfeXgrcZwX5f9wT2MnKlY5oZ\n5Wtb57oGtLkVf8g6vN/2jGtAmOmHK2hHwNd/+zUet5G/S5uwEli4RgMPP4pUoKgd\nGQIDAQAB\n-----END PUBLIC KEY-----\n"
|
|
@@ -2641,7 +2651,7 @@
|
|
|
2641
2651
|
},
|
|
2642
2652
|
"DataEncryptionKeyResponse": {
|
|
2643
2653
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2644
|
-
"$id": "https://
|
|
2654
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyResponse",
|
|
2645
2655
|
"type": "object",
|
|
2646
2656
|
"required": ["transmissionKey", "encryptedDataEncryptionKeys", "createdOn", "lastModified"],
|
|
2647
2657
|
"properties": {
|
|
@@ -2665,7 +2675,7 @@
|
|
|
2665
2675
|
"properties": {
|
|
2666
2676
|
"publicKeyHash": {
|
|
2667
2677
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2668
|
-
"$id": "https://
|
|
2678
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Hash",
|
|
2669
2679
|
"type": "string",
|
|
2670
2680
|
"format": "uuid",
|
|
2671
2681
|
"example": "15a85f64-5717-4562-b3fc-2c963f66afa6",
|
|
@@ -2686,7 +2696,7 @@
|
|
|
2686
2696
|
},
|
|
2687
2697
|
"History": {
|
|
2688
2698
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2689
|
-
"$id": "https://
|
|
2699
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/History",
|
|
2690
2700
|
"description": "The History object represents the updates to a Card object over time.\n",
|
|
2691
2701
|
"type": "object",
|
|
2692
2702
|
"required": ["updates"],
|
|
@@ -2708,7 +2718,7 @@
|
|
|
2708
2718
|
"type": "array",
|
|
2709
2719
|
"items": {
|
|
2710
2720
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2711
|
-
"$id": "https://
|
|
2721
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Card",
|
|
2712
2722
|
"type": "object",
|
|
2713
2723
|
"additionalProperties": false,
|
|
2714
2724
|
"required": [
|
|
@@ -2732,7 +2742,7 @@
|
|
|
2732
2742
|
"properties": {
|
|
2733
2743
|
"bin": {
|
|
2734
2744
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2735
|
-
"$id": "https://
|
|
2745
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
2736
2746
|
"type": "string",
|
|
2737
2747
|
"pattern": "^\\d+$",
|
|
2738
2748
|
"description": "Bank Identification Number",
|
|
@@ -2748,7 +2758,7 @@
|
|
|
2748
2758
|
},
|
|
2749
2759
|
"expirationDate": {
|
|
2750
2760
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2751
|
-
"$id": "https://
|
|
2761
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
2752
2762
|
"type": "string",
|
|
2753
2763
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
2754
2764
|
"format": "YYMM",
|
|
@@ -2781,28 +2791,28 @@
|
|
|
2781
2791
|
},
|
|
2782
2792
|
"state": {
|
|
2783
2793
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2784
|
-
"$id": "https://
|
|
2794
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
2785
2795
|
"description": "The current state of the card",
|
|
2786
2796
|
"type": "string",
|
|
2787
2797
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
2788
2798
|
},
|
|
2789
2799
|
"active": {
|
|
2790
2800
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2791
|
-
"$id": "https://
|
|
2801
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
2792
2802
|
"description": "The active/inactive status for the card",
|
|
2793
2803
|
"type": "string",
|
|
2794
2804
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
2795
2805
|
},
|
|
2796
2806
|
"block": {
|
|
2797
2807
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2798
|
-
"$id": "https://
|
|
2808
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
2799
2809
|
"type": "string",
|
|
2800
2810
|
"description": "Whether the card is open or blocked for various reasons",
|
|
2801
2811
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
2802
2812
|
},
|
|
2803
2813
|
"lock": {
|
|
2804
2814
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2805
|
-
"$id": "https://
|
|
2815
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
2806
2816
|
"type": "string",
|
|
2807
2817
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
2808
2818
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -2833,14 +2843,14 @@
|
|
|
2833
2843
|
},
|
|
2834
2844
|
"LockStatus": {
|
|
2835
2845
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2836
|
-
"$id": "https://
|
|
2846
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
2837
2847
|
"type": "string",
|
|
2838
2848
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
2839
2849
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
2840
2850
|
},
|
|
2841
2851
|
"Ping": {
|
|
2842
2852
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2843
|
-
"$id": "https://
|
|
2853
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Ping",
|
|
2844
2854
|
"type": "object",
|
|
2845
2855
|
"additionalProperties": false,
|
|
2846
2856
|
"required": ["serverTime"],
|
|
@@ -2855,7 +2865,7 @@
|
|
|
2855
2865
|
},
|
|
2856
2866
|
"PinOffsetKey": {
|
|
2857
2867
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2858
|
-
"$id": "https://
|
|
2868
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PinOffsetKey",
|
|
2859
2869
|
"type": "object",
|
|
2860
2870
|
"additionalProperties": false,
|
|
2861
2871
|
"required": ["transmissionKey"],
|
|
@@ -2868,21 +2878,21 @@
|
|
|
2868
2878
|
},
|
|
2869
2879
|
"PinOffsetKeyId": {
|
|
2870
2880
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2871
|
-
"$id": "https://
|
|
2881
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PinOffsetKeyId",
|
|
2872
2882
|
"type": "string",
|
|
2873
2883
|
"format": "uuid",
|
|
2874
2884
|
"description": "Identifier for the PinOffsetKey used to encrypt the data encryption key."
|
|
2875
2885
|
},
|
|
2876
2886
|
"PinOffsetRequest": {
|
|
2877
2887
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2878
|
-
"$id": "https://
|
|
2888
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PinOffsetRequest",
|
|
2879
2889
|
"type": "object",
|
|
2880
2890
|
"additionalProperties": false,
|
|
2881
2891
|
"required": ["encryptedDataEncryptionKey", "pinOffsetKeyId", "encryptedUserDefinedPin"],
|
|
2882
2892
|
"properties": {
|
|
2883
2893
|
"pinOffsetKeyId": {
|
|
2884
2894
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2885
|
-
"$id": "https://
|
|
2895
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PinOffsetKeyId",
|
|
2886
2896
|
"type": "string",
|
|
2887
2897
|
"format": "uuid",
|
|
2888
2898
|
"description": "Identifier for the PinOffsetKey used to encrypt the data encryption key."
|
|
@@ -2899,7 +2909,7 @@
|
|
|
2899
2909
|
},
|
|
2900
2910
|
"Hash": {
|
|
2901
2911
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2902
|
-
"$id": "https://
|
|
2912
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Hash",
|
|
2903
2913
|
"type": "string",
|
|
2904
2914
|
"format": "uuid",
|
|
2905
2915
|
"example": "15a85f64-5717-4562-b3fc-2c963f66afa6",
|
|
@@ -2907,14 +2917,14 @@
|
|
|
2907
2917
|
},
|
|
2908
2918
|
"NewCard": {
|
|
2909
2919
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2910
|
-
"$id": "https://
|
|
2920
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/NewCard",
|
|
2911
2921
|
"type": "object",
|
|
2912
2922
|
"additionalProperties": false,
|
|
2913
2923
|
"required": ["bin", "expirationDate", "serviceCode", "sequenceNumber", "state", "active", "block", "lock"],
|
|
2914
2924
|
"properties": {
|
|
2915
2925
|
"bin": {
|
|
2916
2926
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2917
|
-
"$id": "https://
|
|
2927
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
2918
2928
|
"type": "string",
|
|
2919
2929
|
"pattern": "^\\d+$",
|
|
2920
2930
|
"description": "Bank Identification Number",
|
|
@@ -2923,7 +2933,7 @@
|
|
|
2923
2933
|
},
|
|
2924
2934
|
"expirationDate": {
|
|
2925
2935
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2926
|
-
"$id": "https://
|
|
2936
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
2927
2937
|
"type": "string",
|
|
2928
2938
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
2929
2939
|
"format": "YYMM",
|
|
@@ -2946,28 +2956,28 @@
|
|
|
2946
2956
|
},
|
|
2947
2957
|
"state": {
|
|
2948
2958
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2949
|
-
"$id": "https://
|
|
2959
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
2950
2960
|
"description": "The current state of the card",
|
|
2951
2961
|
"type": "string",
|
|
2952
2962
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
2953
2963
|
},
|
|
2954
2964
|
"active": {
|
|
2955
2965
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2956
|
-
"$id": "https://
|
|
2966
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
2957
2967
|
"description": "The active/inactive status for the card",
|
|
2958
2968
|
"type": "string",
|
|
2959
2969
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
2960
2970
|
},
|
|
2961
2971
|
"block": {
|
|
2962
2972
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2963
|
-
"$id": "https://
|
|
2973
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
2964
2974
|
"type": "string",
|
|
2965
2975
|
"description": "Whether the card is open or blocked for various reasons",
|
|
2966
2976
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
2967
2977
|
},
|
|
2968
2978
|
"lock": {
|
|
2969
2979
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2970
|
-
"$id": "https://
|
|
2980
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
2971
2981
|
"type": "string",
|
|
2972
2982
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
2973
2983
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -2976,14 +2986,14 @@
|
|
|
2976
2986
|
},
|
|
2977
2987
|
"NewCardRequest": {
|
|
2978
2988
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2979
|
-
"$id": "https://
|
|
2989
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/NewCardRequest",
|
|
2980
2990
|
"type": "object",
|
|
2981
2991
|
"required": ["dataEncryptionKeyId", "cardNumberLength", "newCard"],
|
|
2982
2992
|
"additionalProperties": false,
|
|
2983
2993
|
"properties": {
|
|
2984
2994
|
"dataEncryptionKeyId": {
|
|
2985
2995
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2986
|
-
"$id": "https://
|
|
2996
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyId",
|
|
2987
2997
|
"type": "string",
|
|
2988
2998
|
"description": "Reference to encryption keys Payment Card Service will use to encrypt the Card object.\n",
|
|
2989
2999
|
"format": "uuid"
|
|
@@ -2996,14 +3006,14 @@
|
|
|
2996
3006
|
},
|
|
2997
3007
|
"newCard": {
|
|
2998
3008
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2999
|
-
"$id": "https://
|
|
3009
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/NewCard",
|
|
3000
3010
|
"type": "object",
|
|
3001
3011
|
"additionalProperties": false,
|
|
3002
3012
|
"required": ["bin", "expirationDate", "serviceCode", "sequenceNumber", "state", "active", "block", "lock"],
|
|
3003
3013
|
"properties": {
|
|
3004
3014
|
"bin": {
|
|
3005
3015
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3006
|
-
"$id": "https://
|
|
3016
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
3007
3017
|
"type": "string",
|
|
3008
3018
|
"pattern": "^\\d+$",
|
|
3009
3019
|
"description": "Bank Identification Number",
|
|
@@ -3012,7 +3022,7 @@
|
|
|
3012
3022
|
},
|
|
3013
3023
|
"expirationDate": {
|
|
3014
3024
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3015
|
-
"$id": "https://
|
|
3025
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
3016
3026
|
"type": "string",
|
|
3017
3027
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
3018
3028
|
"format": "YYMM",
|
|
@@ -3035,28 +3045,28 @@
|
|
|
3035
3045
|
},
|
|
3036
3046
|
"state": {
|
|
3037
3047
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3038
|
-
"$id": "https://
|
|
3048
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
3039
3049
|
"description": "The current state of the card",
|
|
3040
3050
|
"type": "string",
|
|
3041
3051
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
3042
3052
|
},
|
|
3043
3053
|
"active": {
|
|
3044
3054
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3045
|
-
"$id": "https://
|
|
3055
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
3046
3056
|
"description": "The active/inactive status for the card",
|
|
3047
3057
|
"type": "string",
|
|
3048
3058
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
3049
3059
|
},
|
|
3050
3060
|
"block": {
|
|
3051
3061
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3052
|
-
"$id": "https://
|
|
3062
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
3053
3063
|
"type": "string",
|
|
3054
3064
|
"description": "Whether the card is open or blocked for various reasons",
|
|
3055
3065
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
3056
3066
|
},
|
|
3057
3067
|
"lock": {
|
|
3058
3068
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3059
|
-
"$id": "https://
|
|
3069
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
3060
3070
|
"type": "string",
|
|
3061
3071
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
3062
3072
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -3067,7 +3077,7 @@
|
|
|
3067
3077
|
},
|
|
3068
3078
|
"NewCardRequestWithCardNumber": {
|
|
3069
3079
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3070
|
-
"$id": "https://
|
|
3080
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/NewCardRequestWithCardNumber",
|
|
3071
3081
|
"type": "object",
|
|
3072
3082
|
"required": ["encryptedCardNumber", "encryptedDataEncryptionKey", "dataEncryptionKeyId", "newCard"],
|
|
3073
3083
|
"properties": {
|
|
@@ -3080,21 +3090,21 @@
|
|
|
3080
3090
|
},
|
|
3081
3091
|
"dataEncryptionKeyId": {
|
|
3082
3092
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3083
|
-
"$id": "https://
|
|
3093
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/DataEncryptionKeyId",
|
|
3084
3094
|
"type": "string",
|
|
3085
3095
|
"description": "Reference to encryption keys Payment Card Service will use to encrypt the Card object.\n",
|
|
3086
3096
|
"format": "uuid"
|
|
3087
3097
|
},
|
|
3088
3098
|
"newCard": {
|
|
3089
3099
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3090
|
-
"$id": "https://
|
|
3100
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/NewCard",
|
|
3091
3101
|
"type": "object",
|
|
3092
3102
|
"additionalProperties": false,
|
|
3093
3103
|
"required": ["bin", "expirationDate", "serviceCode", "sequenceNumber", "state", "active", "block", "lock"],
|
|
3094
3104
|
"properties": {
|
|
3095
3105
|
"bin": {
|
|
3096
3106
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3097
|
-
"$id": "https://
|
|
3107
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/Bin",
|
|
3098
3108
|
"type": "string",
|
|
3099
3109
|
"pattern": "^\\d+$",
|
|
3100
3110
|
"description": "Bank Identification Number",
|
|
@@ -3103,7 +3113,7 @@
|
|
|
3103
3113
|
},
|
|
3104
3114
|
"expirationDate": {
|
|
3105
3115
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3106
|
-
"$id": "https://
|
|
3116
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ExpirationDate",
|
|
3107
3117
|
"type": "string",
|
|
3108
3118
|
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
3109
3119
|
"format": "YYMM",
|
|
@@ -3126,28 +3136,28 @@
|
|
|
3126
3136
|
},
|
|
3127
3137
|
"state": {
|
|
3128
3138
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3129
|
-
"$id": "https://
|
|
3139
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
3130
3140
|
"description": "The current state of the card",
|
|
3131
3141
|
"type": "string",
|
|
3132
3142
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
3133
3143
|
},
|
|
3134
3144
|
"active": {
|
|
3135
3145
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3136
|
-
"$id": "https://
|
|
3146
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/ActiveStatus",
|
|
3137
3147
|
"description": "The active/inactive status for the card",
|
|
3138
3148
|
"type": "string",
|
|
3139
3149
|
"enum": ["INACTIVE", "ACTIVE"]
|
|
3140
3150
|
},
|
|
3141
3151
|
"block": {
|
|
3142
3152
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3143
|
-
"$id": "https://
|
|
3153
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/BlockStatus",
|
|
3144
3154
|
"type": "string",
|
|
3145
3155
|
"description": "Whether the card is open or blocked for various reasons",
|
|
3146
3156
|
"enum": ["OPEN", "BLOCKED LOST OR STOLEN", "BLOCKED NO FRAUD", "BLOCKED WITH FRAUD"]
|
|
3147
3157
|
},
|
|
3148
3158
|
"lock": {
|
|
3149
3159
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3150
|
-
"$id": "https://
|
|
3160
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/LockStatus",
|
|
3151
3161
|
"type": "string",
|
|
3152
3162
|
"description": "A cardholder initiated status. A locked card will fail authorization. Locked cards can be unlocked.\n\nA cardholder may choose to lock a card while temporarily misplaced.\n",
|
|
3153
3163
|
"enum": ["LOCKED", "UNLOCKED"]
|
|
@@ -3159,21 +3169,21 @@
|
|
|
3159
3169
|
},
|
|
3160
3170
|
"PublicKey": {
|
|
3161
3171
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3162
|
-
"$id": "https://
|
|
3172
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PublicKey",
|
|
3163
3173
|
"description": "Public key in PEM format",
|
|
3164
3174
|
"type": "string",
|
|
3165
3175
|
"example": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwm2sxmRdTF7ZIBA6+ngO\n8jOTCHmID0PpQB1q85+hrcLSfB1rWY9bzNNLabBo/ajDnA4Pcadq/x6gpg70qZcR\n9Wxm6TttKzBPZsxasGXgSTDqEi2KcYZgq1mL4qyxUvyIms7/llGy+W9b5huZaVcO\nxdT1tw/zctbOhb6S2t5vH+zkta/2ncUXjG7i8XdLsJ1qe4K1kYbA4KVkOMmAtw7O\n4STk0TZDD0YARdmrciorJjbIVt0Xj1CrYQ5QbDGrlfeXgrcZwX5f9wT2MnKlY5oZ\n5Wtb57oGtLkVf8g6vN/2jGtAmOmHK2hHwNd/+zUet5G/S5uwEli4RgMPP4pUoKgd\nGQIDAQAB\n-----END PUBLIC KEY-----\n"
|
|
3166
3176
|
},
|
|
3167
3177
|
"PublicKeyResponse": {
|
|
3168
3178
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3169
|
-
"$id": "https://
|
|
3179
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PublicKeyResponse",
|
|
3170
3180
|
"description": "This object contains the rsa generated public key for the Payment Card Service. This public key must be used\nwhen transmitting encrypted data to Payment Card Service APIs.\n",
|
|
3171
3181
|
"type": "object",
|
|
3172
3182
|
"required": ["publicKey"],
|
|
3173
3183
|
"properties": {
|
|
3174
3184
|
"publicKey": {
|
|
3175
3185
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3176
|
-
"$id": "https://
|
|
3186
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/PublicKey",
|
|
3177
3187
|
"description": "Public key in PEM format",
|
|
3178
3188
|
"type": "string",
|
|
3179
3189
|
"example": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAwm2sxmRdTF7ZIBA6+ngO\n8jOTCHmID0PpQB1q85+hrcLSfB1rWY9bzNNLabBo/ajDnA4Pcadq/x6gpg70qZcR\n9Wxm6TttKzBPZsxasGXgSTDqEi2KcYZgq1mL4qyxUvyIms7/llGy+W9b5huZaVcO\nxdT1tw/zctbOhb6S2t5vH+zkta/2ncUXjG7i8XdLsJ1qe4K1kYbA4KVkOMmAtw7O\n4STk0TZDD0YARdmrciorJjbIVt0Xj1CrYQ5QbDGrlfeXgrcZwX5f9wT2MnKlY5oZ\n5Wtb57oGtLkVf8g6vN/2jGtAmOmHK2hHwNd/+zUet5G/S5uwEli4RgMPP4pUoKgd\nGQIDAQAB\n-----END PUBLIC KEY-----\n"
|
|
@@ -3182,14 +3192,14 @@
|
|
|
3182
3192
|
},
|
|
3183
3193
|
"StateStatus": {
|
|
3184
3194
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3185
|
-
"$id": "https://
|
|
3195
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StateStatus",
|
|
3186
3196
|
"description": "The current state of the card",
|
|
3187
3197
|
"type": "string",
|
|
3188
3198
|
"enum": ["CURRENT", "REISSUED", "RETIRED", "FORCED"]
|
|
3189
3199
|
},
|
|
3190
3200
|
"StorageKeyId": {
|
|
3191
3201
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3192
|
-
"$id": "https://
|
|
3202
|
+
"$id": "https://payment-card.checkdigit/payment-card/v1/schemas/definitions/StorageKeyId",
|
|
3193
3203
|
"type": "string",
|
|
3194
3204
|
"description": "DEK's non-derived identifier to be used by Check Digit services only.\n"
|
|
3195
3205
|
}
|