@checkdigit/eslint-plugin 7.17.1 → 7.18.0-PR.143-9946

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/dist-mjs/athena/api-locator.mjs +30 -0
  2. package/dist-mjs/athena/api-matcher.mjs +108 -0
  3. package/dist-mjs/athena/athena.mjs +328 -0
  4. package/dist-mjs/athena/column.mjs +1 -0
  5. package/dist-mjs/athena/context.mjs +21 -0
  6. package/dist-mjs/athena/index.mjs +1 -0
  7. package/dist-mjs/athena/service-table.mjs +32 -0
  8. package/dist-mjs/athena/types.mjs +1 -0
  9. package/dist-mjs/athena/visitor.mjs +258 -0
  10. package/dist-mjs/index.mjs +8 -4
  11. package/dist-mjs/no-status-code-assert.mjs +1 -1
  12. package/dist-mjs/openapi/deref-schema.mjs +14 -0
  13. package/dist-mjs/openapi/generate-schema.mjs +273 -0
  14. package/dist-mjs/openapi/service-schema-generator.mjs +147 -0
  15. package/dist-mjs/peggy/athena-peggy.mjs +20629 -0
  16. package/dist-types/athena/api-locator.d.ts +2 -0
  17. package/dist-types/athena/api-matcher.d.ts +14 -0
  18. package/dist-types/athena/athena.d.ts +6 -0
  19. package/dist-types/athena/column.d.ts +1 -0
  20. package/dist-types/athena/context.d.ts +21 -0
  21. package/dist-types/athena/index.d.ts +8 -0
  22. package/dist-types/athena/service-table.d.ts +8 -0
  23. package/dist-types/athena/types.d.ts +474 -0
  24. package/dist-types/athena/visitor.d.ts +63 -0
  25. package/dist-types/no-status-code-assert.d.ts +1 -1
  26. package/dist-types/openapi/deref-schema.d.ts +1 -0
  27. package/dist-types/openapi/generate-schema.d.ts +33 -0
  28. package/dist-types/openapi/service-schema-generator.d.ts +5 -0
  29. package/dist-types/peggy/athena-peggy.d.ts +13 -0
  30. package/package.json +1 -96
  31. package/src/athena/ATHENA.md +387 -0
  32. package/src/athena/PLAN.md +355 -0
  33. package/src/athena/api-locator.ts +39 -0
  34. package/src/athena/api-matcher.ts +169 -0
  35. package/src/athena/athena.ts +488 -0
  36. package/src/athena/column.ts +2 -0
  37. package/src/athena/context.ts +47 -0
  38. package/src/athena/index.ts +11 -0
  39. package/src/athena/service-table.ts +55 -0
  40. package/src/athena/types.ts +526 -0
  41. package/src/athena/visitor.ts +365 -0
  42. package/src/index.ts +4 -0
  43. package/src/no-side-effects.ts +1 -1
  44. package/src/no-status-code-assert.ts +2 -2
  45. package/src/openapi/deref-schema.ts +14 -0
  46. package/src/openapi/generate-schema.ts +422 -0
  47. package/src/openapi/service-schema-generator.ts +189 -0
  48. package/src/peggy/athena-chat.peggy +608 -0
  49. package/src/peggy/athena-peggy.ts +22078 -0
  50. package/src/peggy/athena.peggy +2967 -0
  51. package/src/require-service-call-response-declaration.ts +2 -2
  52. package/src/services/interchange/v1/swagger.schema.deref.json +849 -0
  53. package/src/services/interchange/v1/swagger.schema.json +473 -0
  54. package/src/services/interchange/v1/swagger.yml +414 -0
  55. package/src/services/ledger/v1/swagger.schema.deref.json +6694 -0
  56. package/src/services/ledger/v1/swagger.schema.json +1820 -0
  57. package/src/services/ledger/v1/swagger.yml +1094 -0
  58. package/src/services/link/v1/swagger.schema.deref.json +648 -0
  59. package/src/services/link/v1/swagger.schema.json +444 -0
  60. package/src/services/link/v1/swagger.yml +343 -0
  61. package/src/services/message/v1/swagger.schema.deref.json +22049 -0
  62. package/src/services/message/v1/swagger.schema.json +3470 -0
  63. package/src/services/message/v1/swagger.yml +2798 -0
  64. package/src/services/message/v2/swagger.schema.deref.json +72221 -0
  65. package/src/services/message/v2/swagger.schema.json +3558 -0
  66. package/src/services/message/v2/swagger.yml +3009 -0
  67. package/src/services/paymentCard/v1/swagger.schema.deref.json +4346 -0
  68. package/src/services/paymentCard/v1/swagger.schema.json +2181 -0
  69. package/src/services/paymentCard/v1/swagger.yml +1161 -0
  70. package/src/services/paymentCard/v2/swagger.schema.deref.json +4336 -0
  71. package/src/services/paymentCard/v2/swagger.schema.json +2155 -0
  72. package/src/services/paymentCard/v2/swagger.yml +1149 -0
  73. package/src/services/person/v1/swagger.schema.deref.json +6786 -0
  74. package/src/services/person/v1/swagger.schema.json +1445 -0
  75. package/src/services/person/v1/swagger.yml +1157 -0
  76. package/src/services/teampayApproval/v1/swagger.schema.deref.json +9898 -0
  77. package/src/services/teampayCardManagement/v1/swagger.schema.deref.json +6187 -0
  78. package/src/services/teampayClientManagement/v1/swagger.schema.deref.json +4914 -0
  79. package/src/services/teampayClientManagement/v1/swagger.schema.json +1964 -0
  80. package/src/services/teampayClientManagement/v1/swagger.yml +1376 -0
@@ -0,0 +1,2798 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: Message
4
+ description: |
5
+
6
+ Records and retrieves messages.
7
+
8
+ © Check Digit LLC. 2019-2024
9
+ version: 1.41.0
10
+ contact:
11
+ name: Check Digit
12
+
13
+ servers:
14
+ - url: /message/v1
15
+ tags:
16
+ - name: Service Health
17
+ - name: API
18
+
19
+ x-firehose-logged: false
20
+
21
+ paths:
22
+ /ping:
23
+ get:
24
+ tags:
25
+ - Service Health
26
+ operationId: 'ping-get'
27
+ description: Test service connectivity
28
+ responses:
29
+ '200':
30
+ $ref: '#/components/responses/Ping'
31
+ default:
32
+ $ref: '#/components/responses/ServerError'
33
+
34
+ /request:
35
+ get:
36
+ tags:
37
+ - API
38
+ operationId: 'request-query-get'
39
+ description: Obtains the request messages by card id.
40
+ parameters:
41
+ - $ref: '#/components/parameters/cardId'
42
+ - $ref: '#/components/parameters/toDate'
43
+ - $ref: '#/components/parameters/fromDate'
44
+ responses:
45
+ '200':
46
+ description: Request messages successfully obtained
47
+ content:
48
+ application/json:
49
+ schema:
50
+ $ref: '#/components/schemas/RequestResponse'
51
+ default:
52
+ $ref: '#/components/responses/ServerError'
53
+
54
+ /picked-request:
55
+ get:
56
+ tags:
57
+ - API
58
+ operationId: 'picked-request-get'
59
+ summary: Obtains request messages, containing only the specified fields, by card id(s).
60
+ description: |
61
+ - The list of picked request messages in the response will be unsorted.
62
+ - The CREATED_ON field is mandatory to be supplied in the list of fields, any request submitted without it will result in a 400 Bad Request.
63
+ parameters:
64
+ - $ref: '#/components/parameters/cardId'
65
+ - $ref: '#/components/parameters/toDate'
66
+ - $ref: '#/components/parameters/fromDate'
67
+ - $ref: '#/components/parameters/requestFields'
68
+ responses:
69
+ '200':
70
+ description: Picked request messages successfully obtained
71
+ content:
72
+ application/json:
73
+ schema:
74
+ $ref: '#/components/schemas/PickedRequestResponse'
75
+ default:
76
+ $ref: '#/components/responses/ServerError'
77
+
78
+ /request/{messageId}:
79
+ put:
80
+ tags:
81
+ - API
82
+ x-firehose-logged: true
83
+ operationId: 'request-put'
84
+ description: Stores a request message with the supplied messageId and data.
85
+ parameters:
86
+ - $ref: '#/components/parameters/messageId'
87
+ - $ref: '#/components/parameters/lastModified'
88
+ - $ref: '#/components/parameters/createdOn'
89
+ requestBody:
90
+ required: true
91
+ content:
92
+ application/json:
93
+ schema:
94
+ $ref: '#/components/schemas/NewRequest'
95
+ responses:
96
+ '204':
97
+ description: Message recorded successfully
98
+ content:
99
+ application/json:
100
+ schema: {}
101
+ headers:
102
+ Last-Modified:
103
+ $ref: '#/components/headers/Last-Modified'
104
+ Created-On:
105
+ $ref: '#/components/headers/Created-On'
106
+ Updated-On:
107
+ $ref: '#/components/headers/Updated-On'
108
+ '409':
109
+ description: Message already exists with different data
110
+ content:
111
+ application/json:
112
+ schema: {}
113
+ default:
114
+ $ref: '#/components/responses/ServerError'
115
+
116
+ get:
117
+ tags:
118
+ - API
119
+ operationId: 'request-get'
120
+ description: Retrieves a request message with the supplied messageId.
121
+ parameters:
122
+ - $ref: '#/components/parameters/messageId'
123
+ - $ref: '#/components/parameters/at'
124
+ responses:
125
+ '200':
126
+ description: Request message successfully retrieved
127
+ content:
128
+ application/json:
129
+ schema:
130
+ $ref: '#/components/schemas/Request'
131
+ headers:
132
+ Last-Modified:
133
+ $ref: '#/components/headers/Last-Modified'
134
+ Created-On:
135
+ $ref: '#/components/headers/Created-On'
136
+ Updated-On:
137
+ $ref: '#/components/headers/Updated-On'
138
+ '404':
139
+ description: Request message not found
140
+ content:
141
+ application/json:
142
+ schema: {}
143
+ default:
144
+ $ref: '#/components/responses/ServerError'
145
+
146
+ /response:
147
+ get:
148
+ tags:
149
+ - API
150
+ operationId: 'response-query-get'
151
+ description: Obtains the response messages by card id.
152
+ parameters:
153
+ - $ref: '#/components/parameters/cardId'
154
+ - $ref: '#/components/parameters/toDate'
155
+ - $ref: '#/components/parameters/fromDate'
156
+ responses:
157
+ '200':
158
+ description: Response messages successfully obtained
159
+ content:
160
+ application/json:
161
+ schema:
162
+ $ref: '#/components/schemas/ResponseResponse'
163
+ default:
164
+ $ref: '#/components/responses/ServerError'
165
+
166
+ /picked-response:
167
+ get:
168
+ tags:
169
+ - API
170
+ operationId: 'picked-response-get'
171
+ summary: Obtains response messages, containing only the specified fields, by card id(s).
172
+ description: |
173
+ - The list of picked response messages in the response will be unsorted.
174
+ - The CREATED_ON field is mandatory to be supplied in the list of fields, any request submitted without it will result in a 400 Bad Request.
175
+ parameters:
176
+ - $ref: '#/components/parameters/cardId'
177
+ - $ref: '#/components/parameters/toDate'
178
+ - $ref: '#/components/parameters/fromDate'
179
+ - $ref: '#/components/parameters/responseFields'
180
+ responses:
181
+ '200':
182
+ description: Picked response messages successfully obtained
183
+ content:
184
+ application/json:
185
+ schema:
186
+ $ref: '#/components/schemas/PickedResponseResponse'
187
+ default:
188
+ $ref: '#/components/responses/ServerError'
189
+
190
+ /response/{messageId}:
191
+ put:
192
+ tags:
193
+ - API
194
+ x-firehose-logged: true
195
+ operationId: 'response-put'
196
+ description: |
197
+ Stores a request and response message with the supplied messageId and
198
+ data.
199
+ parameters:
200
+ - $ref: '#/components/parameters/messageId'
201
+ - $ref: '#/components/parameters/lastModified'
202
+ - $ref: '#/components/parameters/createdOn'
203
+ requestBody:
204
+ required: true
205
+ content:
206
+ application/json:
207
+ schema:
208
+ $ref: '#/components/schemas/NewResponse'
209
+ responses:
210
+ '204':
211
+ description: Message recorded successfully
212
+ content:
213
+ application/json:
214
+ schema: {}
215
+ headers:
216
+ Last-Modified:
217
+ $ref: '#/components/headers/Last-Modified'
218
+ Created-On:
219
+ $ref: '#/components/headers/Created-On'
220
+ Updated-On:
221
+ $ref: '#/components/headers/Updated-On'
222
+ '409':
223
+ description: Message already exists with different data
224
+ content:
225
+ application/json:
226
+ schema: {}
227
+ default:
228
+ $ref: '#/components/responses/ServerError'
229
+
230
+ get:
231
+ tags:
232
+ - API
233
+ operationId: 'response-get'
234
+ description: Retrieves a response message with the supplied messageId.
235
+ parameters:
236
+ - $ref: '#/components/parameters/messageId'
237
+ - $ref: '#/components/parameters/at'
238
+ responses:
239
+ '200':
240
+ description: Response message successfully retrieved
241
+ content:
242
+ application/json:
243
+ schema:
244
+ $ref: '#/components/schemas/Response'
245
+ headers:
246
+ Last-Modified:
247
+ $ref: '#/components/headers/Last-Modified'
248
+ Created-On:
249
+ $ref: '#/components/headers/Created-On'
250
+ Updated-On:
251
+ $ref: '#/components/headers/Updated-On'
252
+ '404':
253
+ description: Request message not found
254
+ content:
255
+ application/json:
256
+ schema: {}
257
+ default:
258
+ $ref: '#/components/responses/ServerError'
259
+
260
+ components:
261
+ schemas:
262
+ Ping:
263
+ type: object
264
+ additionalProperties: false
265
+ required:
266
+ - serverTime
267
+ properties:
268
+ serverTime:
269
+ type: string
270
+ format: date-time
271
+ description: Current server time
272
+
273
+ ResponseResponse:
274
+ type: object
275
+ additionalProperties: false
276
+ required:
277
+ - messages
278
+ properties:
279
+ messages:
280
+ type: array
281
+ items:
282
+ $ref: '#/components/schemas/Response'
283
+
284
+ RequestResponse:
285
+ type: object
286
+ additionalProperties: false
287
+ required:
288
+ - messages
289
+ properties:
290
+ messages:
291
+ description: This list is unsorted.
292
+ type: array
293
+ items:
294
+ $ref: '#/components/schemas/Request'
295
+
296
+ PickedRequestResponse:
297
+ type: object
298
+ additionalProperties: false
299
+ required:
300
+ - pickedMessages
301
+ properties:
302
+ pickedMessages:
303
+ type: array
304
+ items:
305
+ $ref: '#/components/schemas/PickedRequest'
306
+
307
+ PickedResponseResponse:
308
+ type: object
309
+ additionalProperties: false
310
+ required:
311
+ - pickedMessages
312
+ properties:
313
+ pickedMessages:
314
+ type: array
315
+ items:
316
+ $ref: '#/components/schemas/PickedResponse'
317
+
318
+ Error:
319
+ type: object
320
+ additionalProperties: false
321
+ required:
322
+ - message
323
+ description: Error message
324
+ properties:
325
+ message:
326
+ type: string
327
+ minLength: 1
328
+ code:
329
+ type: string
330
+ minLength: 1
331
+
332
+ Amount:
333
+ type: object
334
+ additionalProperties: false
335
+ required:
336
+ - amount
337
+ - currency
338
+ properties:
339
+ amount:
340
+ type: string
341
+ minLength: 1
342
+ currency:
343
+ type: string
344
+ minLength: 1
345
+
346
+ SettlementConversion:
347
+ type: object
348
+ description: |
349
+ This object will only exist if the transaction currency differs from the settlement currency.
350
+ required:
351
+ - date
352
+ - factor
353
+ - factorDecimalPosition
354
+ properties:
355
+ date:
356
+ description: |
357
+ This value represents the year, month, and day the conversion rate was determined.
358
+ type: string
359
+ format: date
360
+ factor:
361
+ description: |
362
+ This value represents the multiplying factor used to convert the transaction amount to the settlement
363
+ amount. This value can be used to calculate the conversion rate:
364
+
365
+ conversion rate = conversion factor / (10 ^ factor decimal position)
366
+
367
+ or, to calculate the settlement amount:
368
+
369
+ settlement amount = (transaction amount * conversion factor) / (10 ^ factor decimal position)
370
+ type: string
371
+ factorDecimalPosition:
372
+ description: |
373
+ This number represents the position the decimal point should be placed, starting from right. This can be
374
+ used to calculate the conversion rate:
375
+
376
+ conversion rate = conversion factor / (10 ^ factor decimal position)
377
+
378
+ or, to calculate the settlement amount:
379
+
380
+ settlement amount = (transaction amount * conversion factor) / (10 ^ factor decimal position)
381
+ type: number
382
+
383
+ MessageType:
384
+ type: string
385
+ description: >-
386
+ General message type for the message. A preauthorization will typically
387
+ result in a financial clearing message.
388
+ enum:
389
+ - PREAUTHORIZATION
390
+ - FINANCIAL
391
+ - ADMINISTRATIVE
392
+ - REVERSAL
393
+
394
+ MessageUsage:
395
+ type: string
396
+ description: >-
397
+ Message Usage of the network transaction. A request will result in a
398
+ response and an advice will result in an advice response. Advice
399
+ messages cannot be declined.
400
+ enum:
401
+ - REQUEST
402
+ - RESPONSE
403
+ - ADVICE
404
+ - ADVICE RESPONSE
405
+
406
+ Category:
407
+ type: string
408
+ description: Category of the network transaction.
409
+ enum:
410
+ - SIGNATURE
411
+ - PIN
412
+ - PINLESS
413
+ - ATM
414
+ - OTC
415
+ - AFD
416
+ - QUASICASH
417
+ - SCRIP
418
+ - BALANCE INQUIRY
419
+ - ACCOUNT INQUIRY
420
+ - FUNDS TRANSFER
421
+ - BILL PAYMENT
422
+ - ADJUSTMENT
423
+ - RETURN
424
+ - LOAD
425
+ - UNLOAD
426
+ - ACTIVATION
427
+ - ACTIVATION AND LOAD
428
+ - DEACTIVATION
429
+ - DEACTIVATION AND UNLOAD
430
+ - TOKENIZATION
431
+ - REQUEST ACTIVATION METHODS
432
+ - DELIVER ACTIVATION CODE
433
+ - NOTIFY TOKEN ACTIVATED
434
+ - NOTIFY TOKEN UPDATED
435
+ - NOTIFY SUSPICIOUS EVENTS
436
+ - UNSUPPORTED
437
+
438
+ DebitCredit:
439
+ type: string
440
+ description: Debit or Credit flag for the network transaction
441
+ enum:
442
+ - DEBIT
443
+ - CREDIT
444
+ - NEITHER
445
+
446
+ Categorization:
447
+ type: object
448
+ additionalProperties: false
449
+ required:
450
+ - messageType
451
+ - messageUsage
452
+ - category
453
+ - debitCredit
454
+ properties:
455
+ messageType:
456
+ $ref: '#/components/schemas/MessageType'
457
+ messageUsage:
458
+ $ref: '#/components/schemas/MessageUsage'
459
+ category:
460
+ $ref: '#/components/schemas/Category'
461
+ debitCredit:
462
+ $ref: '#/components/schemas/DebitCredit'
463
+
464
+ AccountType:
465
+ type: string
466
+ enum:
467
+ - NOT PROVIDED
468
+ - UNSPECIFIED
469
+ - SAVINGS
470
+ - CHECKING
471
+ - CREDIT
472
+ - INVESTMENT
473
+ - UNIVERSAL
474
+ - OTHER
475
+
476
+ Accounts:
477
+ type: object
478
+ additionalProperties: false
479
+ required:
480
+ - from
481
+ - to
482
+ properties:
483
+ from:
484
+ $ref: '#/components/schemas/AccountType'
485
+ to:
486
+ $ref: '#/components/schemas/AccountType'
487
+
488
+ PinCapabilities:
489
+ type: string
490
+ enum:
491
+ - NOT PROVIDED
492
+ - UNSPECIFIED
493
+ - PIN ENTRY CAPABILITY
494
+ - NO PIN ENTRY CAPABILITY
495
+ - PIN PAD INOPERATIVE
496
+ - PIN ENTRY CAPABILITY BUT OUT OF SERVICE
497
+ - PIN VERIFIED BY TERMINAL DEVICE
498
+
499
+ PanEntryMethod:
500
+ type: string
501
+ enum:
502
+ - NOT PROVIDED
503
+ - UNSPECIFIED
504
+ - MANUAL
505
+ - MAGNETIC STRIPE
506
+ - BAR CODE
507
+ - OCR
508
+ - INTEGRATED CIRCUIT CARD
509
+ - MANUAL KEY ENTERED
510
+ - CONTACTLESS EMV RULES
511
+ - CHIP CARD UNABLE MANUAL ENTRY
512
+ - CHIP CARD UNABLE MAGNETIC STRIPE
513
+ - ELECTRONIC COMMERCE
514
+ - PAN AUTO ENTRY VIA SERVER
515
+ - FULL MAGNETIC STRIPE
516
+ - CONTACTLESS MAG STRIPE RULES
517
+ - INTEGRATED CIRCUIT CARD CVV UNRELIABLE
518
+ - STORED VALUE PREREGISTERED CHECKOUT
519
+ - ON FILE
520
+ - SECURE ENTRY
521
+
522
+ PosConditionCode:
523
+ type: string
524
+ enum:
525
+ - NOT PROVIDED
526
+ - NORMAL
527
+ - CUSTOMER NOT PRESENT
528
+ - CUSTOMER NOT PRESENT RECURRING PAYMENT
529
+ - CUSTOMER PRESENT CARD NOT PRESENT
530
+ - CUSTOMER IDENTITY VERIFIED
531
+ - UNATTENDED TERMINAL ABLE TO RETAIN CARD
532
+ - UNATTENDED TERMINAL NOT ABLE TO RETAIN CARD
533
+ - MERCHANT SUSPICIOUS
534
+ - SUSPECTED FRAUD
535
+ - SECURITY ALERT
536
+ - NON SECURE ECOMMERCE
537
+ - SECURE ECOMMERCE WITH CARDHOLDER CERTIFICATE
538
+ - SECURE ECOMMERCE WITHOUT CARDHOLDER CERTIFICATE
539
+ - CHANNEL ENCRYPTED ECOMMERCE
540
+ - SECURE ECOMMERCE CONTAINING A DIGITAL SIGNATURE
541
+ - INTERNET PIN DEBIT
542
+ - PREAUTHORIZED REQUEST
543
+ - DEFERRED BILLING
544
+ - MAIL OR TELEPHONE ORDER
545
+ - TELEPHONE DEVICE REQUEST
546
+ - ELECTRONIC CARD REGISTER INTERFACE
547
+ - CUSTOMER TERMINAL
548
+ - ADMINISTRATION TERMINAL
549
+ - CVV VERIFIED AND VALID
550
+ - CVV VERIFIED AND INVALID
551
+
552
+ TerminalType:
553
+ type: string
554
+ enum:
555
+ - POINT OF SALE TERMINAL
556
+ - ATM
557
+ - HOME TERMINAL
558
+ - ELECTRONIC CASH REGISTER
559
+ - DIAL TERMINAL
560
+ - TRAVELERS CHECK MACHINE
561
+ - AUTOMATED FUEL DEVICE
562
+ - SCRIP MACHINE
563
+ - COUPON MACHINE
564
+ - TICKET MACHINE
565
+ - POINT OF BANKING TERMINAL
566
+ - TELLER
567
+ - FRANCHISE TELLER
568
+ - PERSONAL BANKING
569
+ - PUBLIC UTILITY
570
+ - VENDING
571
+ - SELF SERVICE
572
+ - AUTHORIZATION
573
+ - PAYMENT
574
+ - VRU
575
+ - SMART PHONE
576
+ - INTERACTIVE TELEVISION
577
+ - PERSONAL DIGITAL ASSISTANT
578
+ - SCREEN PHONE
579
+ - ELECTRONIC COMMERCE
580
+ - MICR TERMINAL AT POINT OF SALE
581
+ - NOT PROVIDED
582
+
583
+ CardholderPresence:
584
+ type: string
585
+ enum:
586
+ - CUSTOMER PRESENT
587
+ - CUSTOMER NOT PRESENT
588
+ - NOT PROVIDED
589
+
590
+ CardPresence:
591
+ type: string
592
+ enum:
593
+ - CARD PRESENT
594
+ - CARD NOT PRESENT
595
+ - NOT PROVIDED
596
+
597
+ Merchant:
598
+ type: object
599
+ additionalProperties: false
600
+ required:
601
+ - type
602
+ - name
603
+ - terminalTransactionDate
604
+ - terminalSequenceNumber
605
+ - terminalIdentification
606
+ - identificationCode
607
+ - address
608
+ - city
609
+ - stateProvince
610
+ - country
611
+ - allowsPartialApproval
612
+ - panEntryMethod
613
+ - pinCapabilities
614
+ - posConditionCode
615
+ properties:
616
+ type:
617
+ type: string
618
+ minLength: 1
619
+ name:
620
+ type: string
621
+ minLength: 1
622
+ terminalTransactionDate:
623
+ type: string
624
+ minLength: 1
625
+ terminalSequenceNumber:
626
+ type: number
627
+ terminalIdentification:
628
+ type: string
629
+ minLength: 1
630
+ identificationCode:
631
+ type: string
632
+ minLength: 1
633
+ address:
634
+ type: string
635
+ minLength: 1
636
+ city:
637
+ type: string
638
+ minLength: 1
639
+ stateProvince:
640
+ type: string
641
+ minLength: 1
642
+ county:
643
+ type: string
644
+ minLength: 1
645
+ postalCode:
646
+ type: string
647
+ minLength: 1
648
+ country:
649
+ type: string
650
+ minLength: 1
651
+ allowsPartialApproval:
652
+ type: boolean
653
+ panEntryMethod:
654
+ $ref: '#/components/schemas/PanEntryMethod'
655
+ pinCapabilities:
656
+ $ref: '#/components/schemas/PinCapabilities'
657
+ posConditionCode:
658
+ $ref: '#/components/schemas/PosConditionCode'
659
+ cardholderPresence:
660
+ $ref: '#/components/schemas/CardholderPresence'
661
+ cardPresence:
662
+ $ref: '#/components/schemas/CardPresence'
663
+ terminalType:
664
+ $ref: '#/components/schemas/TerminalType'
665
+
666
+ Acquirer:
667
+ type: object
668
+ additionalProperties: false
669
+ required:
670
+ - identificationCode
671
+ properties:
672
+ identificationCode:
673
+ type: string
674
+ minLength: 1
675
+ clearingIdentificationCode:
676
+ description: |
677
+ This string represents the Acquiring Institution Identifier (also known as, AcquirerICA). This value
678
+ may be included with clearing messages.
679
+ type: string
680
+ minLength: 1
681
+ countryCode:
682
+ type: string
683
+ minLength: 1
684
+
685
+ LifeCycleIndicator:
686
+ type: string
687
+ enum:
688
+ - CALENDAR DAY
689
+ - HOURS
690
+ - MINUTES
691
+
692
+ AuthorizationLifeCycle:
693
+ type: object
694
+ additionalProperties: false
695
+ description: >-
696
+ Optional data indicating that the acquirer or network has specified how
697
+ long the funds should be held if approved.
698
+ required:
699
+ - lifeCycleIndicator
700
+ - actualInterval
701
+ properties:
702
+ lifeCycleIndicator:
703
+ $ref: '#/components/schemas/LifeCycleIndicator'
704
+ actualInterval:
705
+ type: number
706
+
707
+ ReplacementAmounts:
708
+ type: object
709
+ additionalProperties: false
710
+ description: >-
711
+ All of these values are not required because we need to differentiate
712
+ between a replacement amount of zero and no replacement amount at all.
713
+ required:
714
+ - transactionAmount
715
+ - transactionFeeAmount
716
+ - settlementAmount
717
+ - settlementFeeAmount
718
+ - feeDetails
719
+ properties:
720
+ transactionAmount:
721
+ $ref: '#/components/schemas/Amount'
722
+ transactionFeeAmount:
723
+ description: |
724
+ Fee amount applied by the network or acquirer in the merchant's currency.
725
+ allOf:
726
+ - $ref: '#/components/schemas/Amount'
727
+ settlementAmount:
728
+ $ref: '#/components/schemas/Amount'
729
+ settlementFeeAmount:
730
+ description: |
731
+ Fee amount applied by the network or acquirer in the BIN currency.
732
+ allOf:
733
+ - $ref: '#/components/schemas/Amount'
734
+ feeDetails:
735
+ type: array
736
+ description: Details about the fees that went into the transaction and settlement fee amounts
737
+ items:
738
+ $ref: '#/components/schemas/Fee'
739
+
740
+ EncryptedKey:
741
+ type: object
742
+ additionalProperties: false
743
+ description: >-
744
+ Encrypted DEKs, paired with public key Id they were encrypted with.
745
+ All encrypted data in MessageRequest will be encrypted with same AES generated key.
746
+ The key will be encrypted with multiple public keys, one for each of the services that can decrypt it.
747
+ required:
748
+ - publicKeyHash
749
+ - encryptedDataEncryptionKey
750
+ properties:
751
+ publicKeyHash:
752
+ description: Public key id in uuid format
753
+ type: string
754
+ format: uuid
755
+ encryptedDataEncryptionKey:
756
+ type: string
757
+ description: RSA encrypted random AES-256 key
758
+ minLength: 1
759
+
760
+ Interchange:
761
+ type: object
762
+ additionalProperties: false
763
+ properties:
764
+ acquirerGroupIdentifier:
765
+ type: string
766
+ minLength: 1
767
+ issuerGroupIdentifier:
768
+ type: string
769
+ minLength: 1
770
+ interchangeAmount:
771
+ $ref: '#/components/schemas/Amount'
772
+
773
+ AddressVerificationData:
774
+ type: object
775
+ additionalProperties: false
776
+ description: >-
777
+ Neither are required as only one may be supplied and there's no
778
+ guarantee as to which one.
779
+ properties:
780
+ streetAddress:
781
+ type: string
782
+ minLength: 1
783
+ postalCode:
784
+ type: string
785
+ minLength: 1
786
+
787
+ ToleranceType:
788
+ type: string
789
+ description: The type of tolerance that should be applied if applicable
790
+ enum:
791
+ - FIXED
792
+ - PERCENTAGE
793
+ - NONE
794
+
795
+ Tolerance:
796
+ type: object
797
+ additionalProperties: false
798
+ description: Minimum expected tolerance as defined by the network
799
+ required:
800
+ - type
801
+ properties:
802
+ type:
803
+ $ref: '#/components/schemas/ToleranceType'
804
+ value:
805
+ type: string
806
+ minLength: 1
807
+
808
+ IssuerNetwork:
809
+ type: string
810
+ description: The network that we received the message on.
811
+ enum:
812
+ - MASTERCARD
813
+ - MDES
814
+ - MNGS
815
+ - STAR
816
+ - VISA
817
+
818
+ AcquirerNetwork:
819
+ type: string
820
+ description: The network on which the message was acquired.
821
+ enum:
822
+ - ALLPOINT
823
+ - CIRRUS
824
+ - DEBIT MASTERCARD
825
+ - CREDIT MASTERCARD
826
+ - DISCOVER
827
+ - INTERLINK
828
+ - MAESTRO
829
+ - OTHER
830
+ - PLUS
831
+ - PULSE
832
+ - STAR
833
+ - STAR POS
834
+ - VISA
835
+ - APPLE PAY
836
+ - GOOGLE PAY
837
+ - SAMSUNG PAY
838
+ - MDES FOR MERCHANTS
839
+ - CLICK TO PAY
840
+
841
+ ResponseCode:
842
+ type: string
843
+ enum:
844
+ - APPROVED
845
+ - REFER TO ISSUER
846
+ - REFER TO ISSUER SPECIAL CONDITION
847
+ - INVALID MERCHANT
848
+ - PICKUP
849
+ - DO NOT HONOR
850
+ - SYSTEM ERROR
851
+ - PICKUP CARD
852
+ - HONOR WITH ID
853
+ - REQUEST IN PROGRESS
854
+ - PARTIAL APPROVAL
855
+ - INVALID TRANSACTION
856
+ - INVALID AMOUNT
857
+ - CARD NOT FOUND
858
+ - REENTER TRANSACTION
859
+ - INVALID RESPONSE
860
+ - UNACCEPTABLE TRANSACTION FEE
861
+ - FILE UPDATE NOT SUPPORTED
862
+ - UNABLE TO LOCATE RECORD
863
+ - DUPLICATE FILE UPDATE
864
+ - FILE UPDATE EDIT ERROR
865
+ - FILE UPDATE FILE LOCKED
866
+ - FILE UPDATE FAILED
867
+ - FORMAT ERROR
868
+ - NO CREDIT ACCOUNT
869
+ - REQUESTED FUNCTION NOT SUPPORTED
870
+ - LOST CARD CAPTURE
871
+ - NO UNIVERSAL ACCOUNT
872
+ - STOLEN CARD CAPTURE
873
+ - NO INVESTMENT ACCOUNT
874
+ - INSUFFICIENT FUNDS
875
+ - NO CHECKING ACCOUNT
876
+ - NO SAVINGS ACCOUNT
877
+ - EXPIRED CARD
878
+ - INCORRECT PIN
879
+ - NO CARD RECORD
880
+ - TRANSACTION NOT PERMITTED TO CARDHOLDER
881
+ - TRANSACTION NOT PERMITTED TO TERMINAL
882
+ - SUSPECTED FRAUD
883
+ - EXCEEDS WITHDRAWAL LIMIT
884
+ - RESTRICTED CARD
885
+ - SECURITY VIOLATION
886
+ - EXCEEDS WITHDRAWAL FREQUENCY LIMIT
887
+ - HARD CAPTURE
888
+ - LATE RESPONSE
889
+ - PIN TRIES EXCEEDED
890
+ - KEY SYNC ERROR
891
+ - CARDHOLDER NOT ELIGIBLE FOR POS
892
+ - ISSUER NOT AVAILABLE
893
+ - DUPLICATE
894
+ - INFORMATION NOT ON FILE
895
+ - CARD VERIFICATION FAILURE
896
+ - CUTOFF IN PROGRESS
897
+ - ISSUER INOPERATIVE
898
+ - TRANSACTION CANNOT COMPLETE LAW VIOLATION
899
+ - DUPLICATE TRANSMISSION
900
+ - RECONCILE ERROR
901
+ - SYSTEM MALFUNCTION
902
+ - CARD VERIFICATION2 FAILURE
903
+ - CARD VERIFICATION3 FAILURE
904
+ - EXPIRATION DATE MISMATCH
905
+ - INACTIVE CARD
906
+ - ITEM SUSPECTED FOR STOP PAY
907
+ - ACCOUNT CLOSED
908
+ - INELIGIBLE ACCOUNT
909
+ - ITEM SUBMITTED MORE THAN TWO TIMES
910
+ - NO ACCT ON FILE
911
+ - UNABLE TO LOCATE
912
+ - GENERAL DENIAL
913
+ - SPECIAL CONDITIONS
914
+ - PIN REQUIRED
915
+ - PAN TRANSFORMATION ERROR
916
+ - RISK BLOCK
917
+ - INVALID ARQC
918
+ - REQUIRE ADDITIONAL AUTHENTICATION
919
+ - OTHER
920
+
921
+ AdviceResponse:
922
+ type: object
923
+ additionalProperties: false
924
+ required:
925
+ - adviceOriginator
926
+ - adviceReason
927
+ - reversalOriginator
928
+ - reversalReason
929
+ description: Data received from the original authorization response.
930
+ properties:
931
+ adviceOriginator:
932
+ $ref: '#/components/schemas/Originator'
933
+ adviceReason:
934
+ $ref: '#/components/schemas/AdviceReason'
935
+ reversalOriginator:
936
+ $ref: '#/components/schemas/Originator'
937
+ reversalReason:
938
+ $ref: '#/components/schemas/ReversalReason'
939
+ authorizationIdResponse:
940
+ type: string
941
+ minLength: 1
942
+ responseCode:
943
+ $ref: '#/components/schemas/ResponseCode'
944
+
945
+ Originator:
946
+ type: string
947
+ enum:
948
+ - NOT APPLICABLE
949
+ - CARD ACCEPTOR
950
+ - ACQUIRER
951
+ - INTERMEDIATE FACILITY
952
+ - CUSTOMER
953
+ - SWITCH
954
+ - UNKNOWN
955
+
956
+ AdviceReason:
957
+ type: string
958
+ enum:
959
+ - NOT APPLICABLE
960
+ - NOT AN ADVICE
961
+ - TIMED OUT REQUEST
962
+ - ISSUER NOT AVAILABLE
963
+ - ISSUER SIGNED OFF
964
+ - WITHIN BUSINESS AGREEMENT
965
+ - KEY NOT ESTABLISHED
966
+ - ISSUER REQUESTED STANDIN
967
+ - OTHER
968
+ - UNKNOWN
969
+
970
+ ReversalReason:
971
+ type: string
972
+ enum:
973
+ - NOT APPLICABLE
974
+ - ISSUER NOT AVAILABLE
975
+ - ISSUER SIGNED OFF
976
+ - WITHIN BUSINESS AGREEMENT
977
+ - TERMINAL PROCESSOR ERROR
978
+ - SYSTEM TIMEOUT
979
+ - TERMINAL DISPENSE ERROR
980
+ - TERMINAL COMMUNICATION ERROR
981
+ - TERMINAL ERROR
982
+ - LATE RESPONSE
983
+ - CUSTOMER CANCELLATION
984
+ - SUSPECTED FRAUD
985
+ - CHIP
986
+ - PARTIAL
987
+ - EDIT ERROR
988
+ - REVISED HOLD AMOUNT
989
+ - UNKNOWN
990
+
991
+ AddressVerificationResult:
992
+ type: string
993
+ enum:
994
+ - ADDRESS MATCH ONLY
995
+ - POSTAL CODE MATCH ONLY
996
+ - FULL POSTAL CODE MATCH ONLY
997
+ - ADDRESS AND POSTAL CODE MATCH
998
+ - ADDRESS AND FULL POSTAL CODE MATCH
999
+ - NO MATCH
1000
+ - UNAVAILABLE
1001
+ - NOT PROVIDED
1002
+
1003
+ ApplicationTransactionCounterValidationResult:
1004
+ type: string
1005
+ enum:
1006
+ - VALID
1007
+ - OUT OF RANGE
1008
+ - DUPLICATE
1009
+ - NOT VALIDATED
1010
+ - BYPASSED
1011
+ - NOT PROVIDED
1012
+
1013
+ SuppliedCardExpirationDate:
1014
+ type: string
1015
+ pattern: '([0-9][0-9])(0[1-9]|1[0-2])'
1016
+ format: YYMM
1017
+ description: |
1018
+ A manually provided card expiration date, such as when entering card information into an online payment form. The date is assumed to be the last millisecond of the month.
1019
+ minLength: 4
1020
+ maxLength: 4
1021
+
1022
+ TrackDataResult:
1023
+ type: string
1024
+ enum:
1025
+ - VALID
1026
+ - MISMATCHED
1027
+ - NOT PROVIDED
1028
+
1029
+ PinValidationResult:
1030
+ type: string
1031
+ enum:
1032
+ - VALID
1033
+ - INVALID
1034
+ - INVALID KEY
1035
+ - UNAVAILABLE
1036
+ - NOT PROVIDED
1037
+
1038
+ VerificationValueResult:
1039
+ type: string
1040
+ enum:
1041
+ - VALID
1042
+ - INVALID
1043
+ - UNAVAILABLE
1044
+ - NOT PROVIDED
1045
+
1046
+ ArqcVerificationResult:
1047
+ type: string
1048
+ enum:
1049
+ - VALID
1050
+ - INVALID
1051
+ - UNAVAILABLE
1052
+ - NOT PROVIDED
1053
+
1054
+ EMV3DSAuthenticationResult:
1055
+ type: string
1056
+ enum:
1057
+ - AUTHENTICATED BY ISSUER
1058
+ - AUTHENTICATED BY NETWORK
1059
+ - UNAUTHENTICATED
1060
+ - UNAVAILABLE
1061
+ - UNKNOWN
1062
+ - NOT PROVIDED
1063
+
1064
+ IIASData:
1065
+ type: object
1066
+ additionalProperties: false
1067
+ required:
1068
+ - merchantId
1069
+ - verificationResult
1070
+ - healthCareAmount
1071
+ - prescriptionAmount
1072
+ - visionAmount
1073
+ properties:
1074
+ merchantId:
1075
+ description: >-
1076
+ IIAS specific merchant ID which is different from the merchant name
1077
+ or card acceptor identification code
1078
+ type: string
1079
+ minLength: 1
1080
+ verificationResult:
1081
+ description: Results of the IIAS verification
1082
+ type: string
1083
+ enum:
1084
+ - UNVERIFIED
1085
+ - VERIFIED
1086
+ - 90PERCENT
1087
+ - NONCERTIFIED
1088
+ healthCareAmount:
1089
+ $ref: '#/components/schemas/Amount'
1090
+ prescriptionAmount:
1091
+ $ref: '#/components/schemas/Amount'
1092
+ visionAmount:
1093
+ $ref: '#/components/schemas/Amount'
1094
+
1095
+ Token:
1096
+ required:
1097
+ - tokenId
1098
+ - status
1099
+ properties:
1100
+ tokenId:
1101
+ type: string
1102
+ maxLength: 64
1103
+ description: A unique Id assigned to a token.
1104
+ status:
1105
+ $ref: '#/components/schemas/TokenStatus'
1106
+ tokenExpiration:
1107
+ type: string
1108
+ maxLength: 4
1109
+ description: The expiration date of the Token PAN given in MMYY format.
1110
+
1111
+ TokenStatus:
1112
+ type: string
1113
+ description: The current status of token.
1114
+ enum:
1115
+ - INACTIVE # Token has not yet been activated
1116
+ - ACTIVE # Active and ready
1117
+ - SUSPENDED # Suspended and unable to be used
1118
+ - DEACTIVATED # Permanently deactivated
1119
+ - UNKNOWN
1120
+
1121
+ TokenNotificationReasonCode:
1122
+ type: string
1123
+ description: The reason code for why the notification is being sent. This applies to all tokens in the Tokens array.
1124
+ enum:
1125
+ - STATUS UPDATE
1126
+ - REDIGITIZATION COMPLETE
1127
+ - DELETED FROM CONSUMER APP # The token may still be active.
1128
+
1129
+ TokenNotificationData:
1130
+ description: Contains all information about tokens.
1131
+ properties:
1132
+ tokens:
1133
+ type: array
1134
+ description: Contains the Tokens which were updated.
1135
+ items:
1136
+ $ref: '#/components/schemas/Token'
1137
+ reasonCode:
1138
+ $ref: '#/components/schemas/TokenNotificationReasonCode'
1139
+ activationCodeExpiration:
1140
+ type: string
1141
+ format: date-time
1142
+ description: The DateTime when the Activation Code is no longer valid.
1143
+ numberOfActivationAttempts:
1144
+ type: number
1145
+ description: The number of times an Activation Code was received to activate the token.
1146
+ numberOfActiveTokens:
1147
+ type: number
1148
+ description: The number of active tokens. Value might be differ from the number of tokens provided in the "tokens" property as this represents all active tokens, not just the ones whose status is being updated. Tokens that have been deleted from the wallet are excluded from the count.
1149
+ tokenAuthentication:
1150
+ type: string
1151
+ description: The indication on whether the given tokens have been authenticated.
1152
+ enum:
1153
+ - AUTHENTICATED
1154
+ - NOT AUTHENTICATED
1155
+ - NOT PROVIDED
1156
+ tokenAssuranceLevel:
1157
+ type: number
1158
+ description: A number that allows the token issuer to indicate the confidence level of the token on whether it belongs to the cardholder it claims to be associated with. Will only be present if tokenAuthentication = AUTHENTICATED
1159
+ suspiciousEvent:
1160
+ description: The event for why the notification is being sent.
1161
+ required:
1162
+ - reason
1163
+ properties:
1164
+ reason:
1165
+ type: string
1166
+ description: |
1167
+ The reason why a suspiciousEvent is provided.
1168
+
1169
+ REPLENISH - There were suspicious ATC values reporting during Replenish.
1170
+ enum:
1171
+ - REPLENISH
1172
+ - OTHER
1173
+ example: 'REPLENISH'
1174
+
1175
+ ActivationTextPhoneNumber:
1176
+ required:
1177
+ - type
1178
+ - value
1179
+ description: Text message to cardholder's mobile phone number. Value will be the cardholders's masked mobile phone number.
1180
+ properties:
1181
+ type:
1182
+ type: string
1183
+ enum:
1184
+ - TEXT
1185
+ value:
1186
+ type: string
1187
+ minLength: 1
1188
+
1189
+ ActivationEmailAccountHolder:
1190
+ required:
1191
+ - type
1192
+ - value
1193
+ description: Email to cardholder's email address. Value will be the cardholder's masked email address.
1194
+ properties:
1195
+ type:
1196
+ type: string
1197
+ enum:
1198
+ - EMAIL
1199
+ value:
1200
+ type: string
1201
+ minLength: 1
1202
+ maxLength: 64
1203
+
1204
+ ActivationCallAutomatedNumber:
1205
+ required:
1206
+ - type
1207
+ - value
1208
+ description: Cardholder-initiated call to automated call center phone number. Value will be the phone number for the cardholder to call.
1209
+ properties:
1210
+ type:
1211
+ type: string
1212
+ enum:
1213
+ - AUTOMATED NUMBER
1214
+ value:
1215
+ type: string
1216
+ minLength: 1
1217
+
1218
+ ActivationCallCustomerSupport:
1219
+ required:
1220
+ - type
1221
+ - value
1222
+ description: Cardholder-initiated call to customer support call center phone number. Value will be the phone number for the cardholder to call.
1223
+ properties:
1224
+ type:
1225
+ type: string
1226
+ enum:
1227
+ - SUPPORT NUMBER
1228
+ value:
1229
+ type: string
1230
+ minLength: 1
1231
+
1232
+ ActivationVisitWebsite:
1233
+ required:
1234
+ - type
1235
+ - value
1236
+ description: Cardholder to visit a website. Value will be the website URL
1237
+ properties:
1238
+ type:
1239
+ type: string
1240
+ enum:
1241
+ - WEBSITE
1242
+ value:
1243
+ type: string
1244
+ maxLength: 64
1245
+
1246
+ ActivationVisitMobileApp:
1247
+ required:
1248
+ - type
1249
+ - value
1250
+ description: Cardholder to use a specific mobile app to activate token. Value will be replaced by a formatted string
1251
+ properties:
1252
+ type:
1253
+ type: string
1254
+ enum:
1255
+ - APP
1256
+ value:
1257
+ type: string
1258
+ maxLength: 64
1259
+
1260
+ ActivationCallCardHolderNumber:
1261
+ required:
1262
+ - type
1263
+ - value
1264
+ description: Issuer-initiated voice call to cardholder's phone. Value will be the cardholder's masked voice call phone number
1265
+ properties:
1266
+ type:
1267
+ type: string
1268
+ enum:
1269
+ - CARDHOLDER NUMBER
1270
+ value:
1271
+ type: string
1272
+ minLength: 1
1273
+
1274
+ ActivationMethod:
1275
+ oneOf:
1276
+ - $ref: '#/components/schemas/ActivationTextPhoneNumber'
1277
+ - $ref: '#/components/schemas/ActivationEmailAccountHolder'
1278
+ - $ref: '#/components/schemas/ActivationCallAutomatedNumber'
1279
+ - $ref: '#/components/schemas/ActivationCallCustomerSupport'
1280
+ - $ref: '#/components/schemas/ActivationVisitWebsite'
1281
+ - $ref: '#/components/schemas/ActivationVisitMobileApp'
1282
+ - $ref: '#/components/schemas/ActivationCallCardHolderNumber'
1283
+
1284
+ RecommendationReason:
1285
+ type: string
1286
+ enum:
1287
+ - ACCOUNT TOO NEW SINCE LAUNCH
1288
+ - ACCOUNT TOO NEW
1289
+ - ACCOUNT CARD TOO NEW
1290
+ - ACCOUNT RECENTLY CHANGED
1291
+ - SUSPICIOUS ACTIVITY
1292
+ - INACTIVE ACCOUNT
1293
+ - HAS SUSPENDED TOKENS
1294
+ - DEVICE RECENTLY LOST
1295
+ - TOO MANY RECENT ATTEMPTS
1296
+ - TOO MANY RECENT TOKENS
1297
+ - TOO MANY DIFFERENT CARDHOLDERS
1298
+ - LOW DEVICE SCORE
1299
+ - LOW ACCOUNT SCORE
1300
+ - OUTSIDE HOME TERRITORY
1301
+ - UNABLE TO ASSESS
1302
+ - HIGH RISK
1303
+ - LOW PHONE NUMBER SCORE
1304
+ - LONG ACCOUNT TENURE
1305
+ - GOOD ACTIVITY HISTORY
1306
+ - ADDITIONAL DEVICE
1307
+ - SOFTWARE UPDATE
1308
+ - OTHER
1309
+ example: 'ACCOUNT TOO NEW'
1310
+
1311
+ RecommendedDecision:
1312
+ type: string
1313
+ description: The decision recommended by the Wallet Provider.
1314
+ enum:
1315
+ - APPROVED
1316
+ - DECLINED
1317
+ - REQUIRE ADDITIONAL AUTHENTICATION
1318
+ example: 'APPROVED'
1319
+
1320
+ WalletProviderScore:
1321
+ type: string
1322
+ description: Score given by the Wallet Provider on their confidence level of a particular property. Value always between 1 and 5.
1323
+ enum:
1324
+ - SCORE 1
1325
+ - SCORE 2
1326
+ - SCORE 3
1327
+ - SCORE 4
1328
+ - SCORE 5
1329
+ - NOT PROVIDED
1330
+ example: SCORE 4
1331
+
1332
+ WalletProviderDecisioning:
1333
+ required:
1334
+ - recommendedDecision
1335
+ - deviceScore
1336
+ - accountScore
1337
+ - phoneNumberScore
1338
+ - recommendationReasons
1339
+ properties:
1340
+ recommendedDecision:
1341
+ $ref: '#/components/schemas/RecommendedDecision'
1342
+ deviceScore:
1343
+ $ref: '#/components/schemas/WalletProviderScore'
1344
+ accountScore:
1345
+ $ref: '#/components/schemas/WalletProviderScore'
1346
+ phoneNumberScore:
1347
+ $ref: '#/components/schemas/WalletProviderScore'
1348
+ recommendationReasons:
1349
+ type: array
1350
+ description: Reasons provided to the Wallet Provider on how the recommended decision was reached.
1351
+ minLength: 0
1352
+ items:
1353
+ $ref: '#/components/schemas/RecommendationReason'
1354
+
1355
+ TokenizationData:
1356
+ description: All relevant data relevant primarily the process of tokenization.
1357
+ properties:
1358
+ activationCode:
1359
+ type: string
1360
+ minLength: 1
1361
+ maxLength: 32
1362
+ description: The Activation Code to be distributed for tokenization.
1363
+ tokenId:
1364
+ type: string
1365
+ maxLength: 64
1366
+ description: A unique id assigned by the party that initiated the tokenization.
1367
+ tokenType:
1368
+ type: string
1369
+ description: The type of token requested for this tokenization.
1370
+ enum:
1371
+ - EMBEDDED SECURE ELEMENT
1372
+ - CLOUD
1373
+ - STATIC
1374
+ tokenRequestorId:
1375
+ type: string
1376
+ minLength: 11
1377
+ maxLength: 11
1378
+ description: The Id of the party that requested the tokenization.
1379
+ activationMethod:
1380
+ $ref: '#/components/schemas/ActivationMethod'
1381
+ walletProviderDecisioning:
1382
+ $ref: '#/components/schemas/WalletProviderDecisioning'
1383
+
1384
+ ChipData:
1385
+ type: object
1386
+ additionalProperties: false
1387
+ required:
1388
+ - applicationId
1389
+ - applicationTransactionCounter
1390
+ - amountAuthorized
1391
+ - amountOther
1392
+ properties:
1393
+ applicationId:
1394
+ description: Application identifier that was used on the chip
1395
+ type: string
1396
+ minLength: 1
1397
+ applicationTransactionCounter:
1398
+ description: Application transaction counter generated by the chip
1399
+ type: string
1400
+ minLength: 1
1401
+ amountAuthorized:
1402
+ $ref: '#/components/schemas/Amount'
1403
+ amountOther:
1404
+ $ref: '#/components/schemas/Amount'
1405
+
1406
+ FeeType:
1407
+ type: string
1408
+ enum:
1409
+ - CONVENIENCE
1410
+ - TRANSACTION
1411
+ - CURRENCY CONVERSION ASSESSMENT
1412
+ - ISSUER CURRENCY CONVERSION ASSESSMENT
1413
+ - SURCHARGE
1414
+ - OPTIONAL ISSUER
1415
+ - PROCESSING
1416
+ - FOREIGN EXCHANGE
1417
+
1418
+ FeeApplication:
1419
+ type: string
1420
+ description: >
1421
+ Indicates whether the fee should be applied to a cardholder's account (SETTLE) or recorded for information
1422
+ purposes only (MEMO). Examples of MEMO fees are currency conversion fees (already in the settlement amount) and
1423
+ interchange fees.
1424
+ enum:
1425
+ - MEMO
1426
+ - SETTLE
1427
+
1428
+ Fee:
1429
+ type: object
1430
+ additionalProperties: false
1431
+ required:
1432
+ - type
1433
+ - application
1434
+ - transaction
1435
+ - settlement
1436
+ properties:
1437
+ type:
1438
+ $ref: '#/components/schemas/FeeType'
1439
+ application:
1440
+ $ref: '#/components/schemas/FeeApplication'
1441
+ transaction:
1442
+ $ref: '#/components/schemas/Amount'
1443
+ settlement:
1444
+ $ref: '#/components/schemas/Amount'
1445
+
1446
+ File:
1447
+ type: object
1448
+ additionalProperties: false
1449
+ required:
1450
+ - fileIdentifier
1451
+ - fileDescription
1452
+ - recordIdentifier
1453
+ - fileDateTime
1454
+ properties:
1455
+ fileIdentifier:
1456
+ type: string
1457
+ minLength: 1
1458
+ description: A unique identifier for the file in which this message exists. Often will be the name of the file.
1459
+ fileDescription:
1460
+ type: string
1461
+ minLength: 1
1462
+ description: A description of the file whose usage depends on the type of file that was processed.
1463
+ recordIdentifier:
1464
+ type: string
1465
+ minLength: 1
1466
+ description: A unique identifier for this message in the processed file. Often this will be the record number.
1467
+ fileDateTime:
1468
+ type: string
1469
+ minLength: 1
1470
+ format: date-time
1471
+ description: A timestamp associated with the whole file not the individual message.
1472
+
1473
+ NewRequest:
1474
+ type: object
1475
+ additionalProperties: false
1476
+ required:
1477
+ - messageId
1478
+ - cardId
1479
+ - receivedDateTime
1480
+ - categorization
1481
+ - accounts
1482
+ - transactionAmount
1483
+ - transactionFeeAmount
1484
+ - settlementAmount
1485
+ - settlementFeeAmount
1486
+ - cashBackAmount
1487
+ - feeDetails
1488
+ - transmissionDateTime
1489
+ - systemTraceAuditNumber
1490
+ - retrievalReferenceNumber
1491
+ - settlementDate
1492
+ - captureDate
1493
+ - encryptedKeys
1494
+ - merchant
1495
+ - acquirer
1496
+ - network
1497
+ - acquirerNetwork
1498
+ - incremental
1499
+ - lastClearing
1500
+ - recurring
1501
+ - minimumTolerance
1502
+ - track1DataResult
1503
+ - track2DataResult
1504
+ - pinValidationResult
1505
+ - verificationValueValidationResult
1506
+ - verificationValue2ValidationResult
1507
+ - verificationValue3ValidationResult
1508
+ - dynamicVerificationValueValidationResult
1509
+ - arqcValidationResult
1510
+ description: Message data that is being processed
1511
+ properties:
1512
+ messageId:
1513
+ type: string
1514
+ minLength: 1
1515
+ cardId:
1516
+ type: string
1517
+ minLength: 1
1518
+ tokenId:
1519
+ type: string
1520
+ minLength: 1
1521
+ issuerLifecycleId:
1522
+ description: |
1523
+ This value is defined by the issuer to uniquely identify a transaction through its lifecycle.
1524
+ type: string
1525
+ matchedMessageId:
1526
+ type: string
1527
+ minLength: 1
1528
+ description: Set to the message id of any matching message
1529
+ receivedDateTime:
1530
+ type: string
1531
+ minLength: 1
1532
+ format: date-time
1533
+ description: Datetime message was received from the network
1534
+ categorization:
1535
+ $ref: '#/components/schemas/Categorization'
1536
+ accounts:
1537
+ $ref: '#/components/schemas/Accounts'
1538
+ transactionAmount:
1539
+ $ref: '#/components/schemas/Amount'
1540
+ transactionFeeAmount:
1541
+ description: |
1542
+ Fee amount applied by the network or acquirer in the merchant's currency.
1543
+ allOf:
1544
+ - $ref: '#/components/schemas/Amount'
1545
+ settlementAmount:
1546
+ $ref: '#/components/schemas/Amount'
1547
+ settlementFeeAmount:
1548
+ description: |
1549
+ Fee amount applied by the network or acquirer in the BIN currency.
1550
+ allOf:
1551
+ - $ref: '#/components/schemas/Amount'
1552
+ cashBackAmount:
1553
+ $ref: '#/components/schemas/Amount'
1554
+ feeDetails:
1555
+ type: array
1556
+ description: Details about the fees that went into the transaction and settlement fee amounts
1557
+ items:
1558
+ $ref: '#/components/schemas/Fee'
1559
+ settlementConversion:
1560
+ $ref: '#/components/schemas/SettlementConversion'
1561
+ transmissionDateTime:
1562
+ type: string
1563
+ minLength: 1
1564
+ format: date-time
1565
+ description: Network Transaction received Date and Time.
1566
+ systemTraceAuditNumber:
1567
+ type: number
1568
+ acquirerLifecycleId:
1569
+ description: |
1570
+ This value is defined by the acquirer to uniquely identify a transaction through its lifecycle.
1571
+ type: string
1572
+ retrievalReferenceNumber:
1573
+ type: string
1574
+ acquirerReferenceData:
1575
+ description: |
1576
+ This value is a numeric string of data supplied by the acquirer in an acquirer-originated message.
1577
+ type: string
1578
+ settlementDate:
1579
+ type: string
1580
+ minLength: 1
1581
+ format: date
1582
+ captureDate:
1583
+ type: string
1584
+ minLength: 1
1585
+ format: date
1586
+ encryptedKeys:
1587
+ description: An array of encrypted AES keys that will be decrypted using the appropriate private key
1588
+ minLength: 0
1589
+ type: array
1590
+ items:
1591
+ $ref: '#/components/schemas/EncryptedKey'
1592
+ merchant:
1593
+ $ref: '#/components/schemas/Merchant'
1594
+ acquirer:
1595
+ $ref: '#/components/schemas/Acquirer'
1596
+ authorizationLifeCycle:
1597
+ $ref: '#/components/schemas/AuthorizationLifeCycle'
1598
+ replacementAmounts:
1599
+ $ref: '#/components/schemas/ReplacementAmounts'
1600
+ network:
1601
+ $ref: '#/components/schemas/IssuerNetwork'
1602
+ acquirerNetwork:
1603
+ $ref: '#/components/schemas/AcquirerNetwork'
1604
+ interchange:
1605
+ $ref: '#/components/schemas/Interchange'
1606
+ file:
1607
+ $ref: '#/components/schemas/File'
1608
+ addressVerificationData:
1609
+ $ref: '#/components/schemas/AddressVerificationData'
1610
+ incremental:
1611
+ description: >-
1612
+ Indicator whether this has been identified by the acquirer as an
1613
+ incremental authorization or not.
1614
+ type: boolean
1615
+ lastClearing:
1616
+ description: >-
1617
+ Indicator whether this has been identified by the acquirer as
1618
+ the last clearing in a sequence or not.
1619
+ type: boolean
1620
+ recurring:
1621
+ description: >-
1622
+ Indicator whether this has been identified by the acquirer as a
1623
+ recurring transaction or not.
1624
+ type: boolean
1625
+ iiasData:
1626
+ $ref: '#/components/schemas/IIASData'
1627
+ minimumTolerance:
1628
+ $ref: '#/components/schemas/Tolerance'
1629
+ tokenization:
1630
+ $ref: '#/components/schemas/TokenizationData'
1631
+ tokenNotification:
1632
+ $ref: '#/components/schemas/TokenNotificationData'
1633
+ chipData:
1634
+ $ref: '#/components/schemas/ChipData'
1635
+ emv3DSecureData:
1636
+ $ref: '#/components/schemas/EMV3DSecureData'
1637
+ adviceResponse:
1638
+ $ref: '#/components/schemas/AdviceResponse'
1639
+ suppliedCardExpirationDate:
1640
+ $ref: '#/components/schemas/SuppliedCardExpirationDate'
1641
+ track1DataResult:
1642
+ $ref: '#/components/schemas/TrackDataResult'
1643
+ track2DataResult:
1644
+ $ref: '#/components/schemas/TrackDataResult'
1645
+ pinValidationResult:
1646
+ $ref: '#/components/schemas/PinValidationResult'
1647
+ verificationValueValidationResult:
1648
+ $ref: '#/components/schemas/VerificationValueResult'
1649
+ verificationValue2ValidationResult:
1650
+ $ref: '#/components/schemas/VerificationValueResult'
1651
+ verificationValue3ValidationResult:
1652
+ $ref: '#/components/schemas/VerificationValueResult'
1653
+ dynamicVerificationValueValidationResult:
1654
+ $ref: '#/components/schemas/VerificationValueResult'
1655
+ arqcValidationResult:
1656
+ $ref: '#/components/schemas/ArqcVerificationResult'
1657
+ emv3DSAuthenticationResult:
1658
+ $ref: '#/components/schemas/EMV3DSAuthenticationResult'
1659
+
1660
+ EMV3DSecureData:
1661
+ description: |
1662
+ EMV 3-D Secure is a messaging protocol that enables consumers to authenticate themselves with their card issuer
1663
+ when making card-not-present (CNP) e-commerce purchases. The additional security layer helps prevent unauthorized CNP
1664
+ transactions and protects the merchant from exposure to CNP fraud.
1665
+ oneOf:
1666
+ - $ref: '#/components/schemas/EMV3DSecureMastercard'
1667
+
1668
+ EMV3DSecureMastercard:
1669
+ type: object
1670
+ required:
1671
+ - network
1672
+ - securityProtocol
1673
+ - cardholderAuthentication
1674
+ - ucafCollectionIndicator
1675
+ - programProtocolIndicator
1676
+ - cardholderAuthenticationFormat
1677
+ properties:
1678
+ network:
1679
+ type: string
1680
+ description: |
1681
+ This value indicates the network used for the transaction. This value also serves as the discriminator
1682
+ for the EMV3DSecureData object.
1683
+ enum:
1684
+ - MASTERCARD
1685
+ securityProtocol:
1686
+ type: string
1687
+ enum:
1688
+ - CHANNEL
1689
+ - UNKNOWN
1690
+ - NOT PROVIDED
1691
+ cardholderAuthentication:
1692
+ type: string
1693
+ enum:
1694
+ - CARDHOLDER CERTIFICATE NOT USED
1695
+ - MASTERPASS
1696
+ - TOKENIZED
1697
+ - UNKNOWN
1698
+ - NOT PROVIDED
1699
+ ucafCollectionIndicator:
1700
+ type: string
1701
+ description: |
1702
+ This data describes the merchant support and issuer expectations
1703
+ regarding the Universal Cardholder Authentication Field (UCAF) and
1704
+ whether Account Holder Authentication Value (AAV) data is present and authenticated.
1705
+ enum:
1706
+ - NOT SUPPORTED
1707
+ - UCAF MUST BE PRESENT
1708
+ - UCAF MUST BE PRESENT AND AAV AUTHENTICATED
1709
+ - AAV PRESENT
1710
+ - ISSUER RISK BASED DECISIONING
1711
+ - MERCHANT RISK BASED DECISIONING
1712
+ - PARTIAL SHIPMENT OR RECURRING PAYMENT
1713
+ - UNKNOWN
1714
+ - NOT PROVIDED
1715
+ programProtocolIndicator:
1716
+ type: string
1717
+ enum:
1718
+ - EMV 3-D SECURE VERSION 2.1
1719
+ - EMV 3-D SECURE VERSION 2.2
1720
+ - EMV 3-D SECURE VERSION 2.3
1721
+ - EMV 3-D SECURE VERSION 2.4
1722
+ - EMV 3-D SECURE VERSION 2.5
1723
+ - EMV 3-D SECURE VERSION 2.6
1724
+ - EMV 3-D SECURE VERSION 2.7
1725
+ - EMV 3-D SECURE VERSION 2.8
1726
+ - EMV 3-D SECURE VERSION 2.9
1727
+ - UNKNOWN
1728
+ - NOT PROVIDED
1729
+ cardholderAuthenticationFormat:
1730
+ type: string
1731
+ enum:
1732
+ - SECURE CODE
1733
+ - SECURE CODE FOR AAV
1734
+ - UNKNOWN
1735
+ - NOT PROVIDED
1736
+ universalCardholderAuthenticationField:
1737
+ type: string
1738
+ description: |
1739
+ The Universal Cardholder Authentication Field (UCAF) is a data element that is used to convey
1740
+ cardholder authentication data from the merchant to the issuer.
1741
+
1742
+ Request:
1743
+ type: object
1744
+ additionalProperties: false
1745
+ required:
1746
+ - messageId
1747
+ - cardId
1748
+ - receivedDateTime
1749
+ - categorization
1750
+ - accounts
1751
+ - transactionAmount
1752
+ - transactionFeeAmount
1753
+ - settlementAmount
1754
+ - settlementFeeAmount
1755
+ - cashBackAmount
1756
+ - feeDetails
1757
+ - transmissionDateTime
1758
+ - systemTraceAuditNumber
1759
+ - retrievalReferenceNumber
1760
+ - settlementDate
1761
+ - captureDate
1762
+ - encryptedKeys
1763
+ - merchant
1764
+ - acquirer
1765
+ - network
1766
+ - acquirerNetwork
1767
+ - incremental
1768
+ - lastClearing
1769
+ - recurring
1770
+ - minimumTolerance
1771
+ - track1DataResult
1772
+ - track2DataResult
1773
+ - pinValidationResult
1774
+ - verificationValueValidationResult
1775
+ - verificationValue2ValidationResult
1776
+ - verificationValue3ValidationResult
1777
+ - dynamicVerificationValueValidationResult
1778
+ - arqcValidationResult
1779
+ - createdOn
1780
+ description: Message data that is being processed
1781
+ properties:
1782
+ messageId:
1783
+ type: string
1784
+ minLength: 1
1785
+ cardId:
1786
+ type: string
1787
+ minLength: 1
1788
+ tokenId:
1789
+ type: string
1790
+ minLength: 1
1791
+ issuerLifecycleId:
1792
+ description: |
1793
+ This value is defined by the issuer to uniquely identify a transaction through its lifecycle.
1794
+ type: string
1795
+ matchedMessageId:
1796
+ type: string
1797
+ minLength: 1
1798
+ description: Set to the message id of any matching message
1799
+ receivedDateTime:
1800
+ type: string
1801
+ minLength: 1
1802
+ format: date-time
1803
+ description: Datetime message was received from the network
1804
+ categorization:
1805
+ $ref: '#/components/schemas/Categorization'
1806
+ accounts:
1807
+ $ref: '#/components/schemas/Accounts'
1808
+ transactionAmount:
1809
+ $ref: '#/components/schemas/Amount'
1810
+ transactionFeeAmount:
1811
+ description: |
1812
+ Fee amount applied by the network or acquirer in the merchant's currency.
1813
+ allOf:
1814
+ - $ref: '#/components/schemas/Amount'
1815
+ settlementAmount:
1816
+ $ref: '#/components/schemas/Amount'
1817
+ settlementFeeAmount:
1818
+ description: |
1819
+ Fee amount applied by the network or acquirer in the BIN currency.
1820
+ allOf:
1821
+ - $ref: '#/components/schemas/Amount'
1822
+ cashBackAmount:
1823
+ $ref: '#/components/schemas/Amount'
1824
+ feeDetails:
1825
+ type: array
1826
+ description: Details about the fees that went into the transaction and settlement fee amounts
1827
+ items:
1828
+ $ref: '#/components/schemas/Fee'
1829
+ settlementConversion:
1830
+ $ref: '#/components/schemas/SettlementConversion'
1831
+ transmissionDateTime:
1832
+ type: string
1833
+ minLength: 1
1834
+ format: date-time
1835
+ description: Network Transaction received Date and Time.
1836
+ systemTraceAuditNumber:
1837
+ type: number
1838
+ acquirerLifecycleId:
1839
+ description: |
1840
+ This value is defined by the acquirer to uniquely identify a transaction through its lifecycle.
1841
+ type: string
1842
+ retrievalReferenceNumber:
1843
+ type: string
1844
+ acquirerReferenceData:
1845
+ description: |
1846
+ This value is a numeric string of data supplied by the acquirer in an acquirer-originated message.
1847
+ type: string
1848
+ settlementDate:
1849
+ type: string
1850
+ minLength: 1
1851
+ captureDate:
1852
+ type: string
1853
+ minLength: 1
1854
+ encryptedKeys:
1855
+ description: An array of encrypted AES keys that will be decrypted using the appropriate private key
1856
+ minLength: 0
1857
+ type: array
1858
+ items:
1859
+ $ref: '#/components/schemas/EncryptedKey'
1860
+ merchant:
1861
+ $ref: '#/components/schemas/Merchant'
1862
+ acquirer:
1863
+ $ref: '#/components/schemas/Acquirer'
1864
+ authorizationLifeCycle:
1865
+ $ref: '#/components/schemas/AuthorizationLifeCycle'
1866
+ replacementAmounts:
1867
+ $ref: '#/components/schemas/ReplacementAmounts'
1868
+ network:
1869
+ $ref: '#/components/schemas/IssuerNetwork'
1870
+ acquirerNetwork:
1871
+ $ref: '#/components/schemas/AcquirerNetwork'
1872
+ interchange:
1873
+ $ref: '#/components/schemas/Interchange'
1874
+ file:
1875
+ $ref: '#/components/schemas/File'
1876
+ addressVerificationData:
1877
+ $ref: '#/components/schemas/AddressVerificationData'
1878
+ incremental:
1879
+ description: >-
1880
+ Indicator whether this has been identified by the acquirer as an
1881
+ incremental authorization or not.
1882
+ type: boolean
1883
+ lastClearing:
1884
+ description: >-
1885
+ Indicator whether this has been identified by the acquirer as
1886
+ the last clearing in a sequence or not.
1887
+ type: boolean
1888
+ recurring:
1889
+ description: >-
1890
+ Indicator whether this has been identified by the acquirer as a
1891
+ recurring transaction or not.
1892
+ type: boolean
1893
+ iiasData:
1894
+ $ref: '#/components/schemas/IIASData'
1895
+ minimumTolerance:
1896
+ $ref: '#/components/schemas/Tolerance'
1897
+ tokenization:
1898
+ $ref: '#/components/schemas/TokenizationData'
1899
+ tokenNotification:
1900
+ $ref: '#/components/schemas/TokenNotificationData'
1901
+ chipData:
1902
+ $ref: '#/components/schemas/ChipData'
1903
+ emv3DSecureData:
1904
+ $ref: '#/components/schemas/EMV3DSecureData'
1905
+ adviceResponse:
1906
+ $ref: '#/components/schemas/AdviceResponse'
1907
+ suppliedCardExpirationDate:
1908
+ $ref: '#/components/schemas/SuppliedCardExpirationDate'
1909
+ track1DataResult:
1910
+ $ref: '#/components/schemas/TrackDataResult'
1911
+ track2DataResult:
1912
+ $ref: '#/components/schemas/TrackDataResult'
1913
+ pinValidationResult:
1914
+ $ref: '#/components/schemas/PinValidationResult'
1915
+ verificationValueValidationResult:
1916
+ $ref: '#/components/schemas/VerificationValueResult'
1917
+ verificationValue2ValidationResult:
1918
+ $ref: '#/components/schemas/VerificationValueResult'
1919
+ verificationValue3ValidationResult:
1920
+ $ref: '#/components/schemas/VerificationValueResult'
1921
+ dynamicVerificationValueValidationResult:
1922
+ $ref: '#/components/schemas/VerificationValueResult'
1923
+ arqcValidationResult:
1924
+ $ref: '#/components/schemas/ArqcVerificationResult'
1925
+ emv3DSAuthenticationResult:
1926
+ $ref: '#/components/schemas/EMV3DSAuthenticationResult'
1927
+ createdOn:
1928
+ type: string
1929
+ format: date-time
1930
+ description: Message record creation date/time
1931
+
1932
+ PickedRequest:
1933
+ type: object
1934
+ additionalProperties: false
1935
+ description: Picked Message data that is being processed
1936
+ required:
1937
+ - createdOn
1938
+ properties:
1939
+ cardId:
1940
+ type: string
1941
+ minLength: 1
1942
+ messageId:
1943
+ type: string
1944
+ minLength: 1
1945
+ matchedMessageId:
1946
+ type: string
1947
+ minLength: 1
1948
+ description: Set to the message id of any matching message
1949
+ receivedDateTime:
1950
+ type: string
1951
+ minLength: 1
1952
+ format: date-time
1953
+ description: Datetime message was received from the network
1954
+ categorization:
1955
+ $ref: '#/components/schemas/Categorization'
1956
+ settlementAmount:
1957
+ $ref: '#/components/schemas/Amount'
1958
+ adviceResponse:
1959
+ $ref: '#/components/schemas/AdviceResponse'
1960
+ createdOn:
1961
+ type: string
1962
+ format: date-time
1963
+ description: Message record creation date/time
1964
+
1965
+ TagResult:
1966
+ type: object
1967
+ additionalProperties: false
1968
+ description: The tag that matches and any maximum amount usable for the tag
1969
+ required:
1970
+ - tag
1971
+ - maxAmount
1972
+ properties:
1973
+ tag:
1974
+ type: string
1975
+ description: Applicable tag for the classification
1976
+ minLength: 1
1977
+ maxAmount:
1978
+ type: string
1979
+ description: Maximum amount that is applicable for the tag
1980
+ minLength: 1
1981
+
1982
+ DeclineReasonsEnum:
1983
+ type: string
1984
+ enum:
1985
+ - TRANSACTION CATEGORY NOT ALLOWED
1986
+ - INTERNATIONAL TRANSACTIONS NOT ALLOWED
1987
+ - RESTRICTED COUNTRY
1988
+ - RESTRICTED MERCHANT TYPE
1989
+ - RESTRICTED MERCHANT
1990
+ - INVALID PIN
1991
+ - PIN BLOCK ERROR
1992
+ - PIN VALIDATION UNAVAILABLE
1993
+ - INVALID VERIFICATION VALUE
1994
+ - INVALID VERIFICATION VALUE2
1995
+ - INVALID VERIFICATION VALUE3
1996
+ - INVALID DYNAMIC VERIFICATION VALUE
1997
+ - INVALID ATC
1998
+ - INVALID ARQC
1999
+ - NO CVN SUPPLIED
2000
+ - VERIFICATION VALUE VALIDATION UNAVAILABLE
2001
+ - VERIFICATION VALUE2 VALIDATION UNAVAILABLE
2002
+ - VERIFICATION VALUE3 VALIDATION UNAVAILABLE
2003
+ - DYNAMIC VERIFICATION VALUE VALIDATION UNAVAILABLE
2004
+ - ARQC VALIDATION UNAVAILABLE
2005
+ - CARD NOT FOUND
2006
+ - CARD NOT CURRENT
2007
+ - EXPIRED CARD
2008
+ - BLOCKED CARD
2009
+ - LOCKED CARD
2010
+ - INACTIVE CARD
2011
+ - INVALID CARD DATA
2012
+ - UNSUPPORTED OPERATION
2013
+ - INSUFFICIENT FUNDS
2014
+ - AMOUNT LIMIT EXCEEDED
2015
+ - COUNT LIMIT EXCEEDED
2016
+ - MINIMUM AMOUNT REQUIRED
2017
+ - PIN RETRY LIMIT EXCEEDED
2018
+ - BUSINESS RULES
2019
+ - SUSPECTED FRAUD
2020
+ - INVALID ACCOUNT SELECTED
2021
+ - INVALID MESSAGE DATA
2022
+ - STOP RECURRING
2023
+ - GENERAL DECLINE
2024
+ - INCORRECT ACTIVATION CODE
2025
+ - INCORRECT ACTIVATION CODE RETRIES EXCEEDED
2026
+ - EXPIRED ACTIVATION CODE
2027
+ - REQUIRE ADDITIONAL AUTHENTICATION
2028
+ - WALLET RECOMMENDED DECLINE
2029
+ - INTERNAL SERVICE ERROR
2030
+ - TRANSIENT RETRYABLE ERROR
2031
+ - CONFIGURATION LOCK
2032
+
2033
+ AccountUsage:
2034
+ type: object
2035
+ additionalProperties: false
2036
+ required:
2037
+ - accountId
2038
+ - debitCredit
2039
+ - amount
2040
+ properties:
2041
+ accountId:
2042
+ type: string
2043
+ minLength: 1
2044
+ debitCredit:
2045
+ $ref: '#/components/schemas/DebitCredit'
2046
+ amount:
2047
+ type: string
2048
+ minLength: 1
2049
+
2050
+ CurrencyAlphabeticCode:
2051
+ type: string
2052
+ description: Currency codes
2053
+ enum:
2054
+ - AED
2055
+ - AFN
2056
+ - ALL
2057
+ - AMD
2058
+ - ANG
2059
+ - AOA
2060
+ - ARS
2061
+ - AUD
2062
+ - AWG
2063
+ - AZN
2064
+ - BAM
2065
+ - BBD
2066
+ - BDT
2067
+ - BGN
2068
+ - BHD
2069
+ - BIF
2070
+ - BMD
2071
+ - BND
2072
+ - BOB
2073
+ - BOV
2074
+ - BRL
2075
+ - BSD
2076
+ - BTN
2077
+ - BWP
2078
+ - BYN
2079
+ - BZD
2080
+ - CAD
2081
+ - CDF
2082
+ - CHE
2083
+ - CHF
2084
+ - CHW
2085
+ - CLF
2086
+ - CLP
2087
+ - CNY
2088
+ - COP
2089
+ - COU
2090
+ - CRC
2091
+ - CUC
2092
+ - CUP
2093
+ - CVE
2094
+ - CZK
2095
+ - DJF
2096
+ - DKK
2097
+ - DOP
2098
+ - DZD
2099
+ - EGP
2100
+ - ERN
2101
+ - ETB
2102
+ - EUR
2103
+ - FJD
2104
+ - FKP
2105
+ - GBP
2106
+ - GEL
2107
+ - GHS
2108
+ - GIP
2109
+ - GMD
2110
+ - GNF
2111
+ - GTQ
2112
+ - GYD
2113
+ - HKD
2114
+ - HNL
2115
+ - HRK
2116
+ - HTG
2117
+ - HUF
2118
+ - IDR
2119
+ - ILS
2120
+ - INR
2121
+ - IQD
2122
+ - IRR
2123
+ - ISK
2124
+ - JMD
2125
+ - JOD
2126
+ - JPY
2127
+ - KES
2128
+ - KGS
2129
+ - KHR
2130
+ - KMF
2131
+ - KPW
2132
+ - KRW
2133
+ - KWD
2134
+ - KYD
2135
+ - KZT
2136
+ - LAK
2137
+ - LBP
2138
+ - LKR
2139
+ - LRD
2140
+ - LSL
2141
+ - LYD
2142
+ - MAD
2143
+ - MDL
2144
+ - MGA
2145
+ - MKD
2146
+ - MMK
2147
+ - MNT
2148
+ - MOP
2149
+ - MRU
2150
+ - MUR
2151
+ - MVR
2152
+ - MWK
2153
+ - MXN
2154
+ - MXV
2155
+ - MYR
2156
+ - MZN
2157
+ - NAD
2158
+ - NGN
2159
+ - NIO
2160
+ - NOK
2161
+ - NPR
2162
+ - NZD
2163
+ - OMR
2164
+ - PAB
2165
+ - PEN
2166
+ - PGK
2167
+ - PHP
2168
+ - PKR
2169
+ - PLN
2170
+ - PYG
2171
+ - QAR
2172
+ - RON
2173
+ - RSD
2174
+ - RUB
2175
+ - RWF
2176
+ - SAR
2177
+ - SBD
2178
+ - SCR
2179
+ - SDG
2180
+ - SEK
2181
+ - SGD
2182
+ - SHP
2183
+ - SLL
2184
+ - SOS
2185
+ - SRD
2186
+ - SSP
2187
+ - STN
2188
+ - SVC
2189
+ - SYP
2190
+ - SZL
2191
+ - THB
2192
+ - TJS
2193
+ - TMT
2194
+ - TND
2195
+ - TOP
2196
+ - TRY
2197
+ - TTD
2198
+ - TWD
2199
+ - TZS
2200
+ - UAH
2201
+ - UGX
2202
+ - USD
2203
+ - USN
2204
+ - UYI
2205
+ - UYU
2206
+ - UYW
2207
+ - UZS
2208
+ - VES
2209
+ - VND
2210
+ - VUV
2211
+ - WST
2212
+ - XAF
2213
+ - XAG
2214
+ - XAU
2215
+ - XBA
2216
+ - XBB
2217
+ - XBC
2218
+ - XBD
2219
+ - XCD
2220
+ - XDR
2221
+ - XOF
2222
+ - XPD
2223
+ - XPF
2224
+ - XPT
2225
+ - XSU
2226
+ - XTS
2227
+ - XUA
2228
+ - XXX
2229
+ - YER
2230
+ - ZAR
2231
+ - ZMW
2232
+ - ZWL
2233
+
2234
+ Rate:
2235
+ type: object
2236
+ description: |
2237
+ - The currency conversion rate information.
2238
+ To calculate the conversion rate:
2239
+
2240
+ conversion rate = factor / (10 ^ factor decimal position)
2241
+
2242
+ or, to calculate the target currency amount given a source currency amount:
2243
+
2244
+ target currency amount = (source currency amount * conversion factor) / (10 ^ factor decimal position)
2245
+ additionalProperties: false
2246
+ required:
2247
+ - factor
2248
+ - factorDecimalPosition
2249
+ - effectiveOn
2250
+ properties:
2251
+ factor:
2252
+ description: |
2253
+ This value represents the multiplying factor used to convert a source currency amount to a target currency
2254
+ amount. This value can be used to calculate the conversion rate.
2255
+ type: string
2256
+ pattern: '^\d+$'
2257
+ minLength: 1
2258
+ factorDecimalPosition:
2259
+ description: |
2260
+ This number represents the position the decimal point should be placed, starting from the right. This can be
2261
+ used to calculate the conversion rate.
2262
+ type: integer
2263
+ minimum: 0
2264
+ maximum: 15
2265
+ effectiveOn:
2266
+ type: string
2267
+ description: The date time that the conversion rate went into effect.
2268
+ format: date-time
2269
+
2270
+ AdditionalCurrencyConversionRate:
2271
+ type: object
2272
+ description: |
2273
+ Contains the conversion rate from the settlement currency to a target currency that was in effect when processing this message.
2274
+ The value can be obtained in one of four ways and will be represented by the conversionSource field.
2275
+ additionalProperties: false
2276
+ required:
2277
+ - rate
2278
+ - conversionSource
2279
+ - targetCurrency
2280
+ properties:
2281
+ rate:
2282
+ $ref: '#/components/schemas/Rate'
2283
+ conversionSource:
2284
+ type: string
2285
+ description: |
2286
+ - NONE
2287
+ - The target currency matches the settlement currency.
2288
+ - The rate will be 1.0
2289
+ - example scenario: Settlement Currency = USD, Target Currency = USD, Transaction Currency = EUR
2290
+ - NETWORK
2291
+ - The target currency matches the message's transaction currency.
2292
+ - The rate will be the inverse of the settlementConversion data provided by the network.
2293
+ - example scenario: Settlement Currency = USD, Target Currency = EUR, Transaction Currency = EUR
2294
+ - INTERNAL
2295
+ - 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.
2296
+ - The rate will be the settlement to target currency rate retrieved from the rate service at the time of the transaction.
2297
+ - 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
2298
+ - NOT FOUND
2299
+ - 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.
2300
+ - The rate will be 0.0
2301
+ - 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
2302
+ - NOT APPLICABLE
2303
+ - The incoming message's settlement amount is 0
2304
+ - The rate will be 0.0
2305
+ - example scenarios: tokenization messages, balance inquiries, 0 value transactions
2306
+ enum:
2307
+ - NONE
2308
+ - NETWORK
2309
+ - INTERNAL
2310
+ - NOT FOUND
2311
+ - NOT APPLICABLE
2312
+ targetCurrency:
2313
+ $ref: '#/components/schemas/CurrencyAlphabeticCode'
2314
+
2315
+ NewResponse:
2316
+ type: object
2317
+ additionalProperties: false
2318
+ required:
2319
+ - messageId
2320
+ - cardId
2321
+ - responseCode
2322
+ - declineReasons
2323
+ - capture
2324
+ - requestedAmount
2325
+ - requestedTolerance
2326
+ - requestedFee
2327
+ - requestedTotal
2328
+ - requestedCashBack
2329
+ - approvedAmount
2330
+ - approvedTolerance
2331
+ - approvedFee
2332
+ - approvedTotal
2333
+ - approvedCashBack
2334
+ - pendingAmount
2335
+ - pendingTolerance
2336
+ - pendingFee
2337
+ - pendingTotal
2338
+ - completedAmount
2339
+ - completedTolerance
2340
+ - completedFee
2341
+ - completedTotal
2342
+ - pendingAccounts
2343
+ - completedAccounts
2344
+ - tags
2345
+ - addressVerificationResult
2346
+ - applicationTransactionCounterValidationResult
2347
+ - processedBy
2348
+ properties:
2349
+ messageId:
2350
+ type: string
2351
+ minLength: 1
2352
+ cardId:
2353
+ type: string
2354
+ minLength: 1
2355
+ authorizationIdResponse:
2356
+ type: string
2357
+ minLength: 1
2358
+ responseCode:
2359
+ $ref: '#/components/schemas/ResponseCode'
2360
+ declineReasons:
2361
+ type: array
2362
+ description: Network Transaction decline reasons
2363
+ items:
2364
+ $ref: '#/components/schemas/DeclineReasonsEnum'
2365
+ capture:
2366
+ type: boolean
2367
+ requestedAmount:
2368
+ $ref: '#/components/schemas/Amount'
2369
+ requestedTolerance:
2370
+ $ref: '#/components/schemas/Amount'
2371
+ requestedFee:
2372
+ description: |
2373
+ Fee amount applied by the processor. This value does not include fees applied by
2374
+ the network or acquirer. Those fees are included in requestedAmount and approvedAmount.
2375
+ allOf:
2376
+ - $ref: '#/components/schemas/Amount'
2377
+ requestedTotal:
2378
+ $ref: '#/components/schemas/Amount'
2379
+ requestedCashBack:
2380
+ $ref: '#/components/schemas/Amount'
2381
+ approvedAmount:
2382
+ $ref: '#/components/schemas/Amount'
2383
+ approvedTolerance:
2384
+ $ref: '#/components/schemas/Amount'
2385
+ approvedFee:
2386
+ description: |
2387
+ Fee amount applied by the processor. This value does not include fees applied by
2388
+ the network or acquirer. Those fees are included in requestedAmount and approvedAmount.
2389
+ allOf:
2390
+ - $ref: '#/components/schemas/Amount'
2391
+ approvedTotal:
2392
+ $ref: '#/components/schemas/Amount'
2393
+ approvedCashBack:
2394
+ $ref: '#/components/schemas/Amount'
2395
+ pendingAmount:
2396
+ $ref: '#/components/schemas/Amount'
2397
+ pendingTolerance:
2398
+ $ref: '#/components/schemas/Amount'
2399
+ pendingFee:
2400
+ $ref: '#/components/schemas/Amount'
2401
+ pendingTotal:
2402
+ $ref: '#/components/schemas/Amount'
2403
+ completedAmount:
2404
+ $ref: '#/components/schemas/Amount'
2405
+ completedTolerance:
2406
+ $ref: '#/components/schemas/Amount'
2407
+ completedFee:
2408
+ $ref: '#/components/schemas/Amount'
2409
+ completedTotal:
2410
+ $ref: '#/components/schemas/Amount'
2411
+ availableBalance:
2412
+ $ref: '#/components/schemas/Amount'
2413
+ addressVerificationResult:
2414
+ $ref: '#/components/schemas/AddressVerificationResult'
2415
+ applicationTransactionCounterValidationResult:
2416
+ $ref: '#/components/schemas/ApplicationTransactionCounterValidationResult'
2417
+ entryId:
2418
+ type: string
2419
+ minLength: 1
2420
+ pendingAccounts:
2421
+ type: array
2422
+ description: Accounts where there are still funds pending
2423
+ items:
2424
+ $ref: '#/components/schemas/AccountUsage'
2425
+ completedAccounts:
2426
+ type: array
2427
+ description: Accounts where the funds have completed
2428
+ items:
2429
+ $ref: '#/components/schemas/AccountUsage'
2430
+ holdExpirationDateTime:
2431
+ type: string
2432
+ minLength: 1
2433
+ format: date-time
2434
+ tags:
2435
+ type: array
2436
+ description: List of tags
2437
+ items:
2438
+ $ref: '#/components/schemas/TagResult'
2439
+ tokenization:
2440
+ type: object
2441
+ properties:
2442
+ activationMethods:
2443
+ type: array
2444
+ minLength: 0
2445
+ description: The activation methods to be used for this tokenization. Returning an empty array will mean that no aditional activation methods are required to tokenize, with the except of any pre-configured with the party responsible for initializing the tokenization.
2446
+ items:
2447
+ $ref: '#/components/schemas/ActivationMethod'
2448
+ processedBy:
2449
+ type: string
2450
+ minLength: 1
2451
+ description: The name of the service that provided the approval or decline
2452
+ proprietaryAuxiliaryData:
2453
+ type: object
2454
+ description: If present, this object will contain proprietary auxiliary data
2455
+ additionalCurrencyConversionRates:
2456
+ type: array
2457
+ minLength: 0
2458
+ description: Additional currency conversion rates that can be used to convert the settlement currency to some other currency
2459
+ items:
2460
+ $ref: '#/components/schemas/AdditionalCurrencyConversionRate'
2461
+
2462
+ Response:
2463
+ type: object
2464
+ additionalProperties: false
2465
+ required:
2466
+ - messageId
2467
+ - cardId
2468
+ - responseCode
2469
+ - declineReasons
2470
+ - capture
2471
+ - requestedAmount
2472
+ - requestedTolerance
2473
+ - requestedFee
2474
+ - requestedTotal
2475
+ - requestedCashBack
2476
+ - approvedAmount
2477
+ - approvedTolerance
2478
+ - approvedFee
2479
+ - approvedTotal
2480
+ - approvedCashBack
2481
+ - pendingAmount
2482
+ - pendingTolerance
2483
+ - pendingFee
2484
+ - pendingTotal
2485
+ - completedAmount
2486
+ - completedTolerance
2487
+ - completedFee
2488
+ - completedTotal
2489
+ - pendingAccounts
2490
+ - completedAccounts
2491
+ - tags
2492
+ - addressVerificationResult
2493
+ - applicationTransactionCounterValidationResult
2494
+ - processedBy
2495
+ - createdOn
2496
+ properties:
2497
+ messageId:
2498
+ type: string
2499
+ minLength: 1
2500
+ cardId:
2501
+ type: string
2502
+ minLength: 1
2503
+ authorizationIdResponse:
2504
+ type: string
2505
+ minLength: 1
2506
+ responseCode:
2507
+ $ref: '#/components/schemas/ResponseCode'
2508
+ declineReasons:
2509
+ type: array
2510
+ description: Network Transaction decline reasons
2511
+ items:
2512
+ $ref: '#/components/schemas/DeclineReasonsEnum'
2513
+ capture:
2514
+ type: boolean
2515
+ requestedAmount:
2516
+ $ref: '#/components/schemas/Amount'
2517
+ requestedTolerance:
2518
+ $ref: '#/components/schemas/Amount'
2519
+ requestedFee:
2520
+ description: |
2521
+ Fee amount applied by the processor. This value does not include fees applied by
2522
+ the network or acquirer. Those fees are included in requestedAmount and approvedAmount.
2523
+ allOf:
2524
+ - $ref: '#/components/schemas/Amount'
2525
+ requestedTotal:
2526
+ $ref: '#/components/schemas/Amount'
2527
+ requestedCashBack:
2528
+ $ref: '#/components/schemas/Amount'
2529
+ approvedAmount:
2530
+ $ref: '#/components/schemas/Amount'
2531
+ approvedTolerance:
2532
+ $ref: '#/components/schemas/Amount'
2533
+ approvedFee:
2534
+ description: |
2535
+ Fee amount applied by the processor. This value does not include fees applied by
2536
+ the network or acquirer. Those fees are included in requestedAmount and approvedAmount.
2537
+ allOf:
2538
+ - $ref: '#/components/schemas/Amount'
2539
+ approvedTotal:
2540
+ $ref: '#/components/schemas/Amount'
2541
+ approvedCashBack:
2542
+ $ref: '#/components/schemas/Amount'
2543
+ pendingAmount:
2544
+ $ref: '#/components/schemas/Amount'
2545
+ pendingTolerance:
2546
+ $ref: '#/components/schemas/Amount'
2547
+ pendingFee:
2548
+ $ref: '#/components/schemas/Amount'
2549
+ pendingTotal:
2550
+ $ref: '#/components/schemas/Amount'
2551
+ completedAmount:
2552
+ $ref: '#/components/schemas/Amount'
2553
+ completedTolerance:
2554
+ $ref: '#/components/schemas/Amount'
2555
+ completedFee:
2556
+ $ref: '#/components/schemas/Amount'
2557
+ completedTotal:
2558
+ $ref: '#/components/schemas/Amount'
2559
+ availableBalance:
2560
+ $ref: '#/components/schemas/Amount'
2561
+ addressVerificationResult:
2562
+ $ref: '#/components/schemas/AddressVerificationResult'
2563
+ applicationTransactionCounterValidationResult:
2564
+ $ref: '#/components/schemas/ApplicationTransactionCounterValidationResult'
2565
+ entryId:
2566
+ type: string
2567
+ minLength: 1
2568
+ pendingAccounts:
2569
+ type: array
2570
+ description: Accounts where there are still funds pending
2571
+ items:
2572
+ $ref: '#/components/schemas/AccountUsage'
2573
+ completedAccounts:
2574
+ type: array
2575
+ description: Accounts where the funds have completed
2576
+ items:
2577
+ $ref: '#/components/schemas/AccountUsage'
2578
+ holdExpirationDateTime:
2579
+ type: string
2580
+ minLength: 1
2581
+ format: date-time
2582
+ tags:
2583
+ type: array
2584
+ description: List of tags
2585
+ items:
2586
+ $ref: '#/components/schemas/TagResult'
2587
+ tokenization:
2588
+ type: object
2589
+ properties:
2590
+ activationMethods:
2591
+ type: array
2592
+ minLength: 0
2593
+ description: The activation methods to be used for this tokenization. Returning an empty array will mean that no aditional activation methods are required to tokenize, with the except of any pre-configured with the party responsible for initializing the tokenization.
2594
+ items:
2595
+ $ref: '#/components/schemas/ActivationMethod'
2596
+ processedBy:
2597
+ type: string
2598
+ minLength: 1
2599
+ description: The name of the service that provided the approval or decline
2600
+ createdOn:
2601
+ type: string
2602
+ format: date-time
2603
+ description: Message record creation date/time
2604
+ proprietaryAuxiliaryData:
2605
+ type: object
2606
+ description: If present, this object will contain proprietary auxiliary data
2607
+ additionalCurrencyConversionRates:
2608
+ type: array
2609
+ minLength: 0
2610
+ description: Additional currency conversion rates used to convert the settlement currency to some other currency
2611
+ items:
2612
+ $ref: '#/components/schemas/AdditionalCurrencyConversionRate'
2613
+
2614
+ PickedResponse:
2615
+ type: object
2616
+ additionalProperties: false
2617
+ description: Picked response message data
2618
+ required:
2619
+ - createdOn
2620
+ properties:
2621
+ messageId:
2622
+ type: string
2623
+ minLength: 1
2624
+ declineReasons:
2625
+ type: array
2626
+ description: Network Transaction decline reasons
2627
+ items:
2628
+ $ref: '#/components/schemas/DeclineReasonsEnum'
2629
+ approvedTotal:
2630
+ $ref: '#/components/schemas/Amount'
2631
+ holdExpirationDateTime:
2632
+ type: string
2633
+ minLength: 1
2634
+ format: date-time
2635
+ createdOn:
2636
+ type: string
2637
+ format: date-time
2638
+ description: Message record creation date/time
2639
+ proprietaryAuxiliaryData:
2640
+ type: object
2641
+ description: If present, this object will contain proprietary auxiliary data
2642
+ additionalCurrencyConversionRates:
2643
+ type: array
2644
+ minLength: 0
2645
+ description: Additional currency conversion rates used to convert the settlement currency to some other currency
2646
+ items:
2647
+ $ref: '#/components/schemas/AdditionalCurrencyConversionRate'
2648
+
2649
+ RequestField:
2650
+ type: string
2651
+ enum:
2652
+ - CARD_ID
2653
+ - ADVICE_RESPONSE
2654
+ - CATEGORIZATION
2655
+ - CREATED_ON
2656
+ - MATCHED_MESSAGE_ID
2657
+ - MESSAGE_ID
2658
+ - RECEIVED_DATE_TIME
2659
+ - SETTLEMENT_AMOUNT
2660
+
2661
+ ResponseField:
2662
+ type: string
2663
+ enum:
2664
+ - APPROVED_TOTAL
2665
+ - CREATED_ON
2666
+ - DECLINE_REASONS
2667
+ - HOLD_EXPIRATION_DATE_TIME
2668
+ - MESSAGE_ID
2669
+ - PROPRIETARY_AUXILIARY_DATA
2670
+ - ADDITIONAL_CURRENCY_CONVERSION_RATES
2671
+
2672
+ parameters:
2673
+ messageId:
2674
+ in: path
2675
+ name: messageId
2676
+ description: Unique identifier for a message
2677
+ required: true
2678
+ schema:
2679
+ type: string
2680
+
2681
+ at:
2682
+ in: query
2683
+ name: at
2684
+ description: >-
2685
+ Identifies at what point in time the data should be returned. Must not
2686
+ be in the future.
2687
+ required: true
2688
+ schema:
2689
+ type: string
2690
+ format: date-time
2691
+
2692
+ cardId:
2693
+ in: query
2694
+ name: cardId
2695
+ description: Unique identifier for an account
2696
+ required: true
2697
+ schema:
2698
+ type: array
2699
+ minItems: 1
2700
+ items:
2701
+ type: string
2702
+
2703
+ toDate:
2704
+ in: query
2705
+ name: toDate
2706
+ description: >-
2707
+ Return entries created before this time. Must be at least 1 second in
2708
+ the past.
2709
+ required: true
2710
+ schema:
2711
+ type: string
2712
+ format: date-time
2713
+
2714
+ fromDate:
2715
+ in: query
2716
+ name: fromDate
2717
+ description: >-
2718
+ Return entries created at or after this time. Must be at least 1 second
2719
+ in the past.
2720
+ schema:
2721
+ type: string
2722
+ format: date-time
2723
+
2724
+ lastModified:
2725
+ name: Last-Modified
2726
+ in: header
2727
+ description: Last-Modified header
2728
+ required: false
2729
+ schema:
2730
+ type: string
2731
+ format: date-time
2732
+
2733
+ createdOn:
2734
+ name: Created-On
2735
+ in: header
2736
+ description: CreatedOn-header
2737
+ required: false
2738
+ schema:
2739
+ type: string
2740
+ format: date-time
2741
+
2742
+ responseFields:
2743
+ in: query
2744
+ name: fields
2745
+ description: The message response fields to return
2746
+ required: true
2747
+ schema:
2748
+ type: array
2749
+ minItems: 1
2750
+ items:
2751
+ $ref: '#/components/schemas/ResponseField'
2752
+
2753
+ requestFields:
2754
+ in: query
2755
+ name: fields
2756
+ description: The message request fields to return
2757
+ required: true
2758
+ schema:
2759
+ type: array
2760
+ minItems: 1
2761
+ items:
2762
+ $ref: '#/components/schemas/RequestField'
2763
+
2764
+ responses:
2765
+ Ping:
2766
+ description: ping successful response
2767
+ content:
2768
+ application/json:
2769
+ schema:
2770
+ $ref: '#/components/schemas/Ping'
2771
+
2772
+ ServerError:
2773
+ description: Server Error response
2774
+ content:
2775
+ application/json:
2776
+ schema:
2777
+ $ref: '#/components/schemas/Error'
2778
+ headers:
2779
+ Last-Modified:
2780
+ description: Date and time at which the record was last modified
2781
+ required: true
2782
+ schema:
2783
+ type: string
2784
+ format: date-time
2785
+
2786
+ Created-On:
2787
+ description: CreatedOn timestamp for the newly created record
2788
+ required: true
2789
+ schema:
2790
+ type: string
2791
+ format: date-time
2792
+
2793
+ Updated-On:
2794
+ description: UpdatedOn timestamp for the existing record
2795
+ required: true
2796
+ schema:
2797
+ type: string
2798
+ format: date-time