@checkdigit/eslint-plugin 7.17.1 → 7.18.0-PR.143-8290
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/api-locator.mjs +30 -0
- package/dist-mjs/athena/api-matcher.mjs +108 -0
- package/dist-mjs/athena/athena.mjs +331 -0
- package/dist-mjs/athena/column.mjs +1 -0
- package/dist-mjs/athena/context.mjs +21 -0
- package/dist-mjs/athena/index.mjs +1 -0
- package/dist-mjs/athena/service-table.mjs +32 -0
- package/dist-mjs/athena/types.mjs +1 -0
- package/dist-mjs/athena/visitor.mjs +258 -0
- package/dist-mjs/index.mjs +8 -4
- package/dist-mjs/no-status-code-assert.mjs +1 -1
- package/dist-mjs/openapi/deref-schema.mjs +14 -0
- package/dist-mjs/openapi/generate-schema.mjs +273 -0
- package/dist-mjs/openapi/service-schema-generator.mjs +147 -0
- package/dist-mjs/peggy/athena-peggy.mjs +20629 -0
- package/dist-types/athena/api-locator.d.ts +2 -0
- package/dist-types/athena/api-matcher.d.ts +14 -0
- package/dist-types/athena/athena.d.ts +6 -0
- package/dist-types/athena/column.d.ts +1 -0
- package/dist-types/athena/context.d.ts +21 -0
- package/dist-types/athena/index.d.ts +8 -0
- package/dist-types/athena/service-table.d.ts +8 -0
- package/dist-types/athena/types.d.ts +474 -0
- package/dist-types/athena/visitor.d.ts +63 -0
- package/dist-types/no-status-code-assert.d.ts +1 -1
- package/dist-types/openapi/deref-schema.d.ts +1 -0
- package/dist-types/openapi/generate-schema.d.ts +33 -0
- package/dist-types/openapi/service-schema-generator.d.ts +5 -0
- package/dist-types/peggy/athena-peggy.d.ts +13 -0
- package/package.json +1 -96
- package/src/athena/ATHENA.md +387 -0
- package/src/athena/PLAN.md +355 -0
- package/src/athena/api-locator.ts +39 -0
- package/src/athena/api-matcher.ts +169 -0
- package/src/athena/athena.ts +491 -0
- package/src/athena/column.ts +2 -0
- package/src/athena/context.ts +47 -0
- package/src/athena/index.ts +11 -0
- package/src/athena/service-table.ts +55 -0
- package/src/athena/types.ts +526 -0
- package/src/athena/visitor.ts +365 -0
- package/src/index.ts +4 -0
- package/src/no-side-effects.ts +1 -1
- package/src/no-status-code-assert.ts +2 -2
- package/src/openapi/deref-schema.ts +14 -0
- package/src/openapi/generate-schema.ts +422 -0
- package/src/openapi/service-schema-generator.ts +189 -0
- package/src/peggy/athena-chat.peggy +608 -0
- package/src/peggy/athena-peggy.ts +22078 -0
- package/src/peggy/athena.peggy +2967 -0
- package/src/require-service-call-response-declaration.ts +2 -2
- package/src/services/interchange/v1/swagger.schema.deref.json +849 -0
- package/src/services/interchange/v1/swagger.schema.json +473 -0
- package/src/services/interchange/v1/swagger.yml +414 -0
- package/src/services/ledger/v1/swagger.schema.deref.json +6694 -0
- package/src/services/ledger/v1/swagger.schema.json +1820 -0
- package/src/services/ledger/v1/swagger.yml +1094 -0
- package/src/services/link/v1/swagger.schema.deref.json +648 -0
- package/src/services/link/v1/swagger.schema.json +444 -0
- package/src/services/link/v1/swagger.yml +343 -0
- package/src/services/message/v1/swagger.schema.deref.json +22049 -0
- package/src/services/message/v1/swagger.schema.json +3470 -0
- package/src/services/message/v1/swagger.yml +2798 -0
- package/src/services/message/v2/swagger.schema.deref.json +72221 -0
- package/src/services/message/v2/swagger.schema.json +3558 -0
- package/src/services/message/v2/swagger.yml +3009 -0
- package/src/services/paymentCard/v1/swagger.schema.deref.json +4346 -0
- package/src/services/paymentCard/v1/swagger.schema.json +2181 -0
- package/src/services/paymentCard/v1/swagger.yml +1161 -0
- package/src/services/paymentCard/v2/swagger.schema.deref.json +4336 -0
- package/src/services/paymentCard/v2/swagger.schema.json +2155 -0
- package/src/services/paymentCard/v2/swagger.yml +1149 -0
- package/src/services/person/v1/swagger.schema.deref.json +6786 -0
- package/src/services/person/v1/swagger.schema.json +1445 -0
- package/src/services/person/v1/swagger.yml +1157 -0
- package/src/services/teampayApproval/v1/swagger.schema.deref.json +9898 -0
- package/src/services/teampayCardManagement/v1/swagger.schema.deref.json +6187 -0
- package/src/services/teampayClientManagement/v1/swagger.schema.deref.json +4914 -0
- package/src/services/teampayClientManagement/v1/swagger.schema.json +1964 -0
- package/src/services/teampayClientManagement/v1/swagger.yml +1376 -0
|
@@ -0,0 +1,3558 @@
|
|
|
1
|
+
{
|
|
2
|
+
"apis": {
|
|
3
|
+
"/message/v2/ping": {
|
|
4
|
+
"get": {
|
|
5
|
+
"request": {
|
|
6
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
7
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/PingGetRequestContext",
|
|
8
|
+
"type": "object",
|
|
9
|
+
"properties": {
|
|
10
|
+
"headers": {
|
|
11
|
+
"type": "object",
|
|
12
|
+
"additionalProperties": true
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
"required": [],
|
|
16
|
+
"additionalProperties": false
|
|
17
|
+
},
|
|
18
|
+
"responses": {
|
|
19
|
+
"200": {
|
|
20
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
21
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/PingGetResponseOK",
|
|
22
|
+
"type": "object",
|
|
23
|
+
"properties": {
|
|
24
|
+
"headers": {
|
|
25
|
+
"type": "object",
|
|
26
|
+
"additionalProperties": true
|
|
27
|
+
},
|
|
28
|
+
"body": {
|
|
29
|
+
"$ref": "/message/v2/schemas/definitions/Ping"
|
|
30
|
+
}
|
|
31
|
+
},
|
|
32
|
+
"required": ["body"],
|
|
33
|
+
"additionalProperties": false
|
|
34
|
+
},
|
|
35
|
+
"default": {
|
|
36
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
37
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/PingGetResponseDefault",
|
|
38
|
+
"type": "object",
|
|
39
|
+
"properties": {
|
|
40
|
+
"headers": {
|
|
41
|
+
"type": "object",
|
|
42
|
+
"additionalProperties": true
|
|
43
|
+
},
|
|
44
|
+
"body": {
|
|
45
|
+
"$ref": "/message/v2/schemas/definitions/Error"
|
|
46
|
+
}
|
|
47
|
+
},
|
|
48
|
+
"required": ["body"],
|
|
49
|
+
"additionalProperties": false
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
},
|
|
54
|
+
"/message/v2/request": {
|
|
55
|
+
"get": {
|
|
56
|
+
"request": {
|
|
57
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
58
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestQueryGetRequestContext",
|
|
59
|
+
"type": "object",
|
|
60
|
+
"properties": {
|
|
61
|
+
"params": {
|
|
62
|
+
"type": "object",
|
|
63
|
+
"additionalProperties": false,
|
|
64
|
+
"properties": {
|
|
65
|
+
"cardIds": {
|
|
66
|
+
"type": "array",
|
|
67
|
+
"minItems": 1,
|
|
68
|
+
"items": {
|
|
69
|
+
"$ref": "/message/v2/schemas/definitions/CardId"
|
|
70
|
+
}
|
|
71
|
+
},
|
|
72
|
+
"toDate": {
|
|
73
|
+
"type": "string",
|
|
74
|
+
"format": "date-time"
|
|
75
|
+
},
|
|
76
|
+
"fromDate": {
|
|
77
|
+
"type": "string",
|
|
78
|
+
"format": "date-time"
|
|
79
|
+
}
|
|
80
|
+
},
|
|
81
|
+
"required": ["cardIds", "toDate"]
|
|
82
|
+
},
|
|
83
|
+
"headers": {
|
|
84
|
+
"type": "object",
|
|
85
|
+
"additionalProperties": true
|
|
86
|
+
}
|
|
87
|
+
},
|
|
88
|
+
"required": ["query"],
|
|
89
|
+
"additionalProperties": false
|
|
90
|
+
},
|
|
91
|
+
"responses": {
|
|
92
|
+
"200": {
|
|
93
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
94
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestQueryGetResponseOK",
|
|
95
|
+
"type": "object",
|
|
96
|
+
"properties": {
|
|
97
|
+
"headers": {
|
|
98
|
+
"type": "object",
|
|
99
|
+
"additionalProperties": true
|
|
100
|
+
},
|
|
101
|
+
"body": {
|
|
102
|
+
"$ref": "/message/v2/schemas/definitions/Requests"
|
|
103
|
+
}
|
|
104
|
+
},
|
|
105
|
+
"required": ["body"],
|
|
106
|
+
"additionalProperties": false
|
|
107
|
+
},
|
|
108
|
+
"default": {
|
|
109
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
110
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestQueryGetResponseDefault",
|
|
111
|
+
"type": "object",
|
|
112
|
+
"properties": {
|
|
113
|
+
"headers": {
|
|
114
|
+
"type": "object",
|
|
115
|
+
"additionalProperties": true
|
|
116
|
+
},
|
|
117
|
+
"body": {
|
|
118
|
+
"$ref": "/message/v2/schemas/definitions/Error"
|
|
119
|
+
}
|
|
120
|
+
},
|
|
121
|
+
"required": ["body"],
|
|
122
|
+
"additionalProperties": false
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
},
|
|
127
|
+
"/message/v2/picked-request": {
|
|
128
|
+
"get": {
|
|
129
|
+
"request": {
|
|
130
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
131
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/PickedRequestGetRequestContext",
|
|
132
|
+
"type": "object",
|
|
133
|
+
"properties": {
|
|
134
|
+
"params": {
|
|
135
|
+
"type": "object",
|
|
136
|
+
"additionalProperties": false,
|
|
137
|
+
"properties": {
|
|
138
|
+
"cardIds": {
|
|
139
|
+
"type": "array",
|
|
140
|
+
"minItems": 1,
|
|
141
|
+
"items": {
|
|
142
|
+
"$ref": "/message/v2/schemas/definitions/CardId"
|
|
143
|
+
}
|
|
144
|
+
},
|
|
145
|
+
"toDate": {
|
|
146
|
+
"type": "string",
|
|
147
|
+
"format": "date-time"
|
|
148
|
+
},
|
|
149
|
+
"fromDate": {
|
|
150
|
+
"type": "string",
|
|
151
|
+
"format": "date-time"
|
|
152
|
+
},
|
|
153
|
+
"fields": {
|
|
154
|
+
"type": "array",
|
|
155
|
+
"minItems": 1,
|
|
156
|
+
"items": {
|
|
157
|
+
"$ref": "/message/v2/schemas/definitions/RequestField"
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
},
|
|
161
|
+
"required": ["cardIds", "toDate", "fields"]
|
|
162
|
+
},
|
|
163
|
+
"headers": {
|
|
164
|
+
"type": "object",
|
|
165
|
+
"additionalProperties": true
|
|
166
|
+
}
|
|
167
|
+
},
|
|
168
|
+
"required": ["query"],
|
|
169
|
+
"additionalProperties": false
|
|
170
|
+
},
|
|
171
|
+
"responses": {
|
|
172
|
+
"200": {
|
|
173
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
174
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/PickedRequestGetResponseOK",
|
|
175
|
+
"type": "object",
|
|
176
|
+
"properties": {
|
|
177
|
+
"headers": {
|
|
178
|
+
"type": "object",
|
|
179
|
+
"additionalProperties": true
|
|
180
|
+
},
|
|
181
|
+
"body": {
|
|
182
|
+
"$ref": "/message/v2/schemas/definitions/PickedRequests"
|
|
183
|
+
}
|
|
184
|
+
},
|
|
185
|
+
"required": ["body"],
|
|
186
|
+
"additionalProperties": false
|
|
187
|
+
},
|
|
188
|
+
"default": {
|
|
189
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
190
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/PickedRequestGetResponseDefault",
|
|
191
|
+
"type": "object",
|
|
192
|
+
"properties": {
|
|
193
|
+
"headers": {
|
|
194
|
+
"type": "object",
|
|
195
|
+
"additionalProperties": true
|
|
196
|
+
},
|
|
197
|
+
"body": {
|
|
198
|
+
"$ref": "/message/v2/schemas/definitions/Error"
|
|
199
|
+
}
|
|
200
|
+
},
|
|
201
|
+
"required": ["body"],
|
|
202
|
+
"additionalProperties": false
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
},
|
|
207
|
+
"/message/v2/request/:messageId": {
|
|
208
|
+
"get": {
|
|
209
|
+
"request": {
|
|
210
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
211
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestGetRequestContext",
|
|
212
|
+
"type": "object",
|
|
213
|
+
"properties": {
|
|
214
|
+
"params": {
|
|
215
|
+
"type": "object",
|
|
216
|
+
"additionalProperties": false,
|
|
217
|
+
"properties": {
|
|
218
|
+
"at": {
|
|
219
|
+
"type": "string",
|
|
220
|
+
"format": "date-time"
|
|
221
|
+
}
|
|
222
|
+
},
|
|
223
|
+
"required": ["at"]
|
|
224
|
+
},
|
|
225
|
+
"headers": {
|
|
226
|
+
"type": "object",
|
|
227
|
+
"additionalProperties": true
|
|
228
|
+
}
|
|
229
|
+
},
|
|
230
|
+
"required": ["params", "query"],
|
|
231
|
+
"additionalProperties": false
|
|
232
|
+
},
|
|
233
|
+
"responses": {
|
|
234
|
+
"200": {
|
|
235
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
236
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestGetResponseOK",
|
|
237
|
+
"type": "object",
|
|
238
|
+
"properties": {
|
|
239
|
+
"headers": {
|
|
240
|
+
"type": "object",
|
|
241
|
+
"properties": {
|
|
242
|
+
"created-on": {
|
|
243
|
+
"type": "string",
|
|
244
|
+
"format": "date-time"
|
|
245
|
+
},
|
|
246
|
+
"updated-on": {
|
|
247
|
+
"type": "string",
|
|
248
|
+
"format": "date-time"
|
|
249
|
+
}
|
|
250
|
+
},
|
|
251
|
+
"required": ["created-on", "updated-on"]
|
|
252
|
+
},
|
|
253
|
+
"body": {
|
|
254
|
+
"$ref": "/message/v2/schemas/definitions/Request"
|
|
255
|
+
}
|
|
256
|
+
},
|
|
257
|
+
"required": ["headers", "body"],
|
|
258
|
+
"additionalProperties": false
|
|
259
|
+
},
|
|
260
|
+
"404": {
|
|
261
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
262
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestGetResponseNotFound",
|
|
263
|
+
"type": "object",
|
|
264
|
+
"properties": {
|
|
265
|
+
"headers": {
|
|
266
|
+
"type": "object",
|
|
267
|
+
"additionalProperties": true
|
|
268
|
+
}
|
|
269
|
+
},
|
|
270
|
+
"required": [],
|
|
271
|
+
"additionalProperties": false
|
|
272
|
+
},
|
|
273
|
+
"default": {
|
|
274
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
275
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestGetResponseDefault",
|
|
276
|
+
"type": "object",
|
|
277
|
+
"properties": {
|
|
278
|
+
"headers": {
|
|
279
|
+
"type": "object",
|
|
280
|
+
"additionalProperties": true
|
|
281
|
+
},
|
|
282
|
+
"body": {
|
|
283
|
+
"$ref": "/message/v2/schemas/definitions/Error"
|
|
284
|
+
}
|
|
285
|
+
},
|
|
286
|
+
"required": ["body"],
|
|
287
|
+
"additionalProperties": false
|
|
288
|
+
}
|
|
289
|
+
}
|
|
290
|
+
},
|
|
291
|
+
"put": {
|
|
292
|
+
"request": {
|
|
293
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
294
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestPutRequestContext",
|
|
295
|
+
"type": "object",
|
|
296
|
+
"properties": {
|
|
297
|
+
"params": {
|
|
298
|
+
"type": "object",
|
|
299
|
+
"additionalProperties": false,
|
|
300
|
+
"properties": {
|
|
301
|
+
"messageId": {
|
|
302
|
+
"$ref": "/message/v2/schemas/definitions/MessageId"
|
|
303
|
+
}
|
|
304
|
+
},
|
|
305
|
+
"required": ["messageId"]
|
|
306
|
+
},
|
|
307
|
+
"headers": {
|
|
308
|
+
"type": "object",
|
|
309
|
+
"additionalProperties": true,
|
|
310
|
+
"properties": {
|
|
311
|
+
"created-on": {
|
|
312
|
+
"type": "string",
|
|
313
|
+
"format": "date-time"
|
|
314
|
+
}
|
|
315
|
+
},
|
|
316
|
+
"required": ["Created-On"]
|
|
317
|
+
},
|
|
318
|
+
"body": {
|
|
319
|
+
"$ref": "/message/v2/schemas/definitions/NewRequest"
|
|
320
|
+
}
|
|
321
|
+
},
|
|
322
|
+
"required": ["params", "headers", "body"],
|
|
323
|
+
"additionalProperties": false
|
|
324
|
+
},
|
|
325
|
+
"responses": {
|
|
326
|
+
"204": {
|
|
327
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
328
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestPutResponseNoContent",
|
|
329
|
+
"type": "object",
|
|
330
|
+
"properties": {
|
|
331
|
+
"headers": {
|
|
332
|
+
"type": "object",
|
|
333
|
+
"properties": {
|
|
334
|
+
"created-on": {
|
|
335
|
+
"type": "string",
|
|
336
|
+
"format": "date-time"
|
|
337
|
+
},
|
|
338
|
+
"updated-on": {
|
|
339
|
+
"type": "string",
|
|
340
|
+
"format": "date-time"
|
|
341
|
+
}
|
|
342
|
+
},
|
|
343
|
+
"required": ["created-on", "updated-on"]
|
|
344
|
+
}
|
|
345
|
+
},
|
|
346
|
+
"required": ["headers"],
|
|
347
|
+
"additionalProperties": false
|
|
348
|
+
},
|
|
349
|
+
"409": {
|
|
350
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
351
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestPutResponseConflict",
|
|
352
|
+
"type": "object",
|
|
353
|
+
"properties": {
|
|
354
|
+
"headers": {
|
|
355
|
+
"type": "object",
|
|
356
|
+
"additionalProperties": true
|
|
357
|
+
}
|
|
358
|
+
},
|
|
359
|
+
"required": [],
|
|
360
|
+
"additionalProperties": false
|
|
361
|
+
},
|
|
362
|
+
"default": {
|
|
363
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
364
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/RequestPutResponseDefault",
|
|
365
|
+
"type": "object",
|
|
366
|
+
"properties": {
|
|
367
|
+
"headers": {
|
|
368
|
+
"type": "object",
|
|
369
|
+
"additionalProperties": true
|
|
370
|
+
},
|
|
371
|
+
"body": {
|
|
372
|
+
"$ref": "/message/v2/schemas/definitions/Error"
|
|
373
|
+
}
|
|
374
|
+
},
|
|
375
|
+
"required": ["body"],
|
|
376
|
+
"additionalProperties": false
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
},
|
|
381
|
+
"/message/v2/response": {
|
|
382
|
+
"get": {
|
|
383
|
+
"request": {
|
|
384
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
385
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponseQueryGetRequestContext",
|
|
386
|
+
"type": "object",
|
|
387
|
+
"properties": {
|
|
388
|
+
"params": {
|
|
389
|
+
"type": "object",
|
|
390
|
+
"additionalProperties": false,
|
|
391
|
+
"properties": {
|
|
392
|
+
"cardIds": {
|
|
393
|
+
"type": "array",
|
|
394
|
+
"minItems": 1,
|
|
395
|
+
"items": {
|
|
396
|
+
"$ref": "/message/v2/schemas/definitions/CardId"
|
|
397
|
+
}
|
|
398
|
+
},
|
|
399
|
+
"toDate": {
|
|
400
|
+
"type": "string",
|
|
401
|
+
"format": "date-time"
|
|
402
|
+
},
|
|
403
|
+
"fromDate": {
|
|
404
|
+
"type": "string",
|
|
405
|
+
"format": "date-time"
|
|
406
|
+
}
|
|
407
|
+
},
|
|
408
|
+
"required": ["cardIds", "toDate"]
|
|
409
|
+
},
|
|
410
|
+
"headers": {
|
|
411
|
+
"type": "object",
|
|
412
|
+
"additionalProperties": true
|
|
413
|
+
}
|
|
414
|
+
},
|
|
415
|
+
"required": ["query"],
|
|
416
|
+
"additionalProperties": false
|
|
417
|
+
},
|
|
418
|
+
"responses": {
|
|
419
|
+
"200": {
|
|
420
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
421
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponseQueryGetResponseOK",
|
|
422
|
+
"type": "object",
|
|
423
|
+
"properties": {
|
|
424
|
+
"headers": {
|
|
425
|
+
"type": "object",
|
|
426
|
+
"additionalProperties": true
|
|
427
|
+
},
|
|
428
|
+
"body": {
|
|
429
|
+
"$ref": "/message/v2/schemas/definitions/Responses"
|
|
430
|
+
}
|
|
431
|
+
},
|
|
432
|
+
"required": ["body"],
|
|
433
|
+
"additionalProperties": false
|
|
434
|
+
},
|
|
435
|
+
"default": {
|
|
436
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
437
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponseQueryGetResponseDefault",
|
|
438
|
+
"type": "object",
|
|
439
|
+
"properties": {
|
|
440
|
+
"headers": {
|
|
441
|
+
"type": "object",
|
|
442
|
+
"additionalProperties": true
|
|
443
|
+
},
|
|
444
|
+
"body": {
|
|
445
|
+
"$ref": "/message/v2/schemas/definitions/Error"
|
|
446
|
+
}
|
|
447
|
+
},
|
|
448
|
+
"required": ["body"],
|
|
449
|
+
"additionalProperties": false
|
|
450
|
+
}
|
|
451
|
+
}
|
|
452
|
+
}
|
|
453
|
+
},
|
|
454
|
+
"/message/v2/picked-response": {
|
|
455
|
+
"get": {
|
|
456
|
+
"request": {
|
|
457
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
458
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/PickedResponseGetRequestContext",
|
|
459
|
+
"type": "object",
|
|
460
|
+
"properties": {
|
|
461
|
+
"params": {
|
|
462
|
+
"type": "object",
|
|
463
|
+
"additionalProperties": false,
|
|
464
|
+
"properties": {
|
|
465
|
+
"cardIds": {
|
|
466
|
+
"type": "array",
|
|
467
|
+
"minItems": 1,
|
|
468
|
+
"items": {
|
|
469
|
+
"$ref": "/message/v2/schemas/definitions/CardId"
|
|
470
|
+
}
|
|
471
|
+
},
|
|
472
|
+
"toDate": {
|
|
473
|
+
"type": "string",
|
|
474
|
+
"format": "date-time"
|
|
475
|
+
},
|
|
476
|
+
"fromDate": {
|
|
477
|
+
"type": "string",
|
|
478
|
+
"format": "date-time"
|
|
479
|
+
},
|
|
480
|
+
"fields": {
|
|
481
|
+
"type": "array",
|
|
482
|
+
"minItems": 1,
|
|
483
|
+
"items": {
|
|
484
|
+
"$ref": "/message/v2/schemas/definitions/ResponseField"
|
|
485
|
+
}
|
|
486
|
+
}
|
|
487
|
+
},
|
|
488
|
+
"required": ["cardIds", "toDate", "fields"]
|
|
489
|
+
},
|
|
490
|
+
"headers": {
|
|
491
|
+
"type": "object",
|
|
492
|
+
"additionalProperties": true
|
|
493
|
+
}
|
|
494
|
+
},
|
|
495
|
+
"required": ["query"],
|
|
496
|
+
"additionalProperties": false
|
|
497
|
+
},
|
|
498
|
+
"responses": {
|
|
499
|
+
"200": {
|
|
500
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
501
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/PickedResponseGetResponseOK",
|
|
502
|
+
"type": "object",
|
|
503
|
+
"properties": {
|
|
504
|
+
"headers": {
|
|
505
|
+
"type": "object",
|
|
506
|
+
"additionalProperties": true
|
|
507
|
+
},
|
|
508
|
+
"body": {
|
|
509
|
+
"$ref": "/message/v2/schemas/definitions/PickedResponses"
|
|
510
|
+
}
|
|
511
|
+
},
|
|
512
|
+
"required": ["body"],
|
|
513
|
+
"additionalProperties": false
|
|
514
|
+
},
|
|
515
|
+
"default": {
|
|
516
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
517
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/PickedResponseGetResponseDefault",
|
|
518
|
+
"type": "object",
|
|
519
|
+
"properties": {
|
|
520
|
+
"headers": {
|
|
521
|
+
"type": "object",
|
|
522
|
+
"additionalProperties": true
|
|
523
|
+
},
|
|
524
|
+
"body": {
|
|
525
|
+
"$ref": "/message/v2/schemas/definitions/Error"
|
|
526
|
+
}
|
|
527
|
+
},
|
|
528
|
+
"required": ["body"],
|
|
529
|
+
"additionalProperties": false
|
|
530
|
+
}
|
|
531
|
+
}
|
|
532
|
+
}
|
|
533
|
+
},
|
|
534
|
+
"/message/v2/response/:messageId": {
|
|
535
|
+
"get": {
|
|
536
|
+
"request": {
|
|
537
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
538
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponseGetRequestContext",
|
|
539
|
+
"type": "object",
|
|
540
|
+
"properties": {
|
|
541
|
+
"params": {
|
|
542
|
+
"type": "object",
|
|
543
|
+
"additionalProperties": false,
|
|
544
|
+
"properties": {
|
|
545
|
+
"at": {
|
|
546
|
+
"type": "string",
|
|
547
|
+
"format": "date-time"
|
|
548
|
+
}
|
|
549
|
+
},
|
|
550
|
+
"required": ["at"]
|
|
551
|
+
},
|
|
552
|
+
"headers": {
|
|
553
|
+
"type": "object",
|
|
554
|
+
"additionalProperties": true
|
|
555
|
+
}
|
|
556
|
+
},
|
|
557
|
+
"required": ["params", "query"],
|
|
558
|
+
"additionalProperties": false
|
|
559
|
+
},
|
|
560
|
+
"responses": {
|
|
561
|
+
"200": {
|
|
562
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
563
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponseGetResponseOK",
|
|
564
|
+
"type": "object",
|
|
565
|
+
"properties": {
|
|
566
|
+
"headers": {
|
|
567
|
+
"type": "object",
|
|
568
|
+
"properties": {
|
|
569
|
+
"created-on": {
|
|
570
|
+
"type": "string",
|
|
571
|
+
"format": "date-time"
|
|
572
|
+
},
|
|
573
|
+
"updated-on": {
|
|
574
|
+
"type": "string",
|
|
575
|
+
"format": "date-time"
|
|
576
|
+
}
|
|
577
|
+
},
|
|
578
|
+
"required": ["created-on", "updated-on"]
|
|
579
|
+
},
|
|
580
|
+
"body": {
|
|
581
|
+
"$ref": "/message/v2/schemas/definitions/Response"
|
|
582
|
+
}
|
|
583
|
+
},
|
|
584
|
+
"required": ["headers", "body"],
|
|
585
|
+
"additionalProperties": false
|
|
586
|
+
},
|
|
587
|
+
"404": {
|
|
588
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
589
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponseGetResponseNotFound",
|
|
590
|
+
"type": "object",
|
|
591
|
+
"properties": {
|
|
592
|
+
"headers": {
|
|
593
|
+
"type": "object",
|
|
594
|
+
"additionalProperties": true
|
|
595
|
+
}
|
|
596
|
+
},
|
|
597
|
+
"required": [],
|
|
598
|
+
"additionalProperties": false
|
|
599
|
+
},
|
|
600
|
+
"default": {
|
|
601
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
602
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponseGetResponseDefault",
|
|
603
|
+
"type": "object",
|
|
604
|
+
"properties": {
|
|
605
|
+
"headers": {
|
|
606
|
+
"type": "object",
|
|
607
|
+
"additionalProperties": true
|
|
608
|
+
},
|
|
609
|
+
"body": {
|
|
610
|
+
"$ref": "/message/v2/schemas/definitions/Error"
|
|
611
|
+
}
|
|
612
|
+
},
|
|
613
|
+
"required": ["body"],
|
|
614
|
+
"additionalProperties": false
|
|
615
|
+
}
|
|
616
|
+
}
|
|
617
|
+
},
|
|
618
|
+
"put": {
|
|
619
|
+
"request": {
|
|
620
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
621
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponsePutRequestContext",
|
|
622
|
+
"type": "object",
|
|
623
|
+
"properties": {
|
|
624
|
+
"params": {
|
|
625
|
+
"type": "object",
|
|
626
|
+
"additionalProperties": false,
|
|
627
|
+
"properties": {
|
|
628
|
+
"messageId": {
|
|
629
|
+
"$ref": "/message/v2/schemas/definitions/MessageId"
|
|
630
|
+
}
|
|
631
|
+
},
|
|
632
|
+
"required": ["messageId"]
|
|
633
|
+
},
|
|
634
|
+
"headers": {
|
|
635
|
+
"type": "object",
|
|
636
|
+
"additionalProperties": true,
|
|
637
|
+
"properties": {
|
|
638
|
+
"created-on": {
|
|
639
|
+
"type": "string",
|
|
640
|
+
"format": "date-time"
|
|
641
|
+
}
|
|
642
|
+
},
|
|
643
|
+
"required": ["Created-On"]
|
|
644
|
+
},
|
|
645
|
+
"body": {
|
|
646
|
+
"$ref": "/message/v2/schemas/definitions/NewResponse"
|
|
647
|
+
}
|
|
648
|
+
},
|
|
649
|
+
"required": ["params", "headers", "body"],
|
|
650
|
+
"additionalProperties": false
|
|
651
|
+
},
|
|
652
|
+
"responses": {
|
|
653
|
+
"204": {
|
|
654
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
655
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponsePutResponseNoContent",
|
|
656
|
+
"type": "object",
|
|
657
|
+
"properties": {
|
|
658
|
+
"headers": {
|
|
659
|
+
"type": "object",
|
|
660
|
+
"properties": {
|
|
661
|
+
"created-on": {
|
|
662
|
+
"type": "string",
|
|
663
|
+
"format": "date-time"
|
|
664
|
+
},
|
|
665
|
+
"updated-on": {
|
|
666
|
+
"type": "string",
|
|
667
|
+
"format": "date-time"
|
|
668
|
+
}
|
|
669
|
+
},
|
|
670
|
+
"required": ["created-on", "updated-on"]
|
|
671
|
+
}
|
|
672
|
+
},
|
|
673
|
+
"required": ["headers"],
|
|
674
|
+
"additionalProperties": false
|
|
675
|
+
},
|
|
676
|
+
"409": {
|
|
677
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
678
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponsePutResponseConflict",
|
|
679
|
+
"type": "object",
|
|
680
|
+
"properties": {
|
|
681
|
+
"headers": {
|
|
682
|
+
"type": "object",
|
|
683
|
+
"additionalProperties": true
|
|
684
|
+
}
|
|
685
|
+
},
|
|
686
|
+
"required": [],
|
|
687
|
+
"additionalProperties": false
|
|
688
|
+
},
|
|
689
|
+
"default": {
|
|
690
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
691
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/api/ResponsePutResponseDefault",
|
|
692
|
+
"type": "object",
|
|
693
|
+
"properties": {
|
|
694
|
+
"headers": {
|
|
695
|
+
"type": "object",
|
|
696
|
+
"additionalProperties": true
|
|
697
|
+
},
|
|
698
|
+
"body": {
|
|
699
|
+
"$ref": "/message/v2/schemas/definitions/Error"
|
|
700
|
+
}
|
|
701
|
+
},
|
|
702
|
+
"required": ["body"],
|
|
703
|
+
"additionalProperties": false
|
|
704
|
+
}
|
|
705
|
+
}
|
|
706
|
+
}
|
|
707
|
+
}
|
|
708
|
+
},
|
|
709
|
+
"definitions": {
|
|
710
|
+
"Ping": {
|
|
711
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
712
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Ping",
|
|
713
|
+
"type": "object",
|
|
714
|
+
"description": "The current server time.",
|
|
715
|
+
"additionalProperties": false,
|
|
716
|
+
"required": ["serverTime"],
|
|
717
|
+
"properties": {
|
|
718
|
+
"serverTime": {
|
|
719
|
+
"type": "string",
|
|
720
|
+
"format": "date-time"
|
|
721
|
+
}
|
|
722
|
+
}
|
|
723
|
+
},
|
|
724
|
+
"Responses": {
|
|
725
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
726
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Responses",
|
|
727
|
+
"type": "object",
|
|
728
|
+
"additionalProperties": false,
|
|
729
|
+
"description": "An object containing a list of Response objects.\n",
|
|
730
|
+
"required": ["messages"],
|
|
731
|
+
"properties": {
|
|
732
|
+
"messages": {
|
|
733
|
+
"type": "array",
|
|
734
|
+
"items": {
|
|
735
|
+
"$ref": "/message/v2/schemas/definitions/Response"
|
|
736
|
+
}
|
|
737
|
+
}
|
|
738
|
+
}
|
|
739
|
+
},
|
|
740
|
+
"Requests": {
|
|
741
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
742
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Requests",
|
|
743
|
+
"type": "object",
|
|
744
|
+
"additionalProperties": false,
|
|
745
|
+
"description": "An object containing a list of Request objects.\n",
|
|
746
|
+
"required": ["messages"],
|
|
747
|
+
"properties": {
|
|
748
|
+
"messages": {
|
|
749
|
+
"type": "array",
|
|
750
|
+
"items": {
|
|
751
|
+
"$ref": "/message/v2/schemas/definitions/Request"
|
|
752
|
+
}
|
|
753
|
+
}
|
|
754
|
+
}
|
|
755
|
+
},
|
|
756
|
+
"PickedRequests": {
|
|
757
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
758
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/PickedRequests",
|
|
759
|
+
"type": "object",
|
|
760
|
+
"additionalProperties": false,
|
|
761
|
+
"description": "An object containing a list of PickedRequest objects.\n",
|
|
762
|
+
"required": ["pickedMessages"],
|
|
763
|
+
"properties": {
|
|
764
|
+
"pickedMessages": {
|
|
765
|
+
"type": "array",
|
|
766
|
+
"items": {
|
|
767
|
+
"$ref": "/message/v2/schemas/definitions/PickedRequest"
|
|
768
|
+
}
|
|
769
|
+
}
|
|
770
|
+
}
|
|
771
|
+
},
|
|
772
|
+
"PickedResponses": {
|
|
773
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
774
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/PickedResponses",
|
|
775
|
+
"type": "object",
|
|
776
|
+
"additionalProperties": false,
|
|
777
|
+
"description": "An object containing a list of PickedResponse objects.\n",
|
|
778
|
+
"required": ["pickedMessages"],
|
|
779
|
+
"properties": {
|
|
780
|
+
"pickedMessages": {
|
|
781
|
+
"type": "array",
|
|
782
|
+
"items": {
|
|
783
|
+
"$ref": "/message/v2/schemas/definitions/PickedResponse"
|
|
784
|
+
}
|
|
785
|
+
}
|
|
786
|
+
}
|
|
787
|
+
},
|
|
788
|
+
"Error": {
|
|
789
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
790
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Error",
|
|
791
|
+
"type": "object",
|
|
792
|
+
"additionalProperties": false,
|
|
793
|
+
"description": "An object containing an error message.\n",
|
|
794
|
+
"required": ["message"],
|
|
795
|
+
"properties": {
|
|
796
|
+
"message": {
|
|
797
|
+
"type": "string"
|
|
798
|
+
},
|
|
799
|
+
"code": {
|
|
800
|
+
"type": "string"
|
|
801
|
+
}
|
|
802
|
+
}
|
|
803
|
+
},
|
|
804
|
+
"Amount": {
|
|
805
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
806
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Amount",
|
|
807
|
+
"type": "object",
|
|
808
|
+
"additionalProperties": false,
|
|
809
|
+
"description": "An amount of money in the smallest monetary unit of the specified currency.\n",
|
|
810
|
+
"required": ["amount", "currency"],
|
|
811
|
+
"properties": {
|
|
812
|
+
"amount": {
|
|
813
|
+
"type": "string",
|
|
814
|
+
"pattern": "^[0-9]+$",
|
|
815
|
+
"description": "The amount of money in the smallest monetary unit of the specified currency."
|
|
816
|
+
},
|
|
817
|
+
"currency": {
|
|
818
|
+
"$ref": "/message/v2/schemas/definitions/CurrencyAlphabeticCode"
|
|
819
|
+
}
|
|
820
|
+
}
|
|
821
|
+
},
|
|
822
|
+
"SettlementConversion": {
|
|
823
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
824
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/SettlementConversion",
|
|
825
|
+
"type": "object",
|
|
826
|
+
"description": "The rate sent by the network used to convert the transaction amount to the settlement amount.\n\nOnly present if the transaction currency differs from the settlement currency.\n\nTo calculate the conversion rate, use the following formula:\n\n conversion rate = factor / (10 ^ factorDecimalPosition)\n",
|
|
827
|
+
"required": ["date", "factor", "factorDecimalPosition"],
|
|
828
|
+
"properties": {
|
|
829
|
+
"date": {
|
|
830
|
+
"description": "The year, month, and day the conversion rate was determined.\n",
|
|
831
|
+
"type": "string",
|
|
832
|
+
"format": "date"
|
|
833
|
+
},
|
|
834
|
+
"factor": {
|
|
835
|
+
"description": "The multiplying factor used to convert the transaction amount to the settlement\namount.\n",
|
|
836
|
+
"type": "string"
|
|
837
|
+
},
|
|
838
|
+
"factorDecimalPosition": {
|
|
839
|
+
"description": "The position the decimal point should be placed, starting from the right.\n",
|
|
840
|
+
"type": "number"
|
|
841
|
+
}
|
|
842
|
+
}
|
|
843
|
+
},
|
|
844
|
+
"MessageType": {
|
|
845
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
846
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/MessageType",
|
|
847
|
+
"type": "string",
|
|
848
|
+
"description": "The type of message received from the network.\n",
|
|
849
|
+
"enum": ["PREAUTHORIZATION", "FINANCIAL", "ADMINISTRATIVE", "REVERSAL"]
|
|
850
|
+
},
|
|
851
|
+
"MessageUsage": {
|
|
852
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
853
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/MessageUsage",
|
|
854
|
+
"type": "string",
|
|
855
|
+
"description": "The expected use of the message received from the network. \n\nA REQUEST is a message that can be declined, while and ADVICE cannot. RESPONSE and ADVICE RESPONSE are the \nresponses to REQUEST and ADVICE messages, respectively.\n",
|
|
856
|
+
"enum": ["REQUEST", "RESPONSE", "ADVICE", "ADVICE RESPONSE"]
|
|
857
|
+
},
|
|
858
|
+
"Category": {
|
|
859
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
860
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Category",
|
|
861
|
+
"type": "string",
|
|
862
|
+
"description": "The category of message received from the network.",
|
|
863
|
+
"enum": [
|
|
864
|
+
"GOODS AND SERVICE",
|
|
865
|
+
"QUASICASH",
|
|
866
|
+
"SCRIP",
|
|
867
|
+
"ATM",
|
|
868
|
+
"OTC",
|
|
869
|
+
"AFD",
|
|
870
|
+
"BALANCE INQUIRY",
|
|
871
|
+
"ACCOUNT INQUIRY",
|
|
872
|
+
"FUNDS TRANSFER",
|
|
873
|
+
"BILL PAYMENT",
|
|
874
|
+
"ADJUSTMENT",
|
|
875
|
+
"RETURN",
|
|
876
|
+
"LOAD",
|
|
877
|
+
"UNLOAD",
|
|
878
|
+
"ACTIVATION",
|
|
879
|
+
"ACTIVATION AND LOAD",
|
|
880
|
+
"DEACTIVATION",
|
|
881
|
+
"DEACTIVATION AND UNLOAD",
|
|
882
|
+
"TOKENIZATION",
|
|
883
|
+
"REQUEST ACTIVATION METHODS",
|
|
884
|
+
"DELIVER ACTIVATION CODE",
|
|
885
|
+
"NOTIFY TOKEN ACTIVATED",
|
|
886
|
+
"NOTIFY TOKEN UPDATED",
|
|
887
|
+
"NOTIFY SUSPICIOUS EVENTS",
|
|
888
|
+
"UNSUPPORTED"
|
|
889
|
+
]
|
|
890
|
+
},
|
|
891
|
+
"DebitCreditNeither": {
|
|
892
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
893
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/DebitCreditNeither",
|
|
894
|
+
"type": "string",
|
|
895
|
+
"description": "The Request object's intended effect on the account balance.\n\nFor example, Balance Inquiries with no fees have no effect on the balance.\n",
|
|
896
|
+
"enum": ["DEBIT", "CREDIT", "NEITHER"]
|
|
897
|
+
},
|
|
898
|
+
"DebitCredit": {
|
|
899
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
900
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/DebitCredit",
|
|
901
|
+
"type": "string",
|
|
902
|
+
"enum": ["DEBIT", "CREDIT"]
|
|
903
|
+
},
|
|
904
|
+
"Categorization": {
|
|
905
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
906
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Categorization",
|
|
907
|
+
"type": "object",
|
|
908
|
+
"additionalProperties": false,
|
|
909
|
+
"description": "The categorization of the message received from the network.\n",
|
|
910
|
+
"required": ["messageType", "messageUsage", "category", "debitCredit"],
|
|
911
|
+
"properties": {
|
|
912
|
+
"messageType": {
|
|
913
|
+
"$ref": "/message/v2/schemas/definitions/MessageType"
|
|
914
|
+
},
|
|
915
|
+
"messageUsage": {
|
|
916
|
+
"$ref": "/message/v2/schemas/definitions/MessageUsage"
|
|
917
|
+
},
|
|
918
|
+
"category": {
|
|
919
|
+
"$ref": "/message/v2/schemas/definitions/Category"
|
|
920
|
+
},
|
|
921
|
+
"debitCredit": {
|
|
922
|
+
"$ref": "/message/v2/schemas/definitions/DebitCreditNeither"
|
|
923
|
+
}
|
|
924
|
+
}
|
|
925
|
+
},
|
|
926
|
+
"AccountType": {
|
|
927
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
928
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/AccountType",
|
|
929
|
+
"type": "string",
|
|
930
|
+
"enum": ["NOT PROVIDED", "UNSPECIFIED", "SAVINGS", "CHECKING", "CREDIT", "INVESTMENT", "UNIVERSAL", "OTHER"]
|
|
931
|
+
},
|
|
932
|
+
"Accounts": {
|
|
933
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
934
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Accounts",
|
|
935
|
+
"type": "object",
|
|
936
|
+
"description": "Used when transferring funds between accounts. \n\nFor example, messages from ATMs that support multiple accounts may utilize this object.\n",
|
|
937
|
+
"additionalProperties": false,
|
|
938
|
+
"required": ["from", "to"],
|
|
939
|
+
"properties": {
|
|
940
|
+
"from": {
|
|
941
|
+
"$ref": "/message/v2/schemas/definitions/AccountType"
|
|
942
|
+
},
|
|
943
|
+
"to": {
|
|
944
|
+
"$ref": "/message/v2/schemas/definitions/AccountType"
|
|
945
|
+
}
|
|
946
|
+
}
|
|
947
|
+
},
|
|
948
|
+
"PinCapabilities": {
|
|
949
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
950
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/PinCapabilities",
|
|
951
|
+
"type": "string",
|
|
952
|
+
"description": "The terminal's ability to accept a PIN.\n",
|
|
953
|
+
"enum": [
|
|
954
|
+
"NOT PROVIDED",
|
|
955
|
+
"UNSPECIFIED",
|
|
956
|
+
"PIN ENTRY CAPABILITY",
|
|
957
|
+
"NO PIN ENTRY CAPABILITY",
|
|
958
|
+
"PIN PAD INOPERATIVE",
|
|
959
|
+
"PIN ENTRY CAPABILITY BUT OUT OF SERVICE",
|
|
960
|
+
"PIN VERIFIED BY TERMINAL DEVICE"
|
|
961
|
+
]
|
|
962
|
+
},
|
|
963
|
+
"PanEntryMethod": {
|
|
964
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
965
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/PanEntryMethod",
|
|
966
|
+
"type": "string",
|
|
967
|
+
"description": "The method used to enter the PAN.\n",
|
|
968
|
+
"enum": [
|
|
969
|
+
"NOT PROVIDED",
|
|
970
|
+
"UNSPECIFIED",
|
|
971
|
+
"MANUAL",
|
|
972
|
+
"MAGNETIC STRIPE",
|
|
973
|
+
"BAR CODE",
|
|
974
|
+
"OCR",
|
|
975
|
+
"INTEGRATED CIRCUIT CARD",
|
|
976
|
+
"MANUAL KEY ENTERED",
|
|
977
|
+
"CONTACTLESS EMV RULES",
|
|
978
|
+
"CHIP CARD UNABLE MANUAL ENTRY",
|
|
979
|
+
"CHIP CARD UNABLE MAGNETIC STRIPE",
|
|
980
|
+
"ELECTRONIC COMMERCE",
|
|
981
|
+
"PAN AUTO ENTRY VIA SERVER",
|
|
982
|
+
"FULL MAGNETIC STRIPE",
|
|
983
|
+
"CONTACTLESS MAG STRIPE RULES",
|
|
984
|
+
"INTEGRATED CIRCUIT CARD CVV UNRELIABLE",
|
|
985
|
+
"STORED VALUE PREREGISTERED CHECKOUT",
|
|
986
|
+
"ON FILE",
|
|
987
|
+
"SECURE ENTRY"
|
|
988
|
+
]
|
|
989
|
+
},
|
|
990
|
+
"TerminalType": {
|
|
991
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
992
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/TerminalType",
|
|
993
|
+
"type": "string",
|
|
994
|
+
"description": "The type of terminal used to initiate the transaction.\n",
|
|
995
|
+
"enum": [
|
|
996
|
+
"POINT OF SALE TERMINAL",
|
|
997
|
+
"ATM",
|
|
998
|
+
"HOME TERMINAL",
|
|
999
|
+
"ELECTRONIC CASH REGISTER",
|
|
1000
|
+
"DIAL TERMINAL",
|
|
1001
|
+
"TRAVELERS CHECK MACHINE",
|
|
1002
|
+
"AUTOMATED FUEL DEVICE",
|
|
1003
|
+
"SCRIP MACHINE",
|
|
1004
|
+
"COUPON MACHINE",
|
|
1005
|
+
"TICKET MACHINE",
|
|
1006
|
+
"POINT OF BANKING TERMINAL",
|
|
1007
|
+
"TELLER",
|
|
1008
|
+
"FRANCHISE TELLER",
|
|
1009
|
+
"PERSONAL BANKING",
|
|
1010
|
+
"PUBLIC UTILITY",
|
|
1011
|
+
"VENDING",
|
|
1012
|
+
"SELF SERVICE",
|
|
1013
|
+
"AUTHORIZATION",
|
|
1014
|
+
"PAYMENT",
|
|
1015
|
+
"VRU",
|
|
1016
|
+
"SMART PHONE",
|
|
1017
|
+
"INTERACTIVE TELEVISION",
|
|
1018
|
+
"PERSONAL DIGITAL ASSISTANT",
|
|
1019
|
+
"SCREEN PHONE",
|
|
1020
|
+
"ELECTRONIC COMMERCE",
|
|
1021
|
+
"MICR TERMINAL AT POINT OF SALE",
|
|
1022
|
+
"NOT PROVIDED"
|
|
1023
|
+
]
|
|
1024
|
+
},
|
|
1025
|
+
"CardholderPresence": {
|
|
1026
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1027
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/CardholderPresence",
|
|
1028
|
+
"type": "string",
|
|
1029
|
+
"description": "The presence of the cardholder during the transaction.\n",
|
|
1030
|
+
"enum": ["CUSTOMER PRESENT", "CUSTOMER NOT PRESENT", "NOT PROVIDED"]
|
|
1031
|
+
},
|
|
1032
|
+
"CardPresence": {
|
|
1033
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1034
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/CardPresence",
|
|
1035
|
+
"type": "string",
|
|
1036
|
+
"description": "The presence of the card during the transaction.\n",
|
|
1037
|
+
"enum": ["CARD PRESENT", "CARD NOT PRESENT", "NOT PROVIDED"]
|
|
1038
|
+
},
|
|
1039
|
+
"Merchant": {
|
|
1040
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1041
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Merchant",
|
|
1042
|
+
"type": "object",
|
|
1043
|
+
"description": "Information about the merchant and terminal where the transaction took place.\n",
|
|
1044
|
+
"additionalProperties": false,
|
|
1045
|
+
"required": [
|
|
1046
|
+
"type",
|
|
1047
|
+
"name",
|
|
1048
|
+
"terminalTransactionDateTime",
|
|
1049
|
+
"terminalSequenceNumber",
|
|
1050
|
+
"terminalIdentification",
|
|
1051
|
+
"identificationCode",
|
|
1052
|
+
"address",
|
|
1053
|
+
"city",
|
|
1054
|
+
"stateProvince",
|
|
1055
|
+
"country",
|
|
1056
|
+
"allowsPartialApproval",
|
|
1057
|
+
"panEntryMethod",
|
|
1058
|
+
"pinCapabilities",
|
|
1059
|
+
"cardholderPresence",
|
|
1060
|
+
"cardPresence",
|
|
1061
|
+
"terminalType",
|
|
1062
|
+
"terminalOperation",
|
|
1063
|
+
"terminalLocation",
|
|
1064
|
+
"cardRetentionCapability",
|
|
1065
|
+
"transactionStatus",
|
|
1066
|
+
"securityCondition"
|
|
1067
|
+
],
|
|
1068
|
+
"properties": {
|
|
1069
|
+
"type": {
|
|
1070
|
+
"type": "string",
|
|
1071
|
+
"description": "The Merchant Category Code (MCC) - a four digit number identifying the kind of merchant \ninvolved in the transaction, e.g. grocery store, airline, hotel.\n"
|
|
1072
|
+
},
|
|
1073
|
+
"name": {
|
|
1074
|
+
"type": "string",
|
|
1075
|
+
"description": "The name of the merchant or business."
|
|
1076
|
+
},
|
|
1077
|
+
"terminalTransactionDateTime": {
|
|
1078
|
+
"type": "string",
|
|
1079
|
+
"description": "The UTC datetime of the transaction according to the terminal's clock.",
|
|
1080
|
+
"format": "date-time"
|
|
1081
|
+
},
|
|
1082
|
+
"terminalSequenceNumber": {
|
|
1083
|
+
"type": "number",
|
|
1084
|
+
"description": "A counter or identifier used by the terminal to track the transactions it processes."
|
|
1085
|
+
},
|
|
1086
|
+
"terminalIdentification": {
|
|
1087
|
+
"type": "string",
|
|
1088
|
+
"description": "Identifier for a terminal at the card acceptor's location."
|
|
1089
|
+
},
|
|
1090
|
+
"identificationCode": {
|
|
1091
|
+
"type": "string",
|
|
1092
|
+
"description": "Identifier for the specific merchant accepting payment."
|
|
1093
|
+
},
|
|
1094
|
+
"address": {
|
|
1095
|
+
"type": "string",
|
|
1096
|
+
"description": "The merchant's street address."
|
|
1097
|
+
},
|
|
1098
|
+
"city": {
|
|
1099
|
+
"type": "string",
|
|
1100
|
+
"description": "The merchant's city address."
|
|
1101
|
+
},
|
|
1102
|
+
"stateProvince": {
|
|
1103
|
+
"type": "string",
|
|
1104
|
+
"description": "The merchant's state or province address."
|
|
1105
|
+
},
|
|
1106
|
+
"county": {
|
|
1107
|
+
"type": "string",
|
|
1108
|
+
"description": "The merchant's county address."
|
|
1109
|
+
},
|
|
1110
|
+
"postalCode": {
|
|
1111
|
+
"type": "string",
|
|
1112
|
+
"description": "The merchant's postal code."
|
|
1113
|
+
},
|
|
1114
|
+
"country": {
|
|
1115
|
+
"type": "string",
|
|
1116
|
+
"description": "The merchant's country."
|
|
1117
|
+
},
|
|
1118
|
+
"allowsPartialApproval": {
|
|
1119
|
+
"type": "boolean",
|
|
1120
|
+
"description": "Has the value 'true' if the merchant accepts partial approvals. Otherwise, the value is 'false'.\n"
|
|
1121
|
+
},
|
|
1122
|
+
"panEntryMethod": {
|
|
1123
|
+
"$ref": "/message/v2/schemas/definitions/PanEntryMethod"
|
|
1124
|
+
},
|
|
1125
|
+
"pinCapabilities": {
|
|
1126
|
+
"$ref": "/message/v2/schemas/definitions/PinCapabilities"
|
|
1127
|
+
},
|
|
1128
|
+
"cardholderPresence": {
|
|
1129
|
+
"$ref": "/message/v2/schemas/definitions/CardholderPresence"
|
|
1130
|
+
},
|
|
1131
|
+
"cardPresence": {
|
|
1132
|
+
"$ref": "/message/v2/schemas/definitions/CardPresence"
|
|
1133
|
+
},
|
|
1134
|
+
"terminalType": {
|
|
1135
|
+
"$ref": "/message/v2/schemas/definitions/TerminalType"
|
|
1136
|
+
},
|
|
1137
|
+
"terminalOperation": {
|
|
1138
|
+
"type": "string",
|
|
1139
|
+
"description": "The entity operating the terminal.\n",
|
|
1140
|
+
"enum": ["CUSTOMER", "CARD ACCEPTOR", "ADMINISTRATIVE", "UNKNOWN", "NOT PROVIDED"]
|
|
1141
|
+
},
|
|
1142
|
+
"terminalLocation": {
|
|
1143
|
+
"type": "string",
|
|
1144
|
+
"description": "The location of the terminal.\n",
|
|
1145
|
+
"enum": ["ON PREMISE", "OFF PREMISE", "UNKNOWN", "NOT PROVIDED"]
|
|
1146
|
+
},
|
|
1147
|
+
"cardRetentionCapability": {
|
|
1148
|
+
"type": "string",
|
|
1149
|
+
"description": "The terminal's ability to retain the card.\n",
|
|
1150
|
+
"enum": ["ABLE TO RETAIN CARD", "UNABLE TO RETAIN CARD", "UNKNOWN", "NOT PROVIDED"]
|
|
1151
|
+
},
|
|
1152
|
+
"transactionStatus": {
|
|
1153
|
+
"type": "string",
|
|
1154
|
+
"description": "The status of the transaction.\n",
|
|
1155
|
+
"enum": [
|
|
1156
|
+
"ORIGINAL PRESENTMENT",
|
|
1157
|
+
"FIRST PRESENTMENT",
|
|
1158
|
+
"SECOND PRESENTMENT",
|
|
1159
|
+
"THIRD PRESENTMENT",
|
|
1160
|
+
"PREVIOUSLY AUTHORIZED OR DEFERRED AUTHORIZATION",
|
|
1161
|
+
"RESUBMISSION",
|
|
1162
|
+
"CARD VALIDATION OR ACCOUNT STATUS INQUIRY",
|
|
1163
|
+
"UNKNOWN",
|
|
1164
|
+
"NOT PROVIDED"
|
|
1165
|
+
]
|
|
1166
|
+
},
|
|
1167
|
+
"securityCondition": {
|
|
1168
|
+
"type": "string",
|
|
1169
|
+
"description": "The security condition of the transaction.\n",
|
|
1170
|
+
"enum": [
|
|
1171
|
+
"NO CONCERN",
|
|
1172
|
+
"SUSPECTED FRAUD",
|
|
1173
|
+
"IDENTIFICATION VERIFIED",
|
|
1174
|
+
"ECOMMERCE WITH DIGITAL SIGNATURE",
|
|
1175
|
+
"ECOMMERCE",
|
|
1176
|
+
"SECURE ELECTRONIC TRANSACTION WITH CARDHOLDER CERTIFICATE",
|
|
1177
|
+
"SECURE ELECTRONIC TRANSACTION WITHOUT CARDHOLDER CERTIFICATE",
|
|
1178
|
+
"ECOMMERCE WITH CHANNEL ENCRYPTED",
|
|
1179
|
+
"INTERNET PINNED DEBIT TRANSACTION",
|
|
1180
|
+
"SECURE REMOTE COMMERCE DISCOVER CLICK TO PAY",
|
|
1181
|
+
"UNKNOWN",
|
|
1182
|
+
"NOT PROVIDED"
|
|
1183
|
+
]
|
|
1184
|
+
}
|
|
1185
|
+
}
|
|
1186
|
+
},
|
|
1187
|
+
"Acquirer": {
|
|
1188
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1189
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Acquirer",
|
|
1190
|
+
"type": "object",
|
|
1191
|
+
"additionalProperties": false,
|
|
1192
|
+
"description": "Information about the acquirer involved in the transaction.\n",
|
|
1193
|
+
"required": ["identificationCode", "country"],
|
|
1194
|
+
"properties": {
|
|
1195
|
+
"identificationCode": {
|
|
1196
|
+
"type": "string",
|
|
1197
|
+
"description": "Uniquely identifies the acquirer.\n"
|
|
1198
|
+
},
|
|
1199
|
+
"clearingIdentificationCode": {
|
|
1200
|
+
"description": "Unvalidated data that may help identify the acquirer. It's optionally included by the acquirer in clearing messages.\n",
|
|
1201
|
+
"type": "string"
|
|
1202
|
+
},
|
|
1203
|
+
"country": {
|
|
1204
|
+
"type": "string",
|
|
1205
|
+
"description": "The country in which the acquirer is located.\n"
|
|
1206
|
+
}
|
|
1207
|
+
}
|
|
1208
|
+
},
|
|
1209
|
+
"LifeCycleIndicator": {
|
|
1210
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1211
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/LifeCycleIndicator",
|
|
1212
|
+
"type": "string",
|
|
1213
|
+
"description": "The type of time interval in effect for the message.\n",
|
|
1214
|
+
"enum": ["CALENDAR DAY", "HOURS", "MINUTES"]
|
|
1215
|
+
},
|
|
1216
|
+
"AuthorizationLifeCycle": {
|
|
1217
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1218
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/AuthorizationLifeCycle",
|
|
1219
|
+
"type": "object",
|
|
1220
|
+
"additionalProperties": false,
|
|
1221
|
+
"description": "The length of time the acquirer is requesting the issuer to hold the funds.\n",
|
|
1222
|
+
"required": ["lifeCycleIndicator", "actualInterval"],
|
|
1223
|
+
"properties": {
|
|
1224
|
+
"lifeCycleIndicator": {
|
|
1225
|
+
"$ref": "/message/v2/schemas/definitions/LifeCycleIndicator"
|
|
1226
|
+
},
|
|
1227
|
+
"actualInterval": {
|
|
1228
|
+
"type": "number",
|
|
1229
|
+
"description": "The number of time intervals in effect for the message.\n"
|
|
1230
|
+
}
|
|
1231
|
+
}
|
|
1232
|
+
},
|
|
1233
|
+
"ReplacementAmounts": {
|
|
1234
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1235
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ReplacementAmounts",
|
|
1236
|
+
"type": "object",
|
|
1237
|
+
"additionalProperties": false,
|
|
1238
|
+
"description": "The actual transaction, settlement, and fee amounts when they differ from the original\napproved amounts.\n",
|
|
1239
|
+
"required": [
|
|
1240
|
+
"transactionAmount",
|
|
1241
|
+
"transactionFeeAmount",
|
|
1242
|
+
"settlementAmount",
|
|
1243
|
+
"settlementFeeAmount",
|
|
1244
|
+
"feeDetails"
|
|
1245
|
+
],
|
|
1246
|
+
"properties": {
|
|
1247
|
+
"transactionAmount": {
|
|
1248
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
1249
|
+
},
|
|
1250
|
+
"transactionFeeAmount": {
|
|
1251
|
+
"description": "The fee amount applied by the network or acquirer in the merchant's currency.\n",
|
|
1252
|
+
"allOf": [
|
|
1253
|
+
{
|
|
1254
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
1255
|
+
}
|
|
1256
|
+
]
|
|
1257
|
+
},
|
|
1258
|
+
"settlementAmount": {
|
|
1259
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
1260
|
+
},
|
|
1261
|
+
"settlementFeeAmount": {
|
|
1262
|
+
"description": "The fee amount applied by the network or acquirer in the BIN currency.\n",
|
|
1263
|
+
"allOf": [
|
|
1264
|
+
{
|
|
1265
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
1266
|
+
}
|
|
1267
|
+
]
|
|
1268
|
+
},
|
|
1269
|
+
"feeDetails": {
|
|
1270
|
+
"type": "array",
|
|
1271
|
+
"description": "Details about the transaction and settlement fee amounts.\n",
|
|
1272
|
+
"items": {
|
|
1273
|
+
"$ref": "/message/v2/schemas/definitions/Fee"
|
|
1274
|
+
}
|
|
1275
|
+
}
|
|
1276
|
+
}
|
|
1277
|
+
},
|
|
1278
|
+
"EncryptedKey": {
|
|
1279
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1280
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/EncryptedKey",
|
|
1281
|
+
"type": "object",
|
|
1282
|
+
"additionalProperties": false,
|
|
1283
|
+
"description": "An encrypted data encryption key paired with a hashed version of the public key used to encrypt.\n",
|
|
1284
|
+
"required": ["publicKeyHash", "encryptedDataEncryptionKey"],
|
|
1285
|
+
"properties": {
|
|
1286
|
+
"publicKeyHash": {
|
|
1287
|
+
"description": "The public key used to encrypt the encryptedDataEncryptionKey hashed using checkdigit/hash.",
|
|
1288
|
+
"type": "string",
|
|
1289
|
+
"format": "uuid"
|
|
1290
|
+
},
|
|
1291
|
+
"encryptedDataEncryptionKey": {
|
|
1292
|
+
"type": "string",
|
|
1293
|
+
"description": "RSA encrypted random AES-256 key."
|
|
1294
|
+
}
|
|
1295
|
+
}
|
|
1296
|
+
},
|
|
1297
|
+
"AddressVerificationData": {
|
|
1298
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1299
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/AddressVerificationData",
|
|
1300
|
+
"type": "object",
|
|
1301
|
+
"additionalProperties": false,
|
|
1302
|
+
"description": "Data supplied to be used by the Address Verification Service. \n\nNeither streetAddress, nor postalCode are required as only one may be supplied and there's no\nguarantee as to which one.\n",
|
|
1303
|
+
"properties": {
|
|
1304
|
+
"streetAddress": {
|
|
1305
|
+
"type": "string",
|
|
1306
|
+
"description": "Street address supplied by the cardholder for verification."
|
|
1307
|
+
},
|
|
1308
|
+
"postalCode": {
|
|
1309
|
+
"type": "string",
|
|
1310
|
+
"description": "Postal code supplied by the cardholder for verification."
|
|
1311
|
+
}
|
|
1312
|
+
}
|
|
1313
|
+
},
|
|
1314
|
+
"ToleranceType": {
|
|
1315
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1316
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ToleranceType",
|
|
1317
|
+
"type": "string",
|
|
1318
|
+
"description": "The type of tolerance to be applied, if applicable.",
|
|
1319
|
+
"enum": ["FIXED", "PERCENTAGE", "NONE"]
|
|
1320
|
+
},
|
|
1321
|
+
"Tolerance": {
|
|
1322
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1323
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Tolerance",
|
|
1324
|
+
"type": "object",
|
|
1325
|
+
"additionalProperties": false,
|
|
1326
|
+
"description": "Minimum expected tolerance as defined by the network.",
|
|
1327
|
+
"required": ["type"],
|
|
1328
|
+
"properties": {
|
|
1329
|
+
"type": {
|
|
1330
|
+
"$ref": "/message/v2/schemas/definitions/ToleranceType"
|
|
1331
|
+
},
|
|
1332
|
+
"value": {
|
|
1333
|
+
"type": "string",
|
|
1334
|
+
"description": "The amount of the type of tolerance to be applied."
|
|
1335
|
+
}
|
|
1336
|
+
}
|
|
1337
|
+
},
|
|
1338
|
+
"IssuerNetwork": {
|
|
1339
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1340
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/IssuerNetwork",
|
|
1341
|
+
"type": "string",
|
|
1342
|
+
"description": "The network on which we received the message.",
|
|
1343
|
+
"enum": ["MASTERCARD", "MDES", "MNGS", "STAR", "VISA"]
|
|
1344
|
+
},
|
|
1345
|
+
"AcquirerNetwork": {
|
|
1346
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1347
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/AcquirerNetwork",
|
|
1348
|
+
"type": "string",
|
|
1349
|
+
"description": "The network on which the message was acquired.",
|
|
1350
|
+
"enum": [
|
|
1351
|
+
"ALLPOINT",
|
|
1352
|
+
"CIRRUS",
|
|
1353
|
+
"DEBIT MASTERCARD",
|
|
1354
|
+
"CREDIT MASTERCARD",
|
|
1355
|
+
"DISCOVER",
|
|
1356
|
+
"INTERLINK",
|
|
1357
|
+
"MAESTRO",
|
|
1358
|
+
"OTHER",
|
|
1359
|
+
"PLUS",
|
|
1360
|
+
"PULSE",
|
|
1361
|
+
"STAR",
|
|
1362
|
+
"STAR POS",
|
|
1363
|
+
"VISA",
|
|
1364
|
+
"APPLE PAY",
|
|
1365
|
+
"GOOGLE PAY",
|
|
1366
|
+
"SAMSUNG PAY",
|
|
1367
|
+
"MDES FOR MERCHANTS",
|
|
1368
|
+
"CLICK TO PAY"
|
|
1369
|
+
]
|
|
1370
|
+
},
|
|
1371
|
+
"ResponseCode": {
|
|
1372
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1373
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ResponseCode",
|
|
1374
|
+
"type": "string",
|
|
1375
|
+
"description": "The message processing result.",
|
|
1376
|
+
"enum": [
|
|
1377
|
+
"APPROVED",
|
|
1378
|
+
"REFER TO ISSUER",
|
|
1379
|
+
"REFER TO ISSUER SPECIAL CONDITION",
|
|
1380
|
+
"INVALID MERCHANT",
|
|
1381
|
+
"PICKUP",
|
|
1382
|
+
"DO NOT HONOR",
|
|
1383
|
+
"SYSTEM ERROR",
|
|
1384
|
+
"PICKUP CARD SPECIAL CONDITION",
|
|
1385
|
+
"HONOR WITH ID",
|
|
1386
|
+
"REQUEST IN PROGRESS",
|
|
1387
|
+
"PARTIAL APPROVAL",
|
|
1388
|
+
"INVALID TRANSACTION",
|
|
1389
|
+
"INVALID AMOUNT",
|
|
1390
|
+
"CARD NOT FOUND",
|
|
1391
|
+
"REENTER TRANSACTION",
|
|
1392
|
+
"INVALID RESPONSE",
|
|
1393
|
+
"UNACCEPTABLE TRANSACTION FEE",
|
|
1394
|
+
"FILE UPDATE NOT SUPPORTED",
|
|
1395
|
+
"UNABLE TO LOCATE RECORD",
|
|
1396
|
+
"DUPLICATE FILE UPDATE",
|
|
1397
|
+
"FILE UPDATE EDIT ERROR",
|
|
1398
|
+
"FILE UPDATE FILE LOCKED",
|
|
1399
|
+
"FILE UPDATE FAILED",
|
|
1400
|
+
"FORMAT ERROR",
|
|
1401
|
+
"NO CREDIT ACCOUNT",
|
|
1402
|
+
"REQUESTED FUNCTION NOT SUPPORTED",
|
|
1403
|
+
"LOST CARD CAPTURE",
|
|
1404
|
+
"NO UNIVERSAL ACCOUNT",
|
|
1405
|
+
"STOLEN CARD CAPTURE",
|
|
1406
|
+
"NO INVESTMENT ACCOUNT",
|
|
1407
|
+
"INSUFFICIENT FUNDS",
|
|
1408
|
+
"NO CHECKING ACCOUNT",
|
|
1409
|
+
"NO SAVINGS ACCOUNT",
|
|
1410
|
+
"EXPIRED CARD",
|
|
1411
|
+
"INCORRECT PIN",
|
|
1412
|
+
"NO CARD RECORD",
|
|
1413
|
+
"TRANSACTION NOT PERMITTED TO CARDHOLDER",
|
|
1414
|
+
"TRANSACTION NOT PERMITTED TO TERMINAL",
|
|
1415
|
+
"SUSPECTED FRAUD",
|
|
1416
|
+
"EXCEEDS WITHDRAWAL LIMIT",
|
|
1417
|
+
"RESTRICTED CARD",
|
|
1418
|
+
"SECURITY VIOLATION",
|
|
1419
|
+
"EXCEEDS WITHDRAWAL FREQUENCY LIMIT",
|
|
1420
|
+
"HARD CAPTURE",
|
|
1421
|
+
"LATE RESPONSE",
|
|
1422
|
+
"PIN TRIES EXCEEDED",
|
|
1423
|
+
"KEY SYNC ERROR",
|
|
1424
|
+
"CARDHOLDER NOT ELIGIBLE FOR POS",
|
|
1425
|
+
"ISSUER NOT AVAILABLE",
|
|
1426
|
+
"DUPLICATE",
|
|
1427
|
+
"INFORMATION NOT ON FILE",
|
|
1428
|
+
"CARD VERIFICATION FAILURE",
|
|
1429
|
+
"CUTOFF IN PROGRESS",
|
|
1430
|
+
"ISSUER INOPERATIVE",
|
|
1431
|
+
"TRANSACTION CANNOT COMPLETE LAW VIOLATION",
|
|
1432
|
+
"DUPLICATE TRANSMISSION",
|
|
1433
|
+
"RECONCILE ERROR",
|
|
1434
|
+
"SYSTEM MALFUNCTION",
|
|
1435
|
+
"CARD VERIFICATION2 FAILURE",
|
|
1436
|
+
"CARD VERIFICATION3 FAILURE",
|
|
1437
|
+
"EXPIRATION DATE MISMATCH",
|
|
1438
|
+
"INACTIVE CARD",
|
|
1439
|
+
"ITEM SUSPECTED FOR STOP PAY",
|
|
1440
|
+
"ACCOUNT CLOSED",
|
|
1441
|
+
"INELIGIBLE ACCOUNT",
|
|
1442
|
+
"ITEM SUBMITTED MORE THAN TWO TIMES",
|
|
1443
|
+
"NO ACCT ON FILE",
|
|
1444
|
+
"UNABLE TO LOCATE",
|
|
1445
|
+
"GENERAL DENIAL",
|
|
1446
|
+
"SPECIAL CONDITIONS",
|
|
1447
|
+
"PIN REQUIRED",
|
|
1448
|
+
"PAN TRANSFORMATION ERROR",
|
|
1449
|
+
"RISK BLOCK",
|
|
1450
|
+
"INVALID ARQC",
|
|
1451
|
+
"REQUIRE ADDITIONAL AUTHENTICATION",
|
|
1452
|
+
"OTHER"
|
|
1453
|
+
]
|
|
1454
|
+
},
|
|
1455
|
+
"AdviceResponse": {
|
|
1456
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1457
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/AdviceResponse",
|
|
1458
|
+
"type": "object",
|
|
1459
|
+
"description": "Additional information about the advice, reversal, or both.",
|
|
1460
|
+
"additionalProperties": false,
|
|
1461
|
+
"required": ["adviceOriginator", "adviceReason", "reversalOriginator", "reversalReason"],
|
|
1462
|
+
"properties": {
|
|
1463
|
+
"adviceOriginator": {
|
|
1464
|
+
"$ref": "/message/v2/schemas/definitions/Originator"
|
|
1465
|
+
},
|
|
1466
|
+
"adviceReason": {
|
|
1467
|
+
"$ref": "/message/v2/schemas/definitions/AdviceReason"
|
|
1468
|
+
},
|
|
1469
|
+
"reversalOriginator": {
|
|
1470
|
+
"$ref": "/message/v2/schemas/definitions/Originator"
|
|
1471
|
+
},
|
|
1472
|
+
"reversalReason": {
|
|
1473
|
+
"$ref": "/message/v2/schemas/definitions/ReversalReason"
|
|
1474
|
+
},
|
|
1475
|
+
"authorizationIdResponse": {
|
|
1476
|
+
"type": "string",
|
|
1477
|
+
"description": "Used to identify the message being corrected. This corresponds to the authorizationIdResponse in the \nResponse of the message being correcting.\n"
|
|
1478
|
+
},
|
|
1479
|
+
"responseCode": {
|
|
1480
|
+
"$ref": "/message/v2/schemas/definitions/ResponseCode"
|
|
1481
|
+
}
|
|
1482
|
+
}
|
|
1483
|
+
},
|
|
1484
|
+
"Originator": {
|
|
1485
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1486
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Originator",
|
|
1487
|
+
"type": "string",
|
|
1488
|
+
"description": "The party that initiated the advice or reversal.",
|
|
1489
|
+
"enum": ["NOT APPLICABLE", "CARD ACCEPTOR", "ACQUIRER", "INTERMEDIATE FACILITY", "CUSTOMER", "SWITCH", "UNKNOWN"]
|
|
1490
|
+
},
|
|
1491
|
+
"AdviceReason": {
|
|
1492
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1493
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/AdviceReason",
|
|
1494
|
+
"type": "string",
|
|
1495
|
+
"description": "THe reason for the advice according to the advice originator.",
|
|
1496
|
+
"enum": [
|
|
1497
|
+
"NOT APPLICABLE",
|
|
1498
|
+
"NOT AN ADVICE",
|
|
1499
|
+
"TIMED OUT REQUEST",
|
|
1500
|
+
"ISSUER NOT AVAILABLE",
|
|
1501
|
+
"ISSUER SIGNED OFF",
|
|
1502
|
+
"WITHIN BUSINESS AGREEMENT",
|
|
1503
|
+
"KEY NOT ESTABLISHED",
|
|
1504
|
+
"ISSUER REQUESTED STANDIN",
|
|
1505
|
+
"OTHER",
|
|
1506
|
+
"UNKNOWN"
|
|
1507
|
+
]
|
|
1508
|
+
},
|
|
1509
|
+
"ReversalReason": {
|
|
1510
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1511
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ReversalReason",
|
|
1512
|
+
"type": "string",
|
|
1513
|
+
"description": "The reason for the reversal according to the reversal originator.",
|
|
1514
|
+
"enum": [
|
|
1515
|
+
"NOT APPLICABLE",
|
|
1516
|
+
"ISSUER NOT AVAILABLE",
|
|
1517
|
+
"ISSUER SIGNED OFF",
|
|
1518
|
+
"WITHIN BUSINESS AGREEMENT",
|
|
1519
|
+
"TERMINAL PROCESSOR ERROR",
|
|
1520
|
+
"SYSTEM TIMEOUT",
|
|
1521
|
+
"TERMINAL DISPENSE ERROR",
|
|
1522
|
+
"TERMINAL COMMUNICATION ERROR",
|
|
1523
|
+
"TERMINAL ERROR",
|
|
1524
|
+
"LATE RESPONSE",
|
|
1525
|
+
"CUSTOMER CANCELLATION",
|
|
1526
|
+
"SUSPECTED FRAUD",
|
|
1527
|
+
"CHIP",
|
|
1528
|
+
"PARTIAL",
|
|
1529
|
+
"EDIT ERROR",
|
|
1530
|
+
"REVISED HOLD AMOUNT",
|
|
1531
|
+
"UNKNOWN"
|
|
1532
|
+
]
|
|
1533
|
+
},
|
|
1534
|
+
"AddressVerificationResult": {
|
|
1535
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1536
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/AddressVerificationResult",
|
|
1537
|
+
"type": "string",
|
|
1538
|
+
"description": "The result of the supplied addressVerificationData being checked against the Address Verification System.\n",
|
|
1539
|
+
"enum": [
|
|
1540
|
+
"ADDRESS MATCH ONLY",
|
|
1541
|
+
"POSTAL CODE MATCH ONLY",
|
|
1542
|
+
"FULL POSTAL CODE MATCH ONLY",
|
|
1543
|
+
"ADDRESS AND POSTAL CODE MATCH",
|
|
1544
|
+
"ADDRESS AND FULL POSTAL CODE MATCH",
|
|
1545
|
+
"NO MATCH",
|
|
1546
|
+
"UNAVAILABLE",
|
|
1547
|
+
"NOT PROVIDED"
|
|
1548
|
+
]
|
|
1549
|
+
},
|
|
1550
|
+
"ApplicationTransactionCounterValidationResult": {
|
|
1551
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1552
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ApplicationTransactionCounterValidationResult",
|
|
1553
|
+
"type": "string",
|
|
1554
|
+
"description": "The result of validating the applicationTransactionCounter value found in the card's chip data.",
|
|
1555
|
+
"enum": ["VALID", "OUT OF RANGE", "DUPLICATE", "NOT VALIDATED", "BYPASSED", "NOT PROVIDED"]
|
|
1556
|
+
},
|
|
1557
|
+
"SuppliedCardExpirationDate": {
|
|
1558
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1559
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/SuppliedCardExpirationDate",
|
|
1560
|
+
"type": "string",
|
|
1561
|
+
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
1562
|
+
"description": "Card expiration date either supplied manually, such as when entering card information into an online payment \nform, or found in the card's track 1 data. The date is assumed to be the last millisecond of the month. Format\nis YYMM.\n",
|
|
1563
|
+
"example": "9912"
|
|
1564
|
+
},
|
|
1565
|
+
"TrackValidationResult": {
|
|
1566
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1567
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/TrackValidationResult",
|
|
1568
|
+
"type": "string",
|
|
1569
|
+
"description": "The validity of the card's track data used in the transaction.\n\nVALID - The track data is valid and matches the card.\nINVALID - The track data format is invalid.\nMISMATCH - The track data does not match the card.\n",
|
|
1570
|
+
"enum": ["VALID", "INVALID", "MISMATCH", "NOT PROVIDED"]
|
|
1571
|
+
},
|
|
1572
|
+
"PINValidationResult": {
|
|
1573
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1574
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/PINValidationResult",
|
|
1575
|
+
"type": "string",
|
|
1576
|
+
"description": "The validity of the supplied PIN.",
|
|
1577
|
+
"enum": ["VALID", "INVALID", "INVALID KEY", "UNAVAILABLE", "NOT PROVIDED"]
|
|
1578
|
+
},
|
|
1579
|
+
"VerificationValueResult": {
|
|
1580
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1581
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/VerificationValueResult",
|
|
1582
|
+
"type": "string",
|
|
1583
|
+
"description": "The validity of the supplied verification value.",
|
|
1584
|
+
"enum": ["VALID", "INVALID", "UNAVAILABLE", "NOT PROVIDED"]
|
|
1585
|
+
},
|
|
1586
|
+
"ARQCValidationResult": {
|
|
1587
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1588
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ARQCValidationResult",
|
|
1589
|
+
"type": "string",
|
|
1590
|
+
"description": "The validity of the supplied ARQC (Authorization Request Cryptogram).",
|
|
1591
|
+
"enum": ["VALID", "INVALID", "UNAVAILABLE", "NOT PROVIDED"]
|
|
1592
|
+
},
|
|
1593
|
+
"EMV3DSecureAuthenticationResult": {
|
|
1594
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1595
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/EMV3DSecureAuthenticationResult",
|
|
1596
|
+
"type": "string",
|
|
1597
|
+
"enum": [
|
|
1598
|
+
"AUTHENTICATED BY ISSUER",
|
|
1599
|
+
"AUTHENTICATED BY NETWORK",
|
|
1600
|
+
"UNAUTHENTICATED",
|
|
1601
|
+
"UNAVAILABLE",
|
|
1602
|
+
"UNKNOWN",
|
|
1603
|
+
"NOT PROVIDED"
|
|
1604
|
+
]
|
|
1605
|
+
},
|
|
1606
|
+
"IIASData": {
|
|
1607
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1608
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/IIASData",
|
|
1609
|
+
"type": "object",
|
|
1610
|
+
"description": "Data received from merchants using an IIAS (Inventory Information Approval System).\nAn IIAS is used by merchants to identify which items are eligible healthcare expenses under FSA (Flexible Spending Account) or HSA (Health Savings Account) rules.",
|
|
1611
|
+
"additionalProperties": false,
|
|
1612
|
+
"required": ["merchantId", "verificationResult", "healthCareAmount", "prescriptionAmount", "visionAmount"],
|
|
1613
|
+
"properties": {
|
|
1614
|
+
"merchantId": {
|
|
1615
|
+
"type": "string",
|
|
1616
|
+
"description": "IIAS specific merchant id which is different from the merchant name or card acceptor identification code.\n"
|
|
1617
|
+
},
|
|
1618
|
+
"verificationResult": {
|
|
1619
|
+
"type": "string",
|
|
1620
|
+
"description": "The merchant IIAS validation result.\n\nHas the value 'UNVERIFIED' if the merchant did not perform an IIAS validation, the value 'VERIFIED' if the \nmerchant did verify with IIAS and is valid, the value '90PERCENT' if the merchant is exempt, and the value\nNONCERTIFIED if the merchant submitted IIAS data but was unable to validate their certification status.\n",
|
|
1621
|
+
"enum": ["UNVERIFIED", "VERIFIED", "90PERCENT", "NONCERTIFIED"]
|
|
1622
|
+
},
|
|
1623
|
+
"healthCareAmount": {
|
|
1624
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
1625
|
+
},
|
|
1626
|
+
"prescriptionAmount": {
|
|
1627
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
1628
|
+
},
|
|
1629
|
+
"visionAmount": {
|
|
1630
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
1631
|
+
}
|
|
1632
|
+
}
|
|
1633
|
+
},
|
|
1634
|
+
"Token": {
|
|
1635
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1636
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Token",
|
|
1637
|
+
"required": ["tokenId", "status"],
|
|
1638
|
+
"properties": {
|
|
1639
|
+
"tokenId": {
|
|
1640
|
+
"type": "string",
|
|
1641
|
+
"maxLength": 64,
|
|
1642
|
+
"description": "Uniquely identifies the token."
|
|
1643
|
+
},
|
|
1644
|
+
"status": {
|
|
1645
|
+
"$ref": "/message/v2/schemas/definitions/TokenStatus"
|
|
1646
|
+
},
|
|
1647
|
+
"tokenExpiration": {
|
|
1648
|
+
"type": "string",
|
|
1649
|
+
"description": "The date the token expires.",
|
|
1650
|
+
"pattern": "([0-9][0-9])(0[1-9]|1[0-2])",
|
|
1651
|
+
"example": "9912"
|
|
1652
|
+
}
|
|
1653
|
+
}
|
|
1654
|
+
},
|
|
1655
|
+
"TokenStatus": {
|
|
1656
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1657
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/TokenStatus",
|
|
1658
|
+
"type": "string",
|
|
1659
|
+
"description": "The current status of token.\n\nINACTIVE - Token has not yet been activated.\nACTIVE - Active and ready.\nSUSPENDED - Suspended and unable to be used.\nDEACTIVATED - Permanently deactivated.\n",
|
|
1660
|
+
"enum": ["INACTIVE", "ACTIVE", "SUSPENDED", "DEACTIVATED", "UNKNOWN"]
|
|
1661
|
+
},
|
|
1662
|
+
"TokenNotificationReasonCode": {
|
|
1663
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1664
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/TokenNotificationReasonCode",
|
|
1665
|
+
"type": "string",
|
|
1666
|
+
"description": "The reason for the notification.\n\nTokens 'DELETED FROM CONSUMER APP' may still be active.\n",
|
|
1667
|
+
"enum": ["STATUS UPDATE", "REDIGITIZATION COMPLETE", "DELETED FROM CONSUMER APP"]
|
|
1668
|
+
},
|
|
1669
|
+
"TokenNotificationData": {
|
|
1670
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1671
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/TokenNotificationData",
|
|
1672
|
+
"description": "The data provided in a token notification. The notification may apply to multiple\ntokens.\n",
|
|
1673
|
+
"properties": {
|
|
1674
|
+
"tokens": {
|
|
1675
|
+
"type": "array",
|
|
1676
|
+
"description": "Tokens affected by the notification.",
|
|
1677
|
+
"items": {
|
|
1678
|
+
"$ref": "/message/v2/schemas/definitions/Token"
|
|
1679
|
+
}
|
|
1680
|
+
},
|
|
1681
|
+
"reasonCode": {
|
|
1682
|
+
"$ref": "/message/v2/schemas/definitions/TokenNotificationReasonCode"
|
|
1683
|
+
},
|
|
1684
|
+
"activationCodeExpirationDateTime": {
|
|
1685
|
+
"type": "string",
|
|
1686
|
+
"format": "date-time",
|
|
1687
|
+
"description": "The UTC datetime the activation code expires."
|
|
1688
|
+
},
|
|
1689
|
+
"numberOfActivationAttempts": {
|
|
1690
|
+
"type": "number",
|
|
1691
|
+
"description": "The number of times an activationCode was sent in order to activate a token.\n"
|
|
1692
|
+
},
|
|
1693
|
+
"numberOfActiveTokens": {
|
|
1694
|
+
"type": "number",
|
|
1695
|
+
"description": "The number of active tokens.\n\nThe value might differ from the number of tokens listed in the 'tokens' property of the notification, as \nthis represents all tokens not just the ones being updated. Tokens that have been deleted from the wallet \nare excluded from the count.\n"
|
|
1696
|
+
},
|
|
1697
|
+
"tokenAuthentication": {
|
|
1698
|
+
"type": "string",
|
|
1699
|
+
"description": "Indicates the given tokens have been authenticated.",
|
|
1700
|
+
"enum": ["AUTHENTICATED", "NOT AUTHENTICATED", "NOT PROVIDED"]
|
|
1701
|
+
},
|
|
1702
|
+
"tokenAssuranceLevel": {
|
|
1703
|
+
"type": "number",
|
|
1704
|
+
"description": "A number that allows the token issuer to indicate the confidence level of the token on whether it belongs \nto the cardholder it claims to be associated with. \n\nWill only be present if tokenAuthentication = AUTHENTICATED\n"
|
|
1705
|
+
},
|
|
1706
|
+
"suspiciousEvent": {
|
|
1707
|
+
"description": "The event for why the notification is being sent.",
|
|
1708
|
+
"required": ["reason"],
|
|
1709
|
+
"properties": {
|
|
1710
|
+
"reason": {
|
|
1711
|
+
"type": "string",
|
|
1712
|
+
"description": "The reason why a suspiciousEvent is provided.\n\nREPLENISH - There were suspicious ATC values reporting during Replenish.\n",
|
|
1713
|
+
"enum": ["REPLENISH", "OTHER"],
|
|
1714
|
+
"example": "REPLENISH"
|
|
1715
|
+
}
|
|
1716
|
+
}
|
|
1717
|
+
}
|
|
1718
|
+
}
|
|
1719
|
+
},
|
|
1720
|
+
"ActivationTextPhoneNumber": {
|
|
1721
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1722
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ActivationTextPhoneNumber",
|
|
1723
|
+
"required": ["type", "value"],
|
|
1724
|
+
"description": "Denotes an activation method using the cardholder's mobile phone number. Value is masked.",
|
|
1725
|
+
"properties": {
|
|
1726
|
+
"type": {
|
|
1727
|
+
"type": "string",
|
|
1728
|
+
"enum": ["TEXT"]
|
|
1729
|
+
},
|
|
1730
|
+
"value": {
|
|
1731
|
+
"type": "string"
|
|
1732
|
+
}
|
|
1733
|
+
}
|
|
1734
|
+
},
|
|
1735
|
+
"ActivationEmailAccountHolder": {
|
|
1736
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1737
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ActivationEmailAccountHolder",
|
|
1738
|
+
"required": ["type", "value"],
|
|
1739
|
+
"description": "Denotes an activation method using the cardholder's email address. Value is masked.",
|
|
1740
|
+
"properties": {
|
|
1741
|
+
"type": {
|
|
1742
|
+
"type": "string",
|
|
1743
|
+
"enum": ["EMAIL"]
|
|
1744
|
+
},
|
|
1745
|
+
"value": {
|
|
1746
|
+
"type": "string",
|
|
1747
|
+
"minLength": 1,
|
|
1748
|
+
"maxLength": 64
|
|
1749
|
+
}
|
|
1750
|
+
}
|
|
1751
|
+
},
|
|
1752
|
+
"ActivationCallAutomatedNumber": {
|
|
1753
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1754
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ActivationCallAutomatedNumber",
|
|
1755
|
+
"required": ["type", "value"],
|
|
1756
|
+
"description": "Denotes an activation method requiring the cardholder to call to an automated call center phone number. \nValue will be the phone number for the cardholder to call.\n",
|
|
1757
|
+
"properties": {
|
|
1758
|
+
"type": {
|
|
1759
|
+
"type": "string",
|
|
1760
|
+
"enum": ["AUTOMATED NUMBER"]
|
|
1761
|
+
},
|
|
1762
|
+
"value": {
|
|
1763
|
+
"type": "string"
|
|
1764
|
+
}
|
|
1765
|
+
}
|
|
1766
|
+
},
|
|
1767
|
+
"ActivationCallCustomerSupport": {
|
|
1768
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1769
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ActivationCallCustomerSupport",
|
|
1770
|
+
"required": ["type", "value"],
|
|
1771
|
+
"description": "Denotes an activation method requiring the cardholder to call to a customer support call center phone number. \nValue will be the phone number for the cardholder to call.\n",
|
|
1772
|
+
"properties": {
|
|
1773
|
+
"type": {
|
|
1774
|
+
"type": "string",
|
|
1775
|
+
"enum": ["SUPPORT NUMBER"]
|
|
1776
|
+
},
|
|
1777
|
+
"value": {
|
|
1778
|
+
"type": "string"
|
|
1779
|
+
}
|
|
1780
|
+
}
|
|
1781
|
+
},
|
|
1782
|
+
"ActivationVisitWebsite": {
|
|
1783
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1784
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ActivationVisitWebsite",
|
|
1785
|
+
"required": ["type", "value"],
|
|
1786
|
+
"description": "Denotes an activation method requiring the cardholder to visit a website. \nValue will be a URL.\n",
|
|
1787
|
+
"properties": {
|
|
1788
|
+
"type": {
|
|
1789
|
+
"type": "string",
|
|
1790
|
+
"enum": ["WEBSITE"]
|
|
1791
|
+
},
|
|
1792
|
+
"value": {
|
|
1793
|
+
"type": "string",
|
|
1794
|
+
"maxLength": 64
|
|
1795
|
+
}
|
|
1796
|
+
}
|
|
1797
|
+
},
|
|
1798
|
+
"ActivationVisitMobileApp": {
|
|
1799
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1800
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ActivationVisitMobileApp",
|
|
1801
|
+
"required": ["type", "value"],
|
|
1802
|
+
"description": "Denotes an activation method requiring the cardholder to use a specific mobile app to activate token. \nValue will be replaced by a formatted string.\n",
|
|
1803
|
+
"properties": {
|
|
1804
|
+
"type": {
|
|
1805
|
+
"type": "string",
|
|
1806
|
+
"enum": ["APP"]
|
|
1807
|
+
},
|
|
1808
|
+
"value": {
|
|
1809
|
+
"type": "string",
|
|
1810
|
+
"maxLength": 64
|
|
1811
|
+
}
|
|
1812
|
+
}
|
|
1813
|
+
},
|
|
1814
|
+
"ActivationCallCardHolderNumber": {
|
|
1815
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1816
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ActivationCallCardHolderNumber",
|
|
1817
|
+
"required": ["type", "value"],
|
|
1818
|
+
"description": "Denotes an activation method using an issuer-initiated voice call to the cardholder's phone. \nValue will be the cardholder's masked phone number used for voice calls.\n",
|
|
1819
|
+
"properties": {
|
|
1820
|
+
"type": {
|
|
1821
|
+
"type": "string",
|
|
1822
|
+
"enum": ["CARDHOLDER NUMBER"]
|
|
1823
|
+
},
|
|
1824
|
+
"value": {
|
|
1825
|
+
"type": "string"
|
|
1826
|
+
}
|
|
1827
|
+
}
|
|
1828
|
+
},
|
|
1829
|
+
"ActivationMethod": {
|
|
1830
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1831
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ActivationMethod",
|
|
1832
|
+
"oneOf": [
|
|
1833
|
+
{
|
|
1834
|
+
"$ref": "/message/v2/schemas/definitions/ActivationTextPhoneNumber"
|
|
1835
|
+
},
|
|
1836
|
+
{
|
|
1837
|
+
"$ref": "/message/v2/schemas/definitions/ActivationEmailAccountHolder"
|
|
1838
|
+
},
|
|
1839
|
+
{
|
|
1840
|
+
"$ref": "/message/v2/schemas/definitions/ActivationCallAutomatedNumber"
|
|
1841
|
+
},
|
|
1842
|
+
{
|
|
1843
|
+
"$ref": "/message/v2/schemas/definitions/ActivationCallCustomerSupport"
|
|
1844
|
+
},
|
|
1845
|
+
{
|
|
1846
|
+
"$ref": "/message/v2/schemas/definitions/ActivationVisitWebsite"
|
|
1847
|
+
},
|
|
1848
|
+
{
|
|
1849
|
+
"$ref": "/message/v2/schemas/definitions/ActivationVisitMobileApp"
|
|
1850
|
+
},
|
|
1851
|
+
{
|
|
1852
|
+
"$ref": "/message/v2/schemas/definitions/ActivationCallCardHolderNumber"
|
|
1853
|
+
}
|
|
1854
|
+
]
|
|
1855
|
+
},
|
|
1856
|
+
"RecommendationReason": {
|
|
1857
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1858
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/RecommendationReason",
|
|
1859
|
+
"type": "string",
|
|
1860
|
+
"description": "The reason for the Wallet Provider's recommended decision.",
|
|
1861
|
+
"enum": [
|
|
1862
|
+
"ACCOUNT TOO NEW SINCE LAUNCH",
|
|
1863
|
+
"ACCOUNT TOO NEW",
|
|
1864
|
+
"ACCOUNT CARD TOO NEW",
|
|
1865
|
+
"ACCOUNT RECENTLY CHANGED",
|
|
1866
|
+
"SUSPICIOUS ACTIVITY",
|
|
1867
|
+
"INACTIVE ACCOUNT",
|
|
1868
|
+
"HAS SUSPENDED TOKENS",
|
|
1869
|
+
"DEVICE RECENTLY LOST",
|
|
1870
|
+
"TOO MANY RECENT ATTEMPTS",
|
|
1871
|
+
"TOO MANY RECENT TOKENS",
|
|
1872
|
+
"TOO MANY DIFFERENT CARDHOLDERS",
|
|
1873
|
+
"LOW DEVICE SCORE",
|
|
1874
|
+
"LOW ACCOUNT SCORE",
|
|
1875
|
+
"OUTSIDE HOME TERRITORY",
|
|
1876
|
+
"UNABLE TO ASSESS",
|
|
1877
|
+
"HIGH RISK",
|
|
1878
|
+
"LOW PHONE NUMBER SCORE",
|
|
1879
|
+
"LONG ACCOUNT TENURE",
|
|
1880
|
+
"GOOD ACTIVITY HISTORY",
|
|
1881
|
+
"ADDITIONAL DEVICE",
|
|
1882
|
+
"SOFTWARE UPDATE",
|
|
1883
|
+
"OTHER"
|
|
1884
|
+
],
|
|
1885
|
+
"example": "ACCOUNT TOO NEW"
|
|
1886
|
+
},
|
|
1887
|
+
"RecommendedDecision": {
|
|
1888
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1889
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/RecommendedDecision",
|
|
1890
|
+
"type": "string",
|
|
1891
|
+
"description": "The decision recommended by the Wallet Provider.",
|
|
1892
|
+
"enum": ["APPROVED", "DECLINED", "REQUIRE ADDITIONAL AUTHENTICATION"],
|
|
1893
|
+
"example": "APPROVED"
|
|
1894
|
+
},
|
|
1895
|
+
"WalletProviderScore": {
|
|
1896
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1897
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/WalletProviderScore",
|
|
1898
|
+
"type": "string",
|
|
1899
|
+
"description": "Score given by the Wallet Provider on their confidence level of a particular property.\n",
|
|
1900
|
+
"enum": ["SCORE 1", "SCORE 2", "SCORE 3", "SCORE 4", "SCORE 5", "NOT PROVIDED"],
|
|
1901
|
+
"example": "SCORE 4"
|
|
1902
|
+
},
|
|
1903
|
+
"WalletProviderDecisioning": {
|
|
1904
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1905
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/WalletProviderDecisioning",
|
|
1906
|
+
"type": "object",
|
|
1907
|
+
"description": "The scores and reasons leading to the recommended decision.\n",
|
|
1908
|
+
"required": ["recommendedDecision", "deviceScore", "accountScore", "phoneNumberScore", "recommendationReasons"],
|
|
1909
|
+
"properties": {
|
|
1910
|
+
"recommendedDecision": {
|
|
1911
|
+
"$ref": "/message/v2/schemas/definitions/RecommendedDecision"
|
|
1912
|
+
},
|
|
1913
|
+
"deviceScore": {
|
|
1914
|
+
"$ref": "/message/v2/schemas/definitions/WalletProviderScore"
|
|
1915
|
+
},
|
|
1916
|
+
"accountScore": {
|
|
1917
|
+
"$ref": "/message/v2/schemas/definitions/WalletProviderScore"
|
|
1918
|
+
},
|
|
1919
|
+
"phoneNumberScore": {
|
|
1920
|
+
"$ref": "/message/v2/schemas/definitions/WalletProviderScore"
|
|
1921
|
+
},
|
|
1922
|
+
"recommendationReasons": {
|
|
1923
|
+
"type": "array",
|
|
1924
|
+
"description": "Reasons provided to the Wallet Provider on how the recommended decision was reached.",
|
|
1925
|
+
"minLength": 0,
|
|
1926
|
+
"items": {
|
|
1927
|
+
"$ref": "/message/v2/schemas/definitions/RecommendationReason"
|
|
1928
|
+
}
|
|
1929
|
+
}
|
|
1930
|
+
}
|
|
1931
|
+
},
|
|
1932
|
+
"TokenizationData": {
|
|
1933
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1934
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/TokenizationData",
|
|
1935
|
+
"description": "Data relevant to the process of a tokenization.",
|
|
1936
|
+
"properties": {
|
|
1937
|
+
"activationCode": {
|
|
1938
|
+
"type": "string",
|
|
1939
|
+
"minLength": 1,
|
|
1940
|
+
"maxLength": 32,
|
|
1941
|
+
"description": "The Activation Code to be distributed for tokenization."
|
|
1942
|
+
},
|
|
1943
|
+
"tokenId": {
|
|
1944
|
+
"type": "string",
|
|
1945
|
+
"maxLength": 64,
|
|
1946
|
+
"description": "A unique id assigned by the party that initiated the tokenization."
|
|
1947
|
+
},
|
|
1948
|
+
"tokenType": {
|
|
1949
|
+
"type": "string",
|
|
1950
|
+
"description": "The type of token requested for this tokenization.",
|
|
1951
|
+
"enum": ["EMBEDDED SECURE ELEMENT", "CLOUD", "STATIC"]
|
|
1952
|
+
},
|
|
1953
|
+
"tokenRequestorId": {
|
|
1954
|
+
"type": "string",
|
|
1955
|
+
"minLength": 11,
|
|
1956
|
+
"maxLength": 11,
|
|
1957
|
+
"description": "Identifier for the party that requested the tokenization."
|
|
1958
|
+
},
|
|
1959
|
+
"activationMethod": {
|
|
1960
|
+
"$ref": "/message/v2/schemas/definitions/ActivationMethod"
|
|
1961
|
+
},
|
|
1962
|
+
"walletProviderDecisioning": {
|
|
1963
|
+
"$ref": "/message/v2/schemas/definitions/WalletProviderDecisioning"
|
|
1964
|
+
}
|
|
1965
|
+
}
|
|
1966
|
+
},
|
|
1967
|
+
"EMVChipData": {
|
|
1968
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1969
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/EMVChipData",
|
|
1970
|
+
"type": "object",
|
|
1971
|
+
"description": "Data generated between the card's EMV chip and the terminal used in the transaction.",
|
|
1972
|
+
"additionalProperties": false,
|
|
1973
|
+
"required": ["applicationId", "applicationTransactionCounter", "amountAuthorized", "amountOther"],
|
|
1974
|
+
"properties": {
|
|
1975
|
+
"applicationId": {
|
|
1976
|
+
"description": "Identifier for the application used between the terminal and chip for generating chip data.",
|
|
1977
|
+
"type": "string"
|
|
1978
|
+
},
|
|
1979
|
+
"applicationTransactionCounter": {
|
|
1980
|
+
"description": "Application Transaction Counter (ATC) generated by the chip.",
|
|
1981
|
+
"type": "string"
|
|
1982
|
+
},
|
|
1983
|
+
"amountAuthorized": {
|
|
1984
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
1985
|
+
},
|
|
1986
|
+
"amountOther": {
|
|
1987
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
1988
|
+
}
|
|
1989
|
+
}
|
|
1990
|
+
},
|
|
1991
|
+
"FeeType": {
|
|
1992
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
1993
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/FeeType",
|
|
1994
|
+
"type": "string",
|
|
1995
|
+
"description": "The type of fee being applied to the transaction.",
|
|
1996
|
+
"enum": [
|
|
1997
|
+
"CONVENIENCE",
|
|
1998
|
+
"TRANSACTION",
|
|
1999
|
+
"CURRENCY CONVERSION ASSESSMENT",
|
|
2000
|
+
"ISSUER CURRENCY CONVERSION ASSESSMENT",
|
|
2001
|
+
"SURCHARGE",
|
|
2002
|
+
"OPTIONAL ISSUER",
|
|
2003
|
+
"PROCESSING",
|
|
2004
|
+
"FOREIGN EXCHANGE"
|
|
2005
|
+
]
|
|
2006
|
+
},
|
|
2007
|
+
"FeeApplication": {
|
|
2008
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2009
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/FeeApplication",
|
|
2010
|
+
"type": "string",
|
|
2011
|
+
"description": "Indicates whether the fee should be applied to a cardholder's account (SETTLE) or recorded for information\npurposes only (MEMO). Examples of MEMO fees are currency conversion fees (already in the settlement amount) and\ninterchange fees.\n",
|
|
2012
|
+
"enum": ["MEMO", "SETTLE"]
|
|
2013
|
+
},
|
|
2014
|
+
"Fee": {
|
|
2015
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2016
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Fee",
|
|
2017
|
+
"type": "object",
|
|
2018
|
+
"description": "Details about the fees applied to the transaction and settlement amounts.",
|
|
2019
|
+
"additionalProperties": false,
|
|
2020
|
+
"required": ["type", "application", "transaction", "settlement"],
|
|
2021
|
+
"properties": {
|
|
2022
|
+
"type": {
|
|
2023
|
+
"$ref": "/message/v2/schemas/definitions/FeeType"
|
|
2024
|
+
},
|
|
2025
|
+
"application": {
|
|
2026
|
+
"$ref": "/message/v2/schemas/definitions/FeeApplication"
|
|
2027
|
+
},
|
|
2028
|
+
"transaction": {
|
|
2029
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2030
|
+
},
|
|
2031
|
+
"settlement": {
|
|
2032
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2033
|
+
}
|
|
2034
|
+
}
|
|
2035
|
+
},
|
|
2036
|
+
"File": {
|
|
2037
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2038
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/File",
|
|
2039
|
+
"type": "object",
|
|
2040
|
+
"description": "Information about the file in which the message exists.\n\nThis may be used to change the status of a card.\n",
|
|
2041
|
+
"additionalProperties": false,
|
|
2042
|
+
"required": ["fileIdentifier", "fileDescription", "recordIdentifier", "fileDateTime"],
|
|
2043
|
+
"properties": {
|
|
2044
|
+
"fileIdentifier": {
|
|
2045
|
+
"type": "string",
|
|
2046
|
+
"description": "A unique identifier for the file in which this message exists. Often will be the name of the file."
|
|
2047
|
+
},
|
|
2048
|
+
"fileDescription": {
|
|
2049
|
+
"type": "string",
|
|
2050
|
+
"description": "A description of the file whose usage depends on the type of file that was processed."
|
|
2051
|
+
},
|
|
2052
|
+
"recordIdentifier": {
|
|
2053
|
+
"type": "string",
|
|
2054
|
+
"description": "A unique identifier for this message in the processed file. Often this will be the record number."
|
|
2055
|
+
},
|
|
2056
|
+
"fileDateTime": {
|
|
2057
|
+
"type": "string",
|
|
2058
|
+
"format": "date-time",
|
|
2059
|
+
"description": "A timestamp associated with the whole file not the individual message."
|
|
2060
|
+
}
|
|
2061
|
+
}
|
|
2062
|
+
},
|
|
2063
|
+
"TransmissionDateTime": {
|
|
2064
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2065
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/TransmissionDateTime",
|
|
2066
|
+
"type": "string",
|
|
2067
|
+
"format": "date-time",
|
|
2068
|
+
"description": "The UTC datetime the original ISO8583 message entered into the network's system. \nTime is set by the initiator of the message.\n"
|
|
2069
|
+
},
|
|
2070
|
+
"SystemTraceAuditNumber": {
|
|
2071
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2072
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/SystemTraceAuditNumber",
|
|
2073
|
+
"type": "string",
|
|
2074
|
+
"description": "A numeric identifier assigned by the system that initiated the message to help identify the transaction.\nThis is usually set by the merchant's Point of Sale (POS) or acquiring bank's system and so is useful for \nrelating messages within a batch or session. It is not globally unique.\n"
|
|
2075
|
+
},
|
|
2076
|
+
"TransactionId": {
|
|
2077
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2078
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/TransactionId",
|
|
2079
|
+
"type": "string",
|
|
2080
|
+
"description": "A unique identifier that relates messages to a single transaction as defined by the network.\n\nNote: A return is considered a distinct transaction from the original purchase.\n"
|
|
2081
|
+
},
|
|
2082
|
+
"TransactionGroupId": {
|
|
2083
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2084
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/TransactionGroupId",
|
|
2085
|
+
"type": "string",
|
|
2086
|
+
"description": "A unique identifier that relates transactions together. For example, a purchase and a return may\nbe grouped by this identifier.\n"
|
|
2087
|
+
},
|
|
2088
|
+
"NewRequest": {
|
|
2089
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2090
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/NewRequest",
|
|
2091
|
+
"type": "object",
|
|
2092
|
+
"additionalProperties": false,
|
|
2093
|
+
"required": [
|
|
2094
|
+
"messageId",
|
|
2095
|
+
"transactionId",
|
|
2096
|
+
"transactionGroupId",
|
|
2097
|
+
"cardId",
|
|
2098
|
+
"receivedDateTime",
|
|
2099
|
+
"categorization",
|
|
2100
|
+
"accounts",
|
|
2101
|
+
"transactionAmount",
|
|
2102
|
+
"transactionFeeAmount",
|
|
2103
|
+
"settlementAmount",
|
|
2104
|
+
"settlementFeeAmount",
|
|
2105
|
+
"settlementConversion",
|
|
2106
|
+
"cashBackAmount",
|
|
2107
|
+
"feeDetails",
|
|
2108
|
+
"transmissionDateTime",
|
|
2109
|
+
"systemTraceAuditNumber",
|
|
2110
|
+
"retrievalReferenceNumber",
|
|
2111
|
+
"settlementDate",
|
|
2112
|
+
"captureDate",
|
|
2113
|
+
"encryptedKeys",
|
|
2114
|
+
"merchant",
|
|
2115
|
+
"acquirer",
|
|
2116
|
+
"network",
|
|
2117
|
+
"acquirerNetwork",
|
|
2118
|
+
"incremental",
|
|
2119
|
+
"lastClearing",
|
|
2120
|
+
"recurring",
|
|
2121
|
+
"minimumTolerance",
|
|
2122
|
+
"suppliedCardExpirationDate",
|
|
2123
|
+
"track1ValidationResult",
|
|
2124
|
+
"track2ValidationResult",
|
|
2125
|
+
"pinValidationResult",
|
|
2126
|
+
"verificationValueValidationResult",
|
|
2127
|
+
"verificationValue2ValidationResult",
|
|
2128
|
+
"verificationValue3ValidationResult",
|
|
2129
|
+
"dynamicVerificationValueValidationResult",
|
|
2130
|
+
"arqcValidationResult",
|
|
2131
|
+
"emv3DSecureAuthenticationResult"
|
|
2132
|
+
],
|
|
2133
|
+
"description": "The incoming message request data received from the network to be processed.",
|
|
2134
|
+
"properties": {
|
|
2135
|
+
"messageId": {
|
|
2136
|
+
"$ref": "/message/v2/schemas/definitions/MessageId"
|
|
2137
|
+
},
|
|
2138
|
+
"cardId": {
|
|
2139
|
+
"$ref": "/message/v2/schemas/definitions/CardId"
|
|
2140
|
+
},
|
|
2141
|
+
"tokenId": {
|
|
2142
|
+
"$ref": "/message/v2/schemas/definitions/TokenId"
|
|
2143
|
+
},
|
|
2144
|
+
"transactionId": {
|
|
2145
|
+
"$ref": "/message/v2/schemas/definitions/TransactionId"
|
|
2146
|
+
},
|
|
2147
|
+
"transactionGroupId": {
|
|
2148
|
+
"$ref": "/message/v2/schemas/definitions/TransactionGroupId"
|
|
2149
|
+
},
|
|
2150
|
+
"matchedMessageId": {
|
|
2151
|
+
"$ref": "/message/v2/schemas/definitions/MatchedMessageId"
|
|
2152
|
+
},
|
|
2153
|
+
"receivedDateTime": {
|
|
2154
|
+
"$ref": "/message/v2/schemas/definitions/ReceivedDateTime"
|
|
2155
|
+
},
|
|
2156
|
+
"categorization": {
|
|
2157
|
+
"$ref": "/message/v2/schemas/definitions/Categorization"
|
|
2158
|
+
},
|
|
2159
|
+
"accounts": {
|
|
2160
|
+
"$ref": "/message/v2/schemas/definitions/Accounts"
|
|
2161
|
+
},
|
|
2162
|
+
"transactionAmount": {
|
|
2163
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2164
|
+
},
|
|
2165
|
+
"transactionFeeAmount": {
|
|
2166
|
+
"description": "Fee amount applied by the network or acquirer in the merchant's currency.\n",
|
|
2167
|
+
"allOf": [
|
|
2168
|
+
{
|
|
2169
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2170
|
+
}
|
|
2171
|
+
]
|
|
2172
|
+
},
|
|
2173
|
+
"settlementAmount": {
|
|
2174
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2175
|
+
},
|
|
2176
|
+
"settlementFeeAmount": {
|
|
2177
|
+
"description": "Fee amount applied by the network or acquirer in the BIN currency.\n",
|
|
2178
|
+
"allOf": [
|
|
2179
|
+
{
|
|
2180
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2181
|
+
}
|
|
2182
|
+
]
|
|
2183
|
+
},
|
|
2184
|
+
"cashBackAmount": {
|
|
2185
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2186
|
+
},
|
|
2187
|
+
"feeDetails": {
|
|
2188
|
+
"type": "array",
|
|
2189
|
+
"description": "Details about the fees that went into the transaction and settlement fee amounts",
|
|
2190
|
+
"items": {
|
|
2191
|
+
"$ref": "/message/v2/schemas/definitions/Fee"
|
|
2192
|
+
}
|
|
2193
|
+
},
|
|
2194
|
+
"settlementConversion": {
|
|
2195
|
+
"$ref": "/message/v2/schemas/definitions/SettlementConversion"
|
|
2196
|
+
},
|
|
2197
|
+
"transmissionDateTime": {
|
|
2198
|
+
"$ref": "/message/v2/schemas/definitions/TransmissionDateTime"
|
|
2199
|
+
},
|
|
2200
|
+
"systemTraceAuditNumber": {
|
|
2201
|
+
"$ref": "/message/v2/schemas/definitions/SystemTraceAuditNumber"
|
|
2202
|
+
},
|
|
2203
|
+
"acquirerLifecycleId": {
|
|
2204
|
+
"description": "This value is defined by the acquirer to uniquely identify a transaction through its lifecycle.\n",
|
|
2205
|
+
"type": "string"
|
|
2206
|
+
},
|
|
2207
|
+
"retrievalReferenceNumber": {
|
|
2208
|
+
"type": "string"
|
|
2209
|
+
},
|
|
2210
|
+
"acquirerReferenceData": {
|
|
2211
|
+
"description": "This value is a numeric string of data supplied by the acquirer in an acquirer-originated message.\n",
|
|
2212
|
+
"type": "string"
|
|
2213
|
+
},
|
|
2214
|
+
"settlementDate": {
|
|
2215
|
+
"type": "string",
|
|
2216
|
+
"description": "The date the funds are expected to be transferred between issuer and acquirer. \n\nThis is not guaranteed.\n",
|
|
2217
|
+
"format": "date",
|
|
2218
|
+
"example": "2020-01-01"
|
|
2219
|
+
},
|
|
2220
|
+
"captureDate": {
|
|
2221
|
+
"type": "string",
|
|
2222
|
+
"description": "The date the transaction was processed by the acquirer.\n",
|
|
2223
|
+
"format": "date",
|
|
2224
|
+
"example": "2020-01-01"
|
|
2225
|
+
},
|
|
2226
|
+
"encryptedKeys": {
|
|
2227
|
+
"description": "A list of encrypted data encryption keys.\n\nAll encrypted data in MessageRequest will be encrypted with same AES generated key.\nThe key will be encrypted with multiple public keys, one for each of the RSA key pairs that can decrypt it.\n",
|
|
2228
|
+
"minLength": 0,
|
|
2229
|
+
"type": "array",
|
|
2230
|
+
"items": {
|
|
2231
|
+
"$ref": "/message/v2/schemas/definitions/EncryptedKey"
|
|
2232
|
+
}
|
|
2233
|
+
},
|
|
2234
|
+
"merchant": {
|
|
2235
|
+
"$ref": "/message/v2/schemas/definitions/Merchant"
|
|
2236
|
+
},
|
|
2237
|
+
"acquirer": {
|
|
2238
|
+
"$ref": "/message/v2/schemas/definitions/Acquirer"
|
|
2239
|
+
},
|
|
2240
|
+
"authorizationLifeCycle": {
|
|
2241
|
+
"$ref": "/message/v2/schemas/definitions/AuthorizationLifeCycle"
|
|
2242
|
+
},
|
|
2243
|
+
"replacementAmounts": {
|
|
2244
|
+
"$ref": "/message/v2/schemas/definitions/ReplacementAmounts"
|
|
2245
|
+
},
|
|
2246
|
+
"network": {
|
|
2247
|
+
"$ref": "/message/v2/schemas/definitions/IssuerNetwork"
|
|
2248
|
+
},
|
|
2249
|
+
"acquirerNetwork": {
|
|
2250
|
+
"$ref": "/message/v2/schemas/definitions/AcquirerNetwork"
|
|
2251
|
+
},
|
|
2252
|
+
"file": {
|
|
2253
|
+
"$ref": "/message/v2/schemas/definitions/File"
|
|
2254
|
+
},
|
|
2255
|
+
"addressVerificationData": {
|
|
2256
|
+
"$ref": "/message/v2/schemas/definitions/AddressVerificationData"
|
|
2257
|
+
},
|
|
2258
|
+
"incremental": {
|
|
2259
|
+
"description": "Indicator whether this has been identified by the acquirer as an\nincremental authorization or not.\n",
|
|
2260
|
+
"type": "boolean"
|
|
2261
|
+
},
|
|
2262
|
+
"lastClearing": {
|
|
2263
|
+
"description": "Indicator whether this has been identified by the acquirer as\nthe last clearing in a sequence or not.\n",
|
|
2264
|
+
"type": "boolean"
|
|
2265
|
+
},
|
|
2266
|
+
"recurring": {
|
|
2267
|
+
"description": "Indicator whether this has been identified by the acquirer as a\nrecurring transaction or not.\n",
|
|
2268
|
+
"type": "boolean"
|
|
2269
|
+
},
|
|
2270
|
+
"iiasData": {
|
|
2271
|
+
"$ref": "/message/v2/schemas/definitions/IIASData"
|
|
2272
|
+
},
|
|
2273
|
+
"minimumTolerance": {
|
|
2274
|
+
"$ref": "/message/v2/schemas/definitions/Tolerance"
|
|
2275
|
+
},
|
|
2276
|
+
"tokenization": {
|
|
2277
|
+
"$ref": "/message/v2/schemas/definitions/TokenizationData"
|
|
2278
|
+
},
|
|
2279
|
+
"tokenNotification": {
|
|
2280
|
+
"$ref": "/message/v2/schemas/definitions/TokenNotificationData"
|
|
2281
|
+
},
|
|
2282
|
+
"emvChipData": {
|
|
2283
|
+
"$ref": "/message/v2/schemas/definitions/EMVChipData"
|
|
2284
|
+
},
|
|
2285
|
+
"emv3DSecureData": {
|
|
2286
|
+
"$ref": "/message/v2/schemas/definitions/EMV3DSecureData"
|
|
2287
|
+
},
|
|
2288
|
+
"adviceResponse": {
|
|
2289
|
+
"$ref": "/message/v2/schemas/definitions/AdviceResponse"
|
|
2290
|
+
},
|
|
2291
|
+
"suppliedCardExpirationDate": {
|
|
2292
|
+
"$ref": "/message/v2/schemas/definitions/SuppliedCardExpirationDate"
|
|
2293
|
+
},
|
|
2294
|
+
"track1ValidationResult": {
|
|
2295
|
+
"$ref": "/message/v2/schemas/definitions/TrackValidationResult"
|
|
2296
|
+
},
|
|
2297
|
+
"track2ValidationResult": {
|
|
2298
|
+
"$ref": "/message/v2/schemas/definitions/TrackValidationResult"
|
|
2299
|
+
},
|
|
2300
|
+
"pinValidationResult": {
|
|
2301
|
+
"$ref": "/message/v2/schemas/definitions/PINValidationResult"
|
|
2302
|
+
},
|
|
2303
|
+
"verificationValueValidationResult": {
|
|
2304
|
+
"description": "Corresponds to the CVC (Mastercard), CVV (Visa), or 5CSC (Amex) found in the track data and only supplied \nin card swipe transactions.\n",
|
|
2305
|
+
"allOf": [
|
|
2306
|
+
{
|
|
2307
|
+
"$ref": "/message/v2/schemas/definitions/VerificationValueResult"
|
|
2308
|
+
}
|
|
2309
|
+
]
|
|
2310
|
+
},
|
|
2311
|
+
"verificationValue2ValidationResult": {
|
|
2312
|
+
"description": "Corresponds to the CVC2 (Mastercard), CVV2 (Visa), or 4CSC (Amex) found on the back of the card for \nMastercard and Visa, and on the front of the card for Amex. \nIt is most often supplied in online transactions.\n",
|
|
2313
|
+
"allOf": [
|
|
2314
|
+
{
|
|
2315
|
+
"$ref": "/message/v2/schemas/definitions/VerificationValueResult"
|
|
2316
|
+
}
|
|
2317
|
+
]
|
|
2318
|
+
},
|
|
2319
|
+
"verificationValue3ValidationResult": {
|
|
2320
|
+
"description": "Corresponds to the 3CSC (Amex) found on the back of the card and is only used for Amex transactions.\n",
|
|
2321
|
+
"allOf": [
|
|
2322
|
+
{
|
|
2323
|
+
"$ref": "/message/v2/schemas/definitions/VerificationValueResult"
|
|
2324
|
+
}
|
|
2325
|
+
]
|
|
2326
|
+
},
|
|
2327
|
+
"dynamicVerificationValueValidationResult": {
|
|
2328
|
+
"$ref": "/message/v2/schemas/definitions/VerificationValueResult"
|
|
2329
|
+
},
|
|
2330
|
+
"arqcValidationResult": {
|
|
2331
|
+
"$ref": "/message/v2/schemas/definitions/ARQCValidationResult"
|
|
2332
|
+
},
|
|
2333
|
+
"emv3DSecureAuthenticationResult": {
|
|
2334
|
+
"$ref": "/message/v2/schemas/definitions/EMV3DSecureAuthenticationResult"
|
|
2335
|
+
}
|
|
2336
|
+
}
|
|
2337
|
+
},
|
|
2338
|
+
"EMV3DSecureData": {
|
|
2339
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2340
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/EMV3DSecureData",
|
|
2341
|
+
"description": "EMV 3-D Secure is a messaging protocol that enables consumers to authenticate themselves with their card issuer\nwhen making card-not-present (CNP) e-commerce purchases. The additional security layer helps prevent unauthorized CNP\ntransactions and protects the merchant from exposure to CNP fraud.\n",
|
|
2342
|
+
"oneOf": [
|
|
2343
|
+
{
|
|
2344
|
+
"$ref": "/message/v2/schemas/definitions/EMV3DSecureMastercard"
|
|
2345
|
+
}
|
|
2346
|
+
]
|
|
2347
|
+
},
|
|
2348
|
+
"EMV3DSecureMastercard": {
|
|
2349
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2350
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/EMV3DSecureMastercard",
|
|
2351
|
+
"type": "object",
|
|
2352
|
+
"required": [
|
|
2353
|
+
"network",
|
|
2354
|
+
"securityProtocol",
|
|
2355
|
+
"cardholderAuthentication",
|
|
2356
|
+
"ucafCollectionIndicator",
|
|
2357
|
+
"programProtocolIndicator",
|
|
2358
|
+
"cardholderAuthenticationFormat"
|
|
2359
|
+
],
|
|
2360
|
+
"properties": {
|
|
2361
|
+
"network": {
|
|
2362
|
+
"type": "string",
|
|
2363
|
+
"description": "This value indicates the network used for the transaction. This value also serves as the discriminator\nfor the EMV3DSecureData object.\n",
|
|
2364
|
+
"enum": ["MASTERCARD"]
|
|
2365
|
+
},
|
|
2366
|
+
"securityProtocol": {
|
|
2367
|
+
"type": "string",
|
|
2368
|
+
"enum": ["CHANNEL", "UNKNOWN", "NOT PROVIDED"]
|
|
2369
|
+
},
|
|
2370
|
+
"cardholderAuthentication": {
|
|
2371
|
+
"type": "string",
|
|
2372
|
+
"enum": ["CARDHOLDER CERTIFICATE NOT USED", "MASTERPASS", "TOKENIZED", "UNKNOWN", "NOT PROVIDED"]
|
|
2373
|
+
},
|
|
2374
|
+
"ucafCollectionIndicator": {
|
|
2375
|
+
"type": "string",
|
|
2376
|
+
"description": "This data describes the merchant support and issuer expectations \nregarding the Universal Cardholder Authentication Field (UCAF) and\nwhether Account Holder Authentication Value (AAV) data is present and authenticated.\n\n- NOT SUPPORTED may either indicate the merchant is not an Identity Check merchant, or the merchant is not \n an Identity Check merchant but UCAF data is present within the authorization. Chargeback rights \n exist in both cases.\n- UCAF MUST BE PRESENT indicates the merchant participates in Identity Check, but authentication was not \n completed. No chargeback rights exist for fraud.\n- UCAF MUST BE PRESENT AND AAV AUTHENTICATED indicates the merchant participates in Identity Check and was\n properly authenticated. No chargeback rights exist for fraud.\n- AAV PRESENT indicates the merchant participates in a program that exempts the merchant from using \n Identity Check for certain low-risk transactions. Chargeback rights exist.\n- ISSUER RISK BASED DECISIONING indicates the issuer has their own risk-based decisioning enabled to \n determine whether to authorize payment. No chargeback rights exist for fraud.\n- MERCHANT RISK BASED DECISIONING indicates the merchant has their own risk-based decisioning enabled to \n determine whether to accept payment. Chargeback rights exist.\n- PARTIAL SHIPMENT OR RECURRING PAYMENT indicates the merchant participates in Identity Check and was \n properly authenticated for a partial shipment or recurring payment. Refer to the UCAF or the \n original authorization to determine whether chargeback rights exist.\n",
|
|
2377
|
+
"enum": [
|
|
2378
|
+
"NOT SUPPORTED",
|
|
2379
|
+
"UCAF MUST BE PRESENT",
|
|
2380
|
+
"UCAF MUST BE PRESENT AND AAV AUTHENTICATED",
|
|
2381
|
+
"AAV PRESENT",
|
|
2382
|
+
"ISSUER RISK BASED DECISIONING",
|
|
2383
|
+
"MERCHANT RISK BASED DECISIONING",
|
|
2384
|
+
"PARTIAL SHIPMENT OR RECURRING PAYMENT",
|
|
2385
|
+
"UNKNOWN",
|
|
2386
|
+
"NOT PROVIDED"
|
|
2387
|
+
]
|
|
2388
|
+
},
|
|
2389
|
+
"programProtocolIndicator": {
|
|
2390
|
+
"type": "string",
|
|
2391
|
+
"enum": [
|
|
2392
|
+
"EMV 3-D SECURE VERSION 2.1",
|
|
2393
|
+
"EMV 3-D SECURE VERSION 2.2",
|
|
2394
|
+
"EMV 3-D SECURE VERSION 2.3",
|
|
2395
|
+
"EMV 3-D SECURE VERSION 2.4",
|
|
2396
|
+
"EMV 3-D SECURE VERSION 2.5",
|
|
2397
|
+
"EMV 3-D SECURE VERSION 2.6",
|
|
2398
|
+
"EMV 3-D SECURE VERSION 2.7",
|
|
2399
|
+
"EMV 3-D SECURE VERSION 2.8",
|
|
2400
|
+
"EMV 3-D SECURE VERSION 2.9",
|
|
2401
|
+
"UNKNOWN",
|
|
2402
|
+
"NOT PROVIDED"
|
|
2403
|
+
]
|
|
2404
|
+
},
|
|
2405
|
+
"cardholderAuthenticationFormat": {
|
|
2406
|
+
"type": "string",
|
|
2407
|
+
"enum": ["SECURE CODE", "SECURE CODE FOR AAV", "UNKNOWN", "NOT PROVIDED"]
|
|
2408
|
+
},
|
|
2409
|
+
"universalCardholderAuthenticationField": {
|
|
2410
|
+
"type": "string",
|
|
2411
|
+
"description": "The Universal Cardholder Authentication Field (UCAF) is a data element that is used to convey\ncardholder authentication data from the merchant to the issuer.\n"
|
|
2412
|
+
}
|
|
2413
|
+
}
|
|
2414
|
+
},
|
|
2415
|
+
"MessageId": {
|
|
2416
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2417
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/MessageId",
|
|
2418
|
+
"description": "Uniquely identifies a message stored in the platform.\n\nA message's request and response are stored and retrieved separately using this identifier.\n",
|
|
2419
|
+
"type": "string"
|
|
2420
|
+
},
|
|
2421
|
+
"MatchedMessageId": {
|
|
2422
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2423
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/MatchedMessageId",
|
|
2424
|
+
"description": "A previously processed message possibly related to this message as determined by the matching algorithm.\n",
|
|
2425
|
+
"allOf": [
|
|
2426
|
+
{
|
|
2427
|
+
"$ref": "/message/v2/schemas/definitions/MessageId"
|
|
2428
|
+
}
|
|
2429
|
+
]
|
|
2430
|
+
},
|
|
2431
|
+
"CardId": {
|
|
2432
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2433
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/CardId",
|
|
2434
|
+
"description": "Uniquely identifies a payment card stored in the platform.\n",
|
|
2435
|
+
"type": "string"
|
|
2436
|
+
},
|
|
2437
|
+
"TokenId": {
|
|
2438
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2439
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/TokenId",
|
|
2440
|
+
"description": "Uniquely identifies a token stored in the platform.\n\nA token is a unique, secure replacement for a primary account number (PAN) used in digital payment transactions (e.g. transactions made using Apple Pay).\n",
|
|
2441
|
+
"type": "string"
|
|
2442
|
+
},
|
|
2443
|
+
"ReceivedDateTime": {
|
|
2444
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2445
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ReceivedDateTime",
|
|
2446
|
+
"type": "string",
|
|
2447
|
+
"format": "date-time",
|
|
2448
|
+
"description": "The UTC datetime the message was received from the network by the platform."
|
|
2449
|
+
},
|
|
2450
|
+
"CreatedOn": {
|
|
2451
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2452
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/CreatedOn",
|
|
2453
|
+
"type": "string",
|
|
2454
|
+
"format": "date-time",
|
|
2455
|
+
"description": "The UTC datetime the message was created in the platform."
|
|
2456
|
+
},
|
|
2457
|
+
"Request": {
|
|
2458
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2459
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Request",
|
|
2460
|
+
"type": "object",
|
|
2461
|
+
"additionalProperties": false,
|
|
2462
|
+
"required": [
|
|
2463
|
+
"messageId",
|
|
2464
|
+
"cardId",
|
|
2465
|
+
"transactionId",
|
|
2466
|
+
"transactionGroupId",
|
|
2467
|
+
"receivedDateTime",
|
|
2468
|
+
"categorization",
|
|
2469
|
+
"accounts",
|
|
2470
|
+
"transactionAmount",
|
|
2471
|
+
"transactionFeeAmount",
|
|
2472
|
+
"settlementAmount",
|
|
2473
|
+
"settlementFeeAmount",
|
|
2474
|
+
"settlementConversion",
|
|
2475
|
+
"cashBackAmount",
|
|
2476
|
+
"feeDetails",
|
|
2477
|
+
"transmissionDateTime",
|
|
2478
|
+
"systemTraceAuditNumber",
|
|
2479
|
+
"retrievalReferenceNumber",
|
|
2480
|
+
"settlementDate",
|
|
2481
|
+
"captureDate",
|
|
2482
|
+
"encryptedKeys",
|
|
2483
|
+
"merchant",
|
|
2484
|
+
"acquirer",
|
|
2485
|
+
"network",
|
|
2486
|
+
"acquirerNetwork",
|
|
2487
|
+
"incremental",
|
|
2488
|
+
"lastClearing",
|
|
2489
|
+
"recurring",
|
|
2490
|
+
"minimumTolerance",
|
|
2491
|
+
"track1ValidationResult",
|
|
2492
|
+
"track2ValidationResult",
|
|
2493
|
+
"pinValidationResult",
|
|
2494
|
+
"suppliedCardExpirationDate",
|
|
2495
|
+
"verificationValueValidationResult",
|
|
2496
|
+
"verificationValue2ValidationResult",
|
|
2497
|
+
"verificationValue3ValidationResult",
|
|
2498
|
+
"dynamicVerificationValueValidationResult",
|
|
2499
|
+
"arqcValidationResult",
|
|
2500
|
+
"emv3DSecureAuthenticationResult",
|
|
2501
|
+
"createdOn"
|
|
2502
|
+
],
|
|
2503
|
+
"description": "The stored request data received from the network to be processed.",
|
|
2504
|
+
"properties": {
|
|
2505
|
+
"messageId": {
|
|
2506
|
+
"$ref": "/message/v2/schemas/definitions/MessageId"
|
|
2507
|
+
},
|
|
2508
|
+
"cardId": {
|
|
2509
|
+
"$ref": "/message/v2/schemas/definitions/CardId"
|
|
2510
|
+
},
|
|
2511
|
+
"tokenId": {
|
|
2512
|
+
"$ref": "/message/v2/schemas/definitions/TokenId"
|
|
2513
|
+
},
|
|
2514
|
+
"transactionId": {
|
|
2515
|
+
"$ref": "/message/v2/schemas/definitions/TransactionId"
|
|
2516
|
+
},
|
|
2517
|
+
"transactionGroupId": {
|
|
2518
|
+
"$ref": "/message/v2/schemas/definitions/TransactionGroupId"
|
|
2519
|
+
},
|
|
2520
|
+
"matchedMessageId": {
|
|
2521
|
+
"$ref": "/message/v2/schemas/definitions/MatchedMessageId"
|
|
2522
|
+
},
|
|
2523
|
+
"receivedDateTime": {
|
|
2524
|
+
"$ref": "/message/v2/schemas/definitions/ReceivedDateTime"
|
|
2525
|
+
},
|
|
2526
|
+
"categorization": {
|
|
2527
|
+
"$ref": "/message/v2/schemas/definitions/Categorization"
|
|
2528
|
+
},
|
|
2529
|
+
"accounts": {
|
|
2530
|
+
"$ref": "/message/v2/schemas/definitions/Accounts"
|
|
2531
|
+
},
|
|
2532
|
+
"transactionAmount": {
|
|
2533
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2534
|
+
},
|
|
2535
|
+
"transactionFeeAmount": {
|
|
2536
|
+
"description": "Fee amount applied by the network or acquirer in the merchant's currency.\n",
|
|
2537
|
+
"allOf": [
|
|
2538
|
+
{
|
|
2539
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2540
|
+
}
|
|
2541
|
+
]
|
|
2542
|
+
},
|
|
2543
|
+
"settlementAmount": {
|
|
2544
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2545
|
+
},
|
|
2546
|
+
"settlementFeeAmount": {
|
|
2547
|
+
"description": "Fee amount applied by the network or acquirer in the BIN currency.\n",
|
|
2548
|
+
"allOf": [
|
|
2549
|
+
{
|
|
2550
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2551
|
+
}
|
|
2552
|
+
]
|
|
2553
|
+
},
|
|
2554
|
+
"cashBackAmount": {
|
|
2555
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2556
|
+
},
|
|
2557
|
+
"feeDetails": {
|
|
2558
|
+
"type": "array",
|
|
2559
|
+
"description": "Details about the fees that went into the transaction and settlement fee amounts",
|
|
2560
|
+
"items": {
|
|
2561
|
+
"$ref": "/message/v2/schemas/definitions/Fee"
|
|
2562
|
+
}
|
|
2563
|
+
},
|
|
2564
|
+
"settlementConversion": {
|
|
2565
|
+
"$ref": "/message/v2/schemas/definitions/SettlementConversion"
|
|
2566
|
+
},
|
|
2567
|
+
"transmissionDateTime": {
|
|
2568
|
+
"$ref": "/message/v2/schemas/definitions/TransmissionDateTime"
|
|
2569
|
+
},
|
|
2570
|
+
"systemTraceAuditNumber": {
|
|
2571
|
+
"$ref": "/message/v2/schemas/definitions/SystemTraceAuditNumber"
|
|
2572
|
+
},
|
|
2573
|
+
"acquirerLifecycleId": {
|
|
2574
|
+
"description": "Defined by the acquirer to identify a transaction through its lifecycle.\n",
|
|
2575
|
+
"type": "string"
|
|
2576
|
+
},
|
|
2577
|
+
"retrievalReferenceNumber": {
|
|
2578
|
+
"type": "string",
|
|
2579
|
+
"description": "A numeric identifier typically generated by the acquirer to uniquely identify a transaction on a given day.\n"
|
|
2580
|
+
},
|
|
2581
|
+
"acquirerReferenceData": {
|
|
2582
|
+
"description": "This value is a numeric string of data supplied by the acquirer in an acquirer-originated message.\n",
|
|
2583
|
+
"type": "string"
|
|
2584
|
+
},
|
|
2585
|
+
"settlementDate": {
|
|
2586
|
+
"type": "string",
|
|
2587
|
+
"description": "The date the funds are expected to be transferred between issuer and acquirer. \n\nThis is not guaranteed.\n",
|
|
2588
|
+
"format": "date",
|
|
2589
|
+
"example": "2020-01-01"
|
|
2590
|
+
},
|
|
2591
|
+
"captureDate": {
|
|
2592
|
+
"type": "string",
|
|
2593
|
+
"description": "The date the transaction was processed by the acquirer.\n",
|
|
2594
|
+
"format": "date",
|
|
2595
|
+
"example": "2020-01-01"
|
|
2596
|
+
},
|
|
2597
|
+
"encryptedKeys": {
|
|
2598
|
+
"description": "An array of encrypted AES keys that can be decrypted using the appropriate private key.",
|
|
2599
|
+
"minLength": 0,
|
|
2600
|
+
"type": "array",
|
|
2601
|
+
"items": {
|
|
2602
|
+
"$ref": "/message/v2/schemas/definitions/EncryptedKey"
|
|
2603
|
+
}
|
|
2604
|
+
},
|
|
2605
|
+
"merchant": {
|
|
2606
|
+
"$ref": "/message/v2/schemas/definitions/Merchant"
|
|
2607
|
+
},
|
|
2608
|
+
"acquirer": {
|
|
2609
|
+
"$ref": "/message/v2/schemas/definitions/Acquirer"
|
|
2610
|
+
},
|
|
2611
|
+
"authorizationLifeCycle": {
|
|
2612
|
+
"$ref": "/message/v2/schemas/definitions/AuthorizationLifeCycle"
|
|
2613
|
+
},
|
|
2614
|
+
"replacementAmounts": {
|
|
2615
|
+
"$ref": "/message/v2/schemas/definitions/ReplacementAmounts"
|
|
2616
|
+
},
|
|
2617
|
+
"network": {
|
|
2618
|
+
"$ref": "/message/v2/schemas/definitions/IssuerNetwork"
|
|
2619
|
+
},
|
|
2620
|
+
"acquirerNetwork": {
|
|
2621
|
+
"$ref": "/message/v2/schemas/definitions/AcquirerNetwork"
|
|
2622
|
+
},
|
|
2623
|
+
"file": {
|
|
2624
|
+
"$ref": "/message/v2/schemas/definitions/File"
|
|
2625
|
+
},
|
|
2626
|
+
"addressVerificationData": {
|
|
2627
|
+
"$ref": "/message/v2/schemas/definitions/AddressVerificationData"
|
|
2628
|
+
},
|
|
2629
|
+
"incremental": {
|
|
2630
|
+
"description": "Has the value 'true' if the acquirer identified the authorization as an incremental, otherwise the value\nis 'false'.\n",
|
|
2631
|
+
"type": "boolean"
|
|
2632
|
+
},
|
|
2633
|
+
"lastClearing": {
|
|
2634
|
+
"description": "Has the value 'true' if the acquirer identified the message as the last clearing in a sequence, otherwise\nthe value is 'false'.\n",
|
|
2635
|
+
"type": "boolean"
|
|
2636
|
+
},
|
|
2637
|
+
"recurring": {
|
|
2638
|
+
"description": "Has the value 'true' if the acquirer identified the message as part of a recurring transaction, otherwise\nthe value is 'false'.\n",
|
|
2639
|
+
"type": "boolean"
|
|
2640
|
+
},
|
|
2641
|
+
"iiasData": {
|
|
2642
|
+
"$ref": "/message/v2/schemas/definitions/IIASData"
|
|
2643
|
+
},
|
|
2644
|
+
"minimumTolerance": {
|
|
2645
|
+
"$ref": "/message/v2/schemas/definitions/Tolerance"
|
|
2646
|
+
},
|
|
2647
|
+
"tokenization": {
|
|
2648
|
+
"$ref": "/message/v2/schemas/definitions/TokenizationData"
|
|
2649
|
+
},
|
|
2650
|
+
"tokenNotification": {
|
|
2651
|
+
"$ref": "/message/v2/schemas/definitions/TokenNotificationData"
|
|
2652
|
+
},
|
|
2653
|
+
"emvChipData": {
|
|
2654
|
+
"$ref": "/message/v2/schemas/definitions/EMVChipData"
|
|
2655
|
+
},
|
|
2656
|
+
"emv3DSecureData": {
|
|
2657
|
+
"$ref": "/message/v2/schemas/definitions/EMV3DSecureData"
|
|
2658
|
+
},
|
|
2659
|
+
"adviceResponse": {
|
|
2660
|
+
"$ref": "/message/v2/schemas/definitions/AdviceResponse"
|
|
2661
|
+
},
|
|
2662
|
+
"suppliedCardExpirationDate": {
|
|
2663
|
+
"$ref": "/message/v2/schemas/definitions/SuppliedCardExpirationDate"
|
|
2664
|
+
},
|
|
2665
|
+
"track1ValidationResult": {
|
|
2666
|
+
"$ref": "/message/v2/schemas/definitions/TrackValidationResult"
|
|
2667
|
+
},
|
|
2668
|
+
"track2ValidationResult": {
|
|
2669
|
+
"$ref": "/message/v2/schemas/definitions/TrackValidationResult"
|
|
2670
|
+
},
|
|
2671
|
+
"pinValidationResult": {
|
|
2672
|
+
"$ref": "/message/v2/schemas/definitions/PINValidationResult"
|
|
2673
|
+
},
|
|
2674
|
+
"verificationValueValidationResult": {
|
|
2675
|
+
"$ref": "/message/v2/schemas/definitions/VerificationValueResult"
|
|
2676
|
+
},
|
|
2677
|
+
"verificationValue2ValidationResult": {
|
|
2678
|
+
"$ref": "/message/v2/schemas/definitions/VerificationValueResult"
|
|
2679
|
+
},
|
|
2680
|
+
"verificationValue3ValidationResult": {
|
|
2681
|
+
"$ref": "/message/v2/schemas/definitions/VerificationValueResult"
|
|
2682
|
+
},
|
|
2683
|
+
"dynamicVerificationValueValidationResult": {
|
|
2684
|
+
"$ref": "/message/v2/schemas/definitions/VerificationValueResult"
|
|
2685
|
+
},
|
|
2686
|
+
"arqcValidationResult": {
|
|
2687
|
+
"$ref": "/message/v2/schemas/definitions/ARQCValidationResult"
|
|
2688
|
+
},
|
|
2689
|
+
"emv3DSecureAuthenticationResult": {
|
|
2690
|
+
"$ref": "/message/v2/schemas/definitions/EMV3DSecureAuthenticationResult"
|
|
2691
|
+
},
|
|
2692
|
+
"createdOn": {
|
|
2693
|
+
"$ref": "/message/v2/schemas/definitions/CreatedOn"
|
|
2694
|
+
}
|
|
2695
|
+
}
|
|
2696
|
+
},
|
|
2697
|
+
"PickedRequest": {
|
|
2698
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2699
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/PickedRequest",
|
|
2700
|
+
"type": "object",
|
|
2701
|
+
"additionalProperties": false,
|
|
2702
|
+
"description": "A PickedRequest object contains a subset of fields from a Request object. \n\nA PickedRequest object may be preferred to minimize the amount of data retrieved and the time taken to \ntransmit and process the response.\n",
|
|
2703
|
+
"required": ["createdOn"],
|
|
2704
|
+
"properties": {
|
|
2705
|
+
"cardId": {
|
|
2706
|
+
"$ref": "/message/v2/schemas/definitions/CardId"
|
|
2707
|
+
},
|
|
2708
|
+
"messageId": {
|
|
2709
|
+
"$ref": "/message/v2/schemas/definitions/MessageId"
|
|
2710
|
+
},
|
|
2711
|
+
"matchedMessageId": {
|
|
2712
|
+
"$ref": "/message/v2/schemas/definitions/MatchedMessageId"
|
|
2713
|
+
},
|
|
2714
|
+
"receivedDateTime": {
|
|
2715
|
+
"$ref": "/message/v2/schemas/definitions/ReceivedDateTime"
|
|
2716
|
+
},
|
|
2717
|
+
"categorization": {
|
|
2718
|
+
"$ref": "/message/v2/schemas/definitions/Categorization"
|
|
2719
|
+
},
|
|
2720
|
+
"settlementAmount": {
|
|
2721
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
2722
|
+
},
|
|
2723
|
+
"adviceResponse": {
|
|
2724
|
+
"$ref": "/message/v2/schemas/definitions/AdviceResponse"
|
|
2725
|
+
},
|
|
2726
|
+
"createdOn": {
|
|
2727
|
+
"$ref": "/message/v2/schemas/definitions/CreatedOn"
|
|
2728
|
+
}
|
|
2729
|
+
}
|
|
2730
|
+
},
|
|
2731
|
+
"Tag": {
|
|
2732
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2733
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Tag",
|
|
2734
|
+
"type": "object",
|
|
2735
|
+
"additionalProperties": false,
|
|
2736
|
+
"description": "A Tag object contains categorizing information that can be used to classify a transaction and determine max\nspend amounts for a given tag.\n",
|
|
2737
|
+
"required": ["tag", "maxAmount"],
|
|
2738
|
+
"properties": {
|
|
2739
|
+
"tag": {
|
|
2740
|
+
"type": "string",
|
|
2741
|
+
"description": "The tag name."
|
|
2742
|
+
},
|
|
2743
|
+
"maxAmount": {
|
|
2744
|
+
"type": "string",
|
|
2745
|
+
"description": "Maximum amount that can be approved for the tag."
|
|
2746
|
+
}
|
|
2747
|
+
}
|
|
2748
|
+
},
|
|
2749
|
+
"DeclineReasonsEnum": {
|
|
2750
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2751
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/DeclineReasonsEnum",
|
|
2752
|
+
"type": "string",
|
|
2753
|
+
"description": "The reason for the decline.",
|
|
2754
|
+
"enum": [
|
|
2755
|
+
"TRANSACTION CATEGORY NOT ALLOWED",
|
|
2756
|
+
"INTERNATIONAL TRANSACTIONS NOT ALLOWED",
|
|
2757
|
+
"RESTRICTED COUNTRY",
|
|
2758
|
+
"RESTRICTED MERCHANT TYPE",
|
|
2759
|
+
"RESTRICTED MERCHANT",
|
|
2760
|
+
"INVALID PIN",
|
|
2761
|
+
"PIN BLOCK ERROR",
|
|
2762
|
+
"PIN VALIDATION UNAVAILABLE",
|
|
2763
|
+
"INVALID VERIFICATION VALUE",
|
|
2764
|
+
"INVALID VERIFICATION VALUE2",
|
|
2765
|
+
"INVALID VERIFICATION VALUE3",
|
|
2766
|
+
"INVALID DYNAMIC VERIFICATION VALUE",
|
|
2767
|
+
"INVALID ATC",
|
|
2768
|
+
"INVALID ARQC",
|
|
2769
|
+
"NO CVN SUPPLIED",
|
|
2770
|
+
"VERIFICATION VALUE VALIDATION UNAVAILABLE",
|
|
2771
|
+
"VERIFICATION VALUE2 VALIDATION UNAVAILABLE",
|
|
2772
|
+
"VERIFICATION VALUE3 VALIDATION UNAVAILABLE",
|
|
2773
|
+
"DYNAMIC VERIFICATION VALUE VALIDATION UNAVAILABLE",
|
|
2774
|
+
"ARQC VALIDATION UNAVAILABLE",
|
|
2775
|
+
"CARD NOT FOUND",
|
|
2776
|
+
"CARD NOT CURRENT",
|
|
2777
|
+
"EXPIRED CARD",
|
|
2778
|
+
"BLOCKED CARD",
|
|
2779
|
+
"LOCKED CARD",
|
|
2780
|
+
"INACTIVE CARD",
|
|
2781
|
+
"INVALID CARD DATA",
|
|
2782
|
+
"UNSUPPORTED OPERATION",
|
|
2783
|
+
"INSUFFICIENT FUNDS",
|
|
2784
|
+
"AMOUNT LIMIT EXCEEDED",
|
|
2785
|
+
"COUNT LIMIT EXCEEDED",
|
|
2786
|
+
"MINIMUM AMOUNT REQUIRED",
|
|
2787
|
+
"PIN RETRY LIMIT EXCEEDED",
|
|
2788
|
+
"BUSINESS RULES",
|
|
2789
|
+
"SUSPECTED FRAUD",
|
|
2790
|
+
"INVALID ACCOUNT SELECTED",
|
|
2791
|
+
"INVALID MESSAGE DATA",
|
|
2792
|
+
"STOP RECURRING",
|
|
2793
|
+
"GENERAL DECLINE",
|
|
2794
|
+
"INCORRECT ACTIVATION CODE",
|
|
2795
|
+
"INCORRECT ACTIVATION CODE RETRIES EXCEEDED",
|
|
2796
|
+
"EXPIRED ACTIVATION CODE",
|
|
2797
|
+
"REQUIRE ADDITIONAL AUTHENTICATION",
|
|
2798
|
+
"WALLET RECOMMENDED DECLINE",
|
|
2799
|
+
"INTERNAL SERVICE ERROR",
|
|
2800
|
+
"TRANSIENT RETRYABLE ERROR",
|
|
2801
|
+
"CONFIGURATION LOCK"
|
|
2802
|
+
]
|
|
2803
|
+
},
|
|
2804
|
+
"HoldExpirationDateTime": {
|
|
2805
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2806
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/HoldExpirationDateTime",
|
|
2807
|
+
"type": "string",
|
|
2808
|
+
"description": "The UTC datetime the hold on funds will expire.",
|
|
2809
|
+
"format": "date-time"
|
|
2810
|
+
},
|
|
2811
|
+
"ProprietaryAuxiliaryData": {
|
|
2812
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2813
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ProprietaryAuxiliaryData",
|
|
2814
|
+
"type": "object",
|
|
2815
|
+
"description": "An object containing client specific data."
|
|
2816
|
+
},
|
|
2817
|
+
"AccountUsage": {
|
|
2818
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2819
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/AccountUsage",
|
|
2820
|
+
"type": "object",
|
|
2821
|
+
"additionalProperties": false,
|
|
2822
|
+
"required": ["accountId", "debitCredit", "amount"],
|
|
2823
|
+
"properties": {
|
|
2824
|
+
"accountId": {
|
|
2825
|
+
"type": "string",
|
|
2826
|
+
"description": "Uniquely identifies the account to which the amount and debit or credit were applied."
|
|
2827
|
+
},
|
|
2828
|
+
"debitCredit": {
|
|
2829
|
+
"$ref": "/message/v2/schemas/definitions/DebitCredit"
|
|
2830
|
+
},
|
|
2831
|
+
"amount": {
|
|
2832
|
+
"type": "string"
|
|
2833
|
+
}
|
|
2834
|
+
}
|
|
2835
|
+
},
|
|
2836
|
+
"CurrencyAlphabeticCode": {
|
|
2837
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
2838
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/CurrencyAlphabeticCode",
|
|
2839
|
+
"type": "string",
|
|
2840
|
+
"description": "The alphabetic code that represents the currency.\n",
|
|
2841
|
+
"enum": [
|
|
2842
|
+
"AED",
|
|
2843
|
+
"AFN",
|
|
2844
|
+
"ALL",
|
|
2845
|
+
"AMD",
|
|
2846
|
+
"ANG",
|
|
2847
|
+
"AOA",
|
|
2848
|
+
"ARS",
|
|
2849
|
+
"AUD",
|
|
2850
|
+
"AWG",
|
|
2851
|
+
"AZN",
|
|
2852
|
+
"BAM",
|
|
2853
|
+
"BBD",
|
|
2854
|
+
"BDT",
|
|
2855
|
+
"BGN",
|
|
2856
|
+
"BHD",
|
|
2857
|
+
"BIF",
|
|
2858
|
+
"BMD",
|
|
2859
|
+
"BND",
|
|
2860
|
+
"BOB",
|
|
2861
|
+
"BOV",
|
|
2862
|
+
"BRL",
|
|
2863
|
+
"BSD",
|
|
2864
|
+
"BTN",
|
|
2865
|
+
"BWP",
|
|
2866
|
+
"BYN",
|
|
2867
|
+
"BZD",
|
|
2868
|
+
"CAD",
|
|
2869
|
+
"CDF",
|
|
2870
|
+
"CHE",
|
|
2871
|
+
"CHF",
|
|
2872
|
+
"CHW",
|
|
2873
|
+
"CLF",
|
|
2874
|
+
"CLP",
|
|
2875
|
+
"CNY",
|
|
2876
|
+
"COP",
|
|
2877
|
+
"COU",
|
|
2878
|
+
"CRC",
|
|
2879
|
+
"CUC",
|
|
2880
|
+
"CUP",
|
|
2881
|
+
"CVE",
|
|
2882
|
+
"CZK",
|
|
2883
|
+
"DJF",
|
|
2884
|
+
"DKK",
|
|
2885
|
+
"DOP",
|
|
2886
|
+
"DZD",
|
|
2887
|
+
"EGP",
|
|
2888
|
+
"ERN",
|
|
2889
|
+
"ETB",
|
|
2890
|
+
"EUR",
|
|
2891
|
+
"FJD",
|
|
2892
|
+
"FKP",
|
|
2893
|
+
"GBP",
|
|
2894
|
+
"GEL",
|
|
2895
|
+
"GHS",
|
|
2896
|
+
"GIP",
|
|
2897
|
+
"GMD",
|
|
2898
|
+
"GNF",
|
|
2899
|
+
"GTQ",
|
|
2900
|
+
"GYD",
|
|
2901
|
+
"HKD",
|
|
2902
|
+
"HNL",
|
|
2903
|
+
"HRK",
|
|
2904
|
+
"HTG",
|
|
2905
|
+
"HUF",
|
|
2906
|
+
"IDR",
|
|
2907
|
+
"ILS",
|
|
2908
|
+
"INR",
|
|
2909
|
+
"IQD",
|
|
2910
|
+
"IRR",
|
|
2911
|
+
"ISK",
|
|
2912
|
+
"JMD",
|
|
2913
|
+
"JOD",
|
|
2914
|
+
"JPY",
|
|
2915
|
+
"KES",
|
|
2916
|
+
"KGS",
|
|
2917
|
+
"KHR",
|
|
2918
|
+
"KMF",
|
|
2919
|
+
"KPW",
|
|
2920
|
+
"KRW",
|
|
2921
|
+
"KWD",
|
|
2922
|
+
"KYD",
|
|
2923
|
+
"KZT",
|
|
2924
|
+
"LAK",
|
|
2925
|
+
"LBP",
|
|
2926
|
+
"LKR",
|
|
2927
|
+
"LRD",
|
|
2928
|
+
"LSL",
|
|
2929
|
+
"LYD",
|
|
2930
|
+
"MAD",
|
|
2931
|
+
"MDL",
|
|
2932
|
+
"MGA",
|
|
2933
|
+
"MKD",
|
|
2934
|
+
"MMK",
|
|
2935
|
+
"MNT",
|
|
2936
|
+
"MOP",
|
|
2937
|
+
"MRU",
|
|
2938
|
+
"MUR",
|
|
2939
|
+
"MVR",
|
|
2940
|
+
"MWK",
|
|
2941
|
+
"MXN",
|
|
2942
|
+
"MXV",
|
|
2943
|
+
"MYR",
|
|
2944
|
+
"MZN",
|
|
2945
|
+
"NAD",
|
|
2946
|
+
"NGN",
|
|
2947
|
+
"NIO",
|
|
2948
|
+
"NOK",
|
|
2949
|
+
"NPR",
|
|
2950
|
+
"NZD",
|
|
2951
|
+
"OMR",
|
|
2952
|
+
"PAB",
|
|
2953
|
+
"PEN",
|
|
2954
|
+
"PGK",
|
|
2955
|
+
"PHP",
|
|
2956
|
+
"PKR",
|
|
2957
|
+
"PLN",
|
|
2958
|
+
"PYG",
|
|
2959
|
+
"QAR",
|
|
2960
|
+
"RON",
|
|
2961
|
+
"RSD",
|
|
2962
|
+
"RUB",
|
|
2963
|
+
"RWF",
|
|
2964
|
+
"SAR",
|
|
2965
|
+
"SBD",
|
|
2966
|
+
"SCR",
|
|
2967
|
+
"SDG",
|
|
2968
|
+
"SEK",
|
|
2969
|
+
"SGD",
|
|
2970
|
+
"SHP",
|
|
2971
|
+
"SLL",
|
|
2972
|
+
"SOS",
|
|
2973
|
+
"SRD",
|
|
2974
|
+
"SSP",
|
|
2975
|
+
"STN",
|
|
2976
|
+
"SVC",
|
|
2977
|
+
"SYP",
|
|
2978
|
+
"SZL",
|
|
2979
|
+
"THB",
|
|
2980
|
+
"TJS",
|
|
2981
|
+
"TMT",
|
|
2982
|
+
"TND",
|
|
2983
|
+
"TOP",
|
|
2984
|
+
"TRY",
|
|
2985
|
+
"TTD",
|
|
2986
|
+
"TWD",
|
|
2987
|
+
"TZS",
|
|
2988
|
+
"UAH",
|
|
2989
|
+
"UGX",
|
|
2990
|
+
"USD",
|
|
2991
|
+
"USN",
|
|
2992
|
+
"UYI",
|
|
2993
|
+
"UYU",
|
|
2994
|
+
"UYW",
|
|
2995
|
+
"UZS",
|
|
2996
|
+
"VES",
|
|
2997
|
+
"VND",
|
|
2998
|
+
"VUV",
|
|
2999
|
+
"WST",
|
|
3000
|
+
"XAF",
|
|
3001
|
+
"XAG",
|
|
3002
|
+
"XAU",
|
|
3003
|
+
"XBA",
|
|
3004
|
+
"XBB",
|
|
3005
|
+
"XBC",
|
|
3006
|
+
"XBD",
|
|
3007
|
+
"XCD",
|
|
3008
|
+
"XDR",
|
|
3009
|
+
"XOF",
|
|
3010
|
+
"XPD",
|
|
3011
|
+
"XPF",
|
|
3012
|
+
"XPT",
|
|
3013
|
+
"XSU",
|
|
3014
|
+
"XTS",
|
|
3015
|
+
"XUA",
|
|
3016
|
+
"XXX",
|
|
3017
|
+
"YER",
|
|
3018
|
+
"ZAR",
|
|
3019
|
+
"ZMW",
|
|
3020
|
+
"ZWL"
|
|
3021
|
+
]
|
|
3022
|
+
},
|
|
3023
|
+
"Rate": {
|
|
3024
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3025
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Rate",
|
|
3026
|
+
"type": "object",
|
|
3027
|
+
"description": "The currency conversion rate information.\n \nTo calculate the conversion rate, use the following formula:\n\n conversion rate = factor / (10 ^ factorDecimalPosition)\n",
|
|
3028
|
+
"additionalProperties": false,
|
|
3029
|
+
"required": ["factor", "factorDecimalPosition", "effectiveOn"],
|
|
3030
|
+
"properties": {
|
|
3031
|
+
"factor": {
|
|
3032
|
+
"description": "The multiplying factor used to convert the transaction amount to the settlement\namount.\n",
|
|
3033
|
+
"type": "string"
|
|
3034
|
+
},
|
|
3035
|
+
"factorDecimalPosition": {
|
|
3036
|
+
"description": "The position the decimal point should be placed, starting from the right.\n",
|
|
3037
|
+
"type": "number",
|
|
3038
|
+
"minimum": 0,
|
|
3039
|
+
"maximum": 15
|
|
3040
|
+
},
|
|
3041
|
+
"effectiveOn": {
|
|
3042
|
+
"type": "string",
|
|
3043
|
+
"description": "The UTC datetime the conversion rate went into effect.",
|
|
3044
|
+
"format": "date-time"
|
|
3045
|
+
}
|
|
3046
|
+
}
|
|
3047
|
+
},
|
|
3048
|
+
"AdditionalCurrencyConversionRate": {
|
|
3049
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3050
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/AdditionalCurrencyConversionRate",
|
|
3051
|
+
"type": "object",
|
|
3052
|
+
"description": "Contains the conversion rate from the settlement currency to a target currency that was in effect when processing this message.\nThe value can be obtained in one of four ways and will be represented by the conversionSource field.\n",
|
|
3053
|
+
"additionalProperties": false,
|
|
3054
|
+
"required": ["rate", "conversionSource", "targetCurrency"],
|
|
3055
|
+
"properties": {
|
|
3056
|
+
"rate": {
|
|
3057
|
+
"$ref": "/message/v2/schemas/definitions/Rate"
|
|
3058
|
+
},
|
|
3059
|
+
"conversionSource": {
|
|
3060
|
+
"type": "string",
|
|
3061
|
+
"description": "- NONE\n - The target currency matches the settlement currency.\n - The rate will be 1.0\n - example scenario: Settlement Currency = USD, Target Currency = USD, Transaction Currency = EUR\n- NETWORK\n - The target currency matches the message's transaction currency.\n - The rate will be the inverse of the settlementConversion data provided by the network.\n - example scenario: Settlement Currency = USD, Target Currency = EUR, Transaction Currency = EUR\n- INTERNAL\n - The target currency does not match the settlement or transaction currency and a settlement to target currency conversion rate is defined within the Rate service at the time of the transaction.\n - The rate will be the settlement to target currency rate retrieved from the rate service at the time of the transaction.\n - example scenario: Settlement Currency = USD, Target Currency = EUR, Transaction Currency = GBP, Rate from USD -> EUR is defined within the Rate service at the time of the transaction\n- NOT FOUND\n - The target currency does not match the settlement or transaction currency and no settlement to target currency rate is defined within the Rate service at the time of the transaction.\n - The rate will be 0.0\n - example scenario: Settlement Currency = USD, Target Currency = EUR, Transaction Currency = GBP, Rate from USD -> EUR is NOT defined within the Rate service at the time of the transaction\n- NOT APPLICABLE\n - The incoming message's settlement amount is 0\n - The rate will be 0.0\n - example scenarios: tokenization messages, balance inquiries, 0 value transactions\n",
|
|
3062
|
+
"enum": ["NONE", "NETWORK", "INTERNAL", "NOT FOUND", "NOT APPLICABLE"]
|
|
3063
|
+
},
|
|
3064
|
+
"targetCurrency": {
|
|
3065
|
+
"$ref": "/message/v2/schemas/definitions/CurrencyAlphabeticCode"
|
|
3066
|
+
}
|
|
3067
|
+
}
|
|
3068
|
+
},
|
|
3069
|
+
"DeclineReasons": {
|
|
3070
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3071
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/DeclineReasons",
|
|
3072
|
+
"type": "array",
|
|
3073
|
+
"description": "Reason the authorization was declined. These are internal reasons that are more detailed than what is\nprovided to the network.\n",
|
|
3074
|
+
"items": {
|
|
3075
|
+
"$ref": "/message/v2/schemas/definitions/DeclineReasonsEnum"
|
|
3076
|
+
}
|
|
3077
|
+
},
|
|
3078
|
+
"NewResponse": {
|
|
3079
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3080
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/NewResponse",
|
|
3081
|
+
"type": "object",
|
|
3082
|
+
"description": "The outgoing message response data to be sent back to the network.",
|
|
3083
|
+
"additionalProperties": false,
|
|
3084
|
+
"required": [
|
|
3085
|
+
"messageId",
|
|
3086
|
+
"cardId",
|
|
3087
|
+
"responseCode",
|
|
3088
|
+
"declineReasons",
|
|
3089
|
+
"capture",
|
|
3090
|
+
"requestedAmount",
|
|
3091
|
+
"requestedTolerance",
|
|
3092
|
+
"requestedFee",
|
|
3093
|
+
"requestedTotal",
|
|
3094
|
+
"requestedCashBack",
|
|
3095
|
+
"messageApprovedAmount",
|
|
3096
|
+
"messageApprovedTolerance",
|
|
3097
|
+
"messageApprovedFee",
|
|
3098
|
+
"messageApprovedTotal",
|
|
3099
|
+
"approvedAmount",
|
|
3100
|
+
"approvedTolerance",
|
|
3101
|
+
"approvedFee",
|
|
3102
|
+
"approvedTotal",
|
|
3103
|
+
"approvedCashBack",
|
|
3104
|
+
"pendingAmount",
|
|
3105
|
+
"pendingTolerance",
|
|
3106
|
+
"pendingFee",
|
|
3107
|
+
"pendingTotal",
|
|
3108
|
+
"completedAmount",
|
|
3109
|
+
"completedTolerance",
|
|
3110
|
+
"completedFee",
|
|
3111
|
+
"completedTotal",
|
|
3112
|
+
"pendingAccounts",
|
|
3113
|
+
"completedAccounts",
|
|
3114
|
+
"tags",
|
|
3115
|
+
"addressVerificationResult",
|
|
3116
|
+
"applicationTransactionCounterValidationResult",
|
|
3117
|
+
"processedBy"
|
|
3118
|
+
],
|
|
3119
|
+
"properties": {
|
|
3120
|
+
"messageId": {
|
|
3121
|
+
"$ref": "/message/v2/schemas/definitions/MessageId"
|
|
3122
|
+
},
|
|
3123
|
+
"cardId": {
|
|
3124
|
+
"$ref": "/message/v2/schemas/definitions/CardId"
|
|
3125
|
+
},
|
|
3126
|
+
"authorizationIdResponse": {
|
|
3127
|
+
"type": "string",
|
|
3128
|
+
"description": "An identifier generated by the authorizing party used to help identify\nthe authorization. This is often provided to the cardholder on their transaction receipt.\n"
|
|
3129
|
+
},
|
|
3130
|
+
"responseCode": {
|
|
3131
|
+
"$ref": "/message/v2/schemas/definitions/ResponseCode"
|
|
3132
|
+
},
|
|
3133
|
+
"declineReasons": {
|
|
3134
|
+
"$ref": "/message/v2/schemas/definitions/DeclineReasons"
|
|
3135
|
+
},
|
|
3136
|
+
"capture": {
|
|
3137
|
+
"type": "boolean",
|
|
3138
|
+
"description": "Has the value 'true' if the card should be captured by the merchant and the merchant states they are\ncapable of capturing the card. Otherwise, the value is false.\n"
|
|
3139
|
+
},
|
|
3140
|
+
"requestedAmount": {
|
|
3141
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3142
|
+
},
|
|
3143
|
+
"requestedTolerance": {
|
|
3144
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3145
|
+
},
|
|
3146
|
+
"requestedFee": {
|
|
3147
|
+
"description": "Fee amount applied by the processor. This value does not include fees applied by\nthe network or acquirer. Those fees are included in requestedAmount and approvedAmount.\n",
|
|
3148
|
+
"allOf": [
|
|
3149
|
+
{
|
|
3150
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3151
|
+
}
|
|
3152
|
+
]
|
|
3153
|
+
},
|
|
3154
|
+
"requestedTotal": {
|
|
3155
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3156
|
+
},
|
|
3157
|
+
"requestedCashBack": {
|
|
3158
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3159
|
+
},
|
|
3160
|
+
"messageApprovedAmount": {
|
|
3161
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3162
|
+
},
|
|
3163
|
+
"messageApprovedTolerance": {
|
|
3164
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3165
|
+
},
|
|
3166
|
+
"messageApprovedFee": {
|
|
3167
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3168
|
+
},
|
|
3169
|
+
"messageApprovedTotal": {
|
|
3170
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3171
|
+
},
|
|
3172
|
+
"approvedAmount": {
|
|
3173
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3174
|
+
},
|
|
3175
|
+
"approvedTolerance": {
|
|
3176
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3177
|
+
},
|
|
3178
|
+
"approvedFee": {
|
|
3179
|
+
"description": "Fee amount applied by the processor. This value does not include fees applied by\nthe network or acquirer. Those fees are included in requestedAmount and approvedAmount.\n",
|
|
3180
|
+
"allOf": [
|
|
3181
|
+
{
|
|
3182
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3183
|
+
}
|
|
3184
|
+
]
|
|
3185
|
+
},
|
|
3186
|
+
"approvedTotal": {
|
|
3187
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3188
|
+
},
|
|
3189
|
+
"approvedCashBack": {
|
|
3190
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3191
|
+
},
|
|
3192
|
+
"pendingAmount": {
|
|
3193
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3194
|
+
},
|
|
3195
|
+
"pendingTolerance": {
|
|
3196
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3197
|
+
},
|
|
3198
|
+
"pendingFee": {
|
|
3199
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3200
|
+
},
|
|
3201
|
+
"pendingTotal": {
|
|
3202
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3203
|
+
},
|
|
3204
|
+
"completedAmount": {
|
|
3205
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3206
|
+
},
|
|
3207
|
+
"completedTolerance": {
|
|
3208
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3209
|
+
},
|
|
3210
|
+
"completedFee": {
|
|
3211
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3212
|
+
},
|
|
3213
|
+
"completedTotal": {
|
|
3214
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3215
|
+
},
|
|
3216
|
+
"availableBalance": {
|
|
3217
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3218
|
+
},
|
|
3219
|
+
"addressVerificationResult": {
|
|
3220
|
+
"$ref": "/message/v2/schemas/definitions/AddressVerificationResult"
|
|
3221
|
+
},
|
|
3222
|
+
"applicationTransactionCounterValidationResult": {
|
|
3223
|
+
"$ref": "/message/v2/schemas/definitions/ApplicationTransactionCounterValidationResult"
|
|
3224
|
+
},
|
|
3225
|
+
"entryId": {
|
|
3226
|
+
"type": "string",
|
|
3227
|
+
"minLength": 1
|
|
3228
|
+
},
|
|
3229
|
+
"pendingAccounts": {
|
|
3230
|
+
"type": "array",
|
|
3231
|
+
"description": "Accounts where there are still funds pending",
|
|
3232
|
+
"items": {
|
|
3233
|
+
"$ref": "/message/v2/schemas/definitions/AccountUsage"
|
|
3234
|
+
}
|
|
3235
|
+
},
|
|
3236
|
+
"completedAccounts": {
|
|
3237
|
+
"type": "array",
|
|
3238
|
+
"description": "Accounts where the funds have completed",
|
|
3239
|
+
"items": {
|
|
3240
|
+
"$ref": "/message/v2/schemas/definitions/AccountUsage"
|
|
3241
|
+
}
|
|
3242
|
+
},
|
|
3243
|
+
"holdExpirationDateTime": {
|
|
3244
|
+
"$ref": "/message/v2/schemas/definitions/HoldExpirationDateTime"
|
|
3245
|
+
},
|
|
3246
|
+
"tags": {
|
|
3247
|
+
"type": "array",
|
|
3248
|
+
"description": "A list of Tag objects.",
|
|
3249
|
+
"items": {
|
|
3250
|
+
"$ref": "/message/v2/schemas/definitions/Tag"
|
|
3251
|
+
}
|
|
3252
|
+
},
|
|
3253
|
+
"tokenization": {
|
|
3254
|
+
"type": "object",
|
|
3255
|
+
"properties": {
|
|
3256
|
+
"activationMethods": {
|
|
3257
|
+
"type": "array",
|
|
3258
|
+
"minLength": 0,
|
|
3259
|
+
"description": "The activation methods to be used for this tokenization. Returning an empty array will mean \nthat no additional activation methods are required to tokenize, with the except of any pre-configured \nwith the party responsible for initializing the tokenization.\n",
|
|
3260
|
+
"items": {
|
|
3261
|
+
"$ref": "/message/v2/schemas/definitions/ActivationMethod"
|
|
3262
|
+
}
|
|
3263
|
+
}
|
|
3264
|
+
}
|
|
3265
|
+
},
|
|
3266
|
+
"processedBy": {
|
|
3267
|
+
"type": "string",
|
|
3268
|
+
"description": "The name of the service that provided the approval or decline."
|
|
3269
|
+
},
|
|
3270
|
+
"proprietaryAuxiliaryData": {
|
|
3271
|
+
"$ref": "/message/v2/schemas/definitions/ProprietaryAuxiliaryData"
|
|
3272
|
+
},
|
|
3273
|
+
"additionalCurrencyConversionRates": {
|
|
3274
|
+
"type": "array",
|
|
3275
|
+
"minLength": 0,
|
|
3276
|
+
"description": "Additional currency conversion rates used to convert the settlement currency to another currency.",
|
|
3277
|
+
"items": {
|
|
3278
|
+
"$ref": "/message/v2/schemas/definitions/AdditionalCurrencyConversionRate"
|
|
3279
|
+
}
|
|
3280
|
+
}
|
|
3281
|
+
}
|
|
3282
|
+
},
|
|
3283
|
+
"Response": {
|
|
3284
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3285
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/Response",
|
|
3286
|
+
"type": "object",
|
|
3287
|
+
"description": "The stored response data to be sent back to the network.",
|
|
3288
|
+
"additionalProperties": false,
|
|
3289
|
+
"required": [
|
|
3290
|
+
"messageId",
|
|
3291
|
+
"cardId",
|
|
3292
|
+
"responseCode",
|
|
3293
|
+
"declineReasons",
|
|
3294
|
+
"capture",
|
|
3295
|
+
"requestedAmount",
|
|
3296
|
+
"requestedTolerance",
|
|
3297
|
+
"requestedFee",
|
|
3298
|
+
"requestedTotal",
|
|
3299
|
+
"requestedCashBack",
|
|
3300
|
+
"messageApprovedAmount",
|
|
3301
|
+
"messageApprovedTolerance",
|
|
3302
|
+
"messageApprovedFee",
|
|
3303
|
+
"messageApprovedTotal",
|
|
3304
|
+
"approvedAmount",
|
|
3305
|
+
"approvedTolerance",
|
|
3306
|
+
"approvedFee",
|
|
3307
|
+
"approvedTotal",
|
|
3308
|
+
"approvedCashBack",
|
|
3309
|
+
"pendingAmount",
|
|
3310
|
+
"pendingTolerance",
|
|
3311
|
+
"pendingFee",
|
|
3312
|
+
"pendingTotal",
|
|
3313
|
+
"completedAmount",
|
|
3314
|
+
"completedTolerance",
|
|
3315
|
+
"completedFee",
|
|
3316
|
+
"completedTotal",
|
|
3317
|
+
"pendingAccounts",
|
|
3318
|
+
"completedAccounts",
|
|
3319
|
+
"tags",
|
|
3320
|
+
"addressVerificationResult",
|
|
3321
|
+
"applicationTransactionCounterValidationResult",
|
|
3322
|
+
"processedBy",
|
|
3323
|
+
"createdOn"
|
|
3324
|
+
],
|
|
3325
|
+
"properties": {
|
|
3326
|
+
"messageId": {
|
|
3327
|
+
"$ref": "/message/v2/schemas/definitions/MessageId"
|
|
3328
|
+
},
|
|
3329
|
+
"cardId": {
|
|
3330
|
+
"$ref": "/message/v2/schemas/definitions/CardId"
|
|
3331
|
+
},
|
|
3332
|
+
"authorizationIdResponse": {
|
|
3333
|
+
"type": "string",
|
|
3334
|
+
"description": "An identifier generated by the authorizing party - i.e. the Check Digit platform - used to help identify\nthe authorization.\n"
|
|
3335
|
+
},
|
|
3336
|
+
"responseCode": {
|
|
3337
|
+
"$ref": "/message/v2/schemas/definitions/ResponseCode"
|
|
3338
|
+
},
|
|
3339
|
+
"declineReasons": {
|
|
3340
|
+
"$ref": "/message/v2/schemas/definitions/DeclineReasons"
|
|
3341
|
+
},
|
|
3342
|
+
"capture": {
|
|
3343
|
+
"type": "boolean",
|
|
3344
|
+
"description": "Has the value 'true' if the card should be captured by the merchant. Otherwise, the value is false.\n"
|
|
3345
|
+
},
|
|
3346
|
+
"requestedAmount": {
|
|
3347
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3348
|
+
},
|
|
3349
|
+
"requestedTolerance": {
|
|
3350
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3351
|
+
},
|
|
3352
|
+
"requestedFee": {
|
|
3353
|
+
"description": "Fee amount applied by the processor. This value does not include fees applied by\nthe network or acquirer. Those fees are included in requestedAmount and approvedAmount.\n",
|
|
3354
|
+
"allOf": [
|
|
3355
|
+
{
|
|
3356
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3357
|
+
}
|
|
3358
|
+
]
|
|
3359
|
+
},
|
|
3360
|
+
"requestedTotal": {
|
|
3361
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3362
|
+
},
|
|
3363
|
+
"requestedCashBack": {
|
|
3364
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3365
|
+
},
|
|
3366
|
+
"messageApprovedAmount": {
|
|
3367
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3368
|
+
},
|
|
3369
|
+
"messageApprovedTolerance": {
|
|
3370
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3371
|
+
},
|
|
3372
|
+
"messageApprovedFee": {
|
|
3373
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3374
|
+
},
|
|
3375
|
+
"messageApprovedTotal": {
|
|
3376
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3377
|
+
},
|
|
3378
|
+
"approvedAmount": {
|
|
3379
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3380
|
+
},
|
|
3381
|
+
"approvedTolerance": {
|
|
3382
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3383
|
+
},
|
|
3384
|
+
"approvedFee": {
|
|
3385
|
+
"description": "Fee amount applied by the processor. This value does not include fees applied by\nthe network or acquirer. Those fees are included in requestedAmount and approvedAmount.\n",
|
|
3386
|
+
"allOf": [
|
|
3387
|
+
{
|
|
3388
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3389
|
+
}
|
|
3390
|
+
]
|
|
3391
|
+
},
|
|
3392
|
+
"approvedTotal": {
|
|
3393
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3394
|
+
},
|
|
3395
|
+
"approvedCashBack": {
|
|
3396
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3397
|
+
},
|
|
3398
|
+
"pendingAmount": {
|
|
3399
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3400
|
+
},
|
|
3401
|
+
"pendingTolerance": {
|
|
3402
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3403
|
+
},
|
|
3404
|
+
"pendingFee": {
|
|
3405
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3406
|
+
},
|
|
3407
|
+
"pendingTotal": {
|
|
3408
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3409
|
+
},
|
|
3410
|
+
"completedAmount": {
|
|
3411
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3412
|
+
},
|
|
3413
|
+
"completedTolerance": {
|
|
3414
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3415
|
+
},
|
|
3416
|
+
"completedFee": {
|
|
3417
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3418
|
+
},
|
|
3419
|
+
"completedTotal": {
|
|
3420
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3421
|
+
},
|
|
3422
|
+
"availableBalance": {
|
|
3423
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3424
|
+
},
|
|
3425
|
+
"addressVerificationResult": {
|
|
3426
|
+
"$ref": "/message/v2/schemas/definitions/AddressVerificationResult"
|
|
3427
|
+
},
|
|
3428
|
+
"applicationTransactionCounterValidationResult": {
|
|
3429
|
+
"$ref": "/message/v2/schemas/definitions/ApplicationTransactionCounterValidationResult"
|
|
3430
|
+
},
|
|
3431
|
+
"entryId": {
|
|
3432
|
+
"type": "string",
|
|
3433
|
+
"description": "The unique identifier for the ledger entry created during processing.\n"
|
|
3434
|
+
},
|
|
3435
|
+
"pendingAccounts": {
|
|
3436
|
+
"type": "array",
|
|
3437
|
+
"description": "A list of AccountUsage objects for accounts where funds are pending.",
|
|
3438
|
+
"items": {
|
|
3439
|
+
"$ref": "/message/v2/schemas/definitions/AccountUsage"
|
|
3440
|
+
}
|
|
3441
|
+
},
|
|
3442
|
+
"completedAccounts": {
|
|
3443
|
+
"type": "array",
|
|
3444
|
+
"description": "A list of AccountUsage objects for accounts where funds have completed.",
|
|
3445
|
+
"items": {
|
|
3446
|
+
"$ref": "/message/v2/schemas/definitions/AccountUsage"
|
|
3447
|
+
}
|
|
3448
|
+
},
|
|
3449
|
+
"holdExpirationDateTime": {
|
|
3450
|
+
"$ref": "/message/v2/schemas/definitions/HoldExpirationDateTime"
|
|
3451
|
+
},
|
|
3452
|
+
"tags": {
|
|
3453
|
+
"type": "array",
|
|
3454
|
+
"description": "A list of Tag objects.",
|
|
3455
|
+
"items": {
|
|
3456
|
+
"$ref": "/message/v2/schemas/definitions/Tag"
|
|
3457
|
+
}
|
|
3458
|
+
},
|
|
3459
|
+
"tokenization": {
|
|
3460
|
+
"type": "object",
|
|
3461
|
+
"properties": {
|
|
3462
|
+
"activationMethods": {
|
|
3463
|
+
"type": "array",
|
|
3464
|
+
"minLength": 0,
|
|
3465
|
+
"description": "The activation methods to be used for this tokenization.\n\nReturning an empty array will mean that no additional activation methods are required to tokenize, with \nthe exception of any pre-configured methods with the party responsible for initializing the \ntokenization.\n",
|
|
3466
|
+
"items": {
|
|
3467
|
+
"$ref": "/message/v2/schemas/definitions/ActivationMethod"
|
|
3468
|
+
}
|
|
3469
|
+
}
|
|
3470
|
+
}
|
|
3471
|
+
},
|
|
3472
|
+
"processedBy": {
|
|
3473
|
+
"type": "string",
|
|
3474
|
+
"description": "The name of the service that provided the approval or decline."
|
|
3475
|
+
},
|
|
3476
|
+
"createdOn": {
|
|
3477
|
+
"$ref": "/message/v2/schemas/definitions/CreatedOn"
|
|
3478
|
+
},
|
|
3479
|
+
"proprietaryAuxiliaryData": {
|
|
3480
|
+
"$ref": "/message/v2/schemas/definitions/ProprietaryAuxiliaryData"
|
|
3481
|
+
},
|
|
3482
|
+
"additionalCurrencyConversionRates": {
|
|
3483
|
+
"type": "array",
|
|
3484
|
+
"minLength": 0,
|
|
3485
|
+
"description": "Additional currency conversion rates used to convert the settlement currency to another currency.",
|
|
3486
|
+
"items": {
|
|
3487
|
+
"$ref": "/message/v2/schemas/definitions/AdditionalCurrencyConversionRate"
|
|
3488
|
+
}
|
|
3489
|
+
}
|
|
3490
|
+
}
|
|
3491
|
+
},
|
|
3492
|
+
"PickedResponse": {
|
|
3493
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3494
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/PickedResponse",
|
|
3495
|
+
"type": "object",
|
|
3496
|
+
"additionalProperties": false,
|
|
3497
|
+
"description": "A PickedResponse object contains a subset of fields from a Response object. \nA PickedResponse object may be preferred to minimize the amount of data retrieved and the time taken to \ntransmit and process the response.\n",
|
|
3498
|
+
"required": ["createdOn"],
|
|
3499
|
+
"properties": {
|
|
3500
|
+
"messageId": {
|
|
3501
|
+
"$ref": "/message/v2/schemas/definitions/MessageId"
|
|
3502
|
+
},
|
|
3503
|
+
"declineReasons": {
|
|
3504
|
+
"$ref": "/message/v2/schemas/definitions/DeclineReasons"
|
|
3505
|
+
},
|
|
3506
|
+
"approvedTotal": {
|
|
3507
|
+
"$ref": "/message/v2/schemas/definitions/Amount"
|
|
3508
|
+
},
|
|
3509
|
+
"holdExpirationDateTime": {
|
|
3510
|
+
"$ref": "/message/v2/schemas/definitions/HoldExpirationDateTime"
|
|
3511
|
+
},
|
|
3512
|
+
"createdOn": {
|
|
3513
|
+
"$ref": "/message/v2/schemas/definitions/CreatedOn"
|
|
3514
|
+
},
|
|
3515
|
+
"proprietaryAuxiliaryData": {
|
|
3516
|
+
"$ref": "/message/v2/schemas/definitions/ProprietaryAuxiliaryData"
|
|
3517
|
+
},
|
|
3518
|
+
"additionalCurrencyConversionRates": {
|
|
3519
|
+
"type": "array",
|
|
3520
|
+
"minLength": 0,
|
|
3521
|
+
"description": "Additional currency conversion rates used to convert the settlement currency to another currency.",
|
|
3522
|
+
"items": {
|
|
3523
|
+
"$ref": "/message/v2/schemas/definitions/AdditionalCurrencyConversionRate"
|
|
3524
|
+
}
|
|
3525
|
+
}
|
|
3526
|
+
}
|
|
3527
|
+
},
|
|
3528
|
+
"RequestField": {
|
|
3529
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3530
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/RequestField",
|
|
3531
|
+
"type": "string",
|
|
3532
|
+
"description": "The message request fields to return.",
|
|
3533
|
+
"enum": [
|
|
3534
|
+
"CARD_ID",
|
|
3535
|
+
"ADVICE_RESPONSE",
|
|
3536
|
+
"CATEGORIZATION",
|
|
3537
|
+
"MATCHED_MESSAGE_ID",
|
|
3538
|
+
"MESSAGE_ID",
|
|
3539
|
+
"RECEIVED_DATE_TIME",
|
|
3540
|
+
"SETTLEMENT_AMOUNT"
|
|
3541
|
+
]
|
|
3542
|
+
},
|
|
3543
|
+
"ResponseField": {
|
|
3544
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3545
|
+
"$id": "https://eslint-plugin.checkdigit/message/v2/schemas/definitions/ResponseField",
|
|
3546
|
+
"type": "string",
|
|
3547
|
+
"description": "The message response fields to return.",
|
|
3548
|
+
"enum": [
|
|
3549
|
+
"APPROVED_TOTAL",
|
|
3550
|
+
"DECLINE_REASONS",
|
|
3551
|
+
"HOLD_EXPIRATION_DATE_TIME",
|
|
3552
|
+
"MESSAGE_ID",
|
|
3553
|
+
"PROPRIETARY_AUXILIARY_DATA",
|
|
3554
|
+
"ADDITIONAL_CURRENCY_CONVERSION_RATES"
|
|
3555
|
+
]
|
|
3556
|
+
}
|
|
3557
|
+
}
|
|
3558
|
+
}
|