@aws-sdk/client-payment-cryptography-data 3.379.1 → 3.382.0

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.
@@ -19,6 +19,7 @@ export declare class AccessDeniedException extends __BaseException {
19
19
  */
20
20
  export interface AmexCardSecurityCodeVersion1 {
21
21
  /**
22
+ * @public
22
23
  * <p>The expiry date of a payment card.</p>
23
24
  */
24
25
  CardExpiryDate: string | undefined;
@@ -29,10 +30,12 @@ export interface AmexCardSecurityCodeVersion1 {
29
30
  */
30
31
  export interface AmexCardSecurityCodeVersion2 {
31
32
  /**
33
+ * @public
32
34
  * <p>The expiry date of a payment card.</p>
33
35
  */
34
36
  CardExpiryDate: string | undefined;
35
37
  /**
38
+ * @public
36
39
  * <p>The service code of the AMEX payment card. This is different from the Card Security Code (CSC).</p>
37
40
  */
38
41
  ServiceCode: string | undefined;
@@ -57,6 +60,7 @@ export type PaddingType = (typeof PaddingType)[keyof typeof PaddingType];
57
60
  */
58
61
  export interface AsymmetricEncryptionAttributes {
59
62
  /**
63
+ * @public
60
64
  * <p>The padding to be included with the data.</p>
61
65
  */
62
66
  PaddingType?: PaddingType | string;
@@ -67,14 +71,17 @@ export interface AsymmetricEncryptionAttributes {
67
71
  */
68
72
  export interface CardHolderVerificationValue {
69
73
  /**
74
+ * @public
70
75
  * <p>A random number generated by the issuer.</p>
71
76
  */
72
77
  UnpredictableNumber: string | undefined;
73
78
  /**
79
+ * @public
74
80
  * <p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>
75
81
  */
76
82
  PanSequenceNumber: string | undefined;
77
83
  /**
84
+ * @public
78
85
  * <p>The transaction counter value that comes from a point of sale terminal.</p>
79
86
  */
80
87
  ApplicationTransactionCounter: string | undefined;
@@ -85,10 +92,12 @@ export interface CardHolderVerificationValue {
85
92
  */
86
93
  export interface CardVerificationValue1 {
87
94
  /**
95
+ * @public
88
96
  * <p>The expiry date of a payment card.</p>
89
97
  */
90
98
  CardExpiryDate: string | undefined;
91
99
  /**
100
+ * @public
92
101
  * <p>The service code of the payment card. This is different from Card Security Code (CSC).</p>
93
102
  */
94
103
  ServiceCode: string | undefined;
@@ -99,6 +108,7 @@ export interface CardVerificationValue1 {
99
108
  */
100
109
  export interface CardVerificationValue2 {
101
110
  /**
111
+ * @public
102
112
  * <p>The expiry date of a payment card.</p>
103
113
  */
104
114
  CardExpiryDate: string | undefined;
@@ -109,18 +119,22 @@ export interface CardVerificationValue2 {
109
119
  */
110
120
  export interface DynamicCardVerificationCode {
111
121
  /**
122
+ * @public
112
123
  * <p>A random number generated by the issuer.</p>
113
124
  */
114
125
  UnpredictableNumber: string | undefined;
115
126
  /**
127
+ * @public
116
128
  * <p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>
117
129
  */
118
130
  PanSequenceNumber: string | undefined;
119
131
  /**
132
+ * @public
120
133
  * <p>The transaction counter value that comes from the terminal.</p>
121
134
  */
122
135
  ApplicationTransactionCounter: string | undefined;
123
136
  /**
137
+ * @public
124
138
  * <p>The data on the two tracks of magnetic cards used for financial transactions. This includes the cardholder name, PAN, expiration date, bank ID (BIN) and several other numbers the issuing bank uses to validate the data received.</p>
125
139
  */
126
140
  TrackData: string | undefined;
@@ -131,18 +145,22 @@ export interface DynamicCardVerificationCode {
131
145
  */
132
146
  export interface DynamicCardVerificationValue {
133
147
  /**
148
+ * @public
134
149
  * <p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>
135
150
  */
136
151
  PanSequenceNumber: string | undefined;
137
152
  /**
153
+ * @public
138
154
  * <p>The expiry date of a payment card.</p>
139
155
  */
140
156
  CardExpiryDate: string | undefined;
141
157
  /**
158
+ * @public
142
159
  * <p>The service code of the payment card. This is different from Card Security Code (CSC).</p>
143
160
  */
144
161
  ServiceCode: string | undefined;
145
162
  /**
163
+ * @public
146
164
  * <p>The transaction counter value that comes from the terminal.</p>
147
165
  */
148
166
  ApplicationTransactionCounter: string | undefined;
@@ -157,6 +175,7 @@ export type CardGenerationAttributes = CardGenerationAttributes.AmexCardSecurity
157
175
  */
158
176
  export declare namespace CardGenerationAttributes {
159
177
  /**
178
+ * @public
160
179
  * <p>Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.</p>
161
180
  */
162
181
  interface AmexCardSecurityCodeVersion1Member {
@@ -170,6 +189,7 @@ export declare namespace CardGenerationAttributes {
170
189
  $unknown?: never;
171
190
  }
172
191
  /**
192
+ * @public
173
193
  * <p>Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.</p>
174
194
  */
175
195
  interface AmexCardSecurityCodeVersion2Member {
@@ -183,6 +203,7 @@ export declare namespace CardGenerationAttributes {
183
203
  $unknown?: never;
184
204
  }
185
205
  /**
206
+ * @public
186
207
  * <p>Card data parameters that are required to generate Card Verification Value (CVV) for the payment card.</p>
187
208
  */
188
209
  interface CardVerificationValue1Member {
@@ -196,6 +217,7 @@ export declare namespace CardGenerationAttributes {
196
217
  $unknown?: never;
197
218
  }
198
219
  /**
220
+ * @public
199
221
  * <p>Card data parameters that are required to generate Card Verification Value (CVV2) for the payment card.</p>
200
222
  */
201
223
  interface CardVerificationValue2Member {
@@ -209,6 +231,7 @@ export declare namespace CardGenerationAttributes {
209
231
  $unknown?: never;
210
232
  }
211
233
  /**
234
+ * @public
212
235
  * <p>Card data parameters that are required to generate a cardholder verification value for the payment card.</p>
213
236
  */
214
237
  interface CardHolderVerificationValueMember {
@@ -222,6 +245,7 @@ export declare namespace CardGenerationAttributes {
222
245
  $unknown?: never;
223
246
  }
224
247
  /**
248
+ * @public
225
249
  * <p>Card data parameters that are required to generate CDynamic Card Verification Code (dCVC) for the payment card.</p>
226
250
  */
227
251
  interface DynamicCardVerificationCodeMember {
@@ -235,6 +259,7 @@ export declare namespace CardGenerationAttributes {
235
259
  $unknown?: never;
236
260
  }
237
261
  /**
262
+ * @public
238
263
  * <p>Card data parameters that are required to generate CDynamic Card Verification Value (dCVV) for the payment card.</p>
239
264
  */
240
265
  interface DynamicCardVerificationValueMember {
@@ -247,6 +272,9 @@ export declare namespace CardGenerationAttributes {
247
272
  DynamicCardVerificationValue: DynamicCardVerificationValue;
248
273
  $unknown?: never;
249
274
  }
275
+ /**
276
+ * @public
277
+ */
250
278
  interface $UnknownMember {
251
279
  AmexCardSecurityCodeVersion1?: never;
252
280
  AmexCardSecurityCodeVersion2?: never;
@@ -275,14 +303,17 @@ export declare namespace CardGenerationAttributes {
275
303
  */
276
304
  export interface DiscoverDynamicCardVerificationCode {
277
305
  /**
306
+ * @public
278
307
  * <p>The expiry date of a payment card.</p>
279
308
  */
280
309
  CardExpiryDate: string | undefined;
281
310
  /**
311
+ * @public
282
312
  * <p>A random number that is generated by the issuer.</p>
283
313
  */
284
314
  UnpredictableNumber: string | undefined;
285
315
  /**
316
+ * @public
286
317
  * <p>The transaction counter value that comes from the terminal.</p>
287
318
  */
288
319
  ApplicationTransactionCounter: string | undefined;
@@ -297,6 +328,7 @@ export type CardVerificationAttributes = CardVerificationAttributes.AmexCardSecu
297
328
  */
298
329
  export declare namespace CardVerificationAttributes {
299
330
  /**
331
+ * @public
300
332
  * <p>Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.</p>
301
333
  */
302
334
  interface AmexCardSecurityCodeVersion1Member {
@@ -311,6 +343,7 @@ export declare namespace CardVerificationAttributes {
311
343
  $unknown?: never;
312
344
  }
313
345
  /**
346
+ * @public
314
347
  * <p>Card data parameters that are required to verify a Card Security Code (CSC2) for an AMEX payment card.</p>
315
348
  */
316
349
  interface AmexCardSecurityCodeVersion2Member {
@@ -325,6 +358,7 @@ export declare namespace CardVerificationAttributes {
325
358
  $unknown?: never;
326
359
  }
327
360
  /**
361
+ * @public
328
362
  * <p>Card data parameters that are required to verify Card Verification Value (CVV) for the payment card.</p>
329
363
  */
330
364
  interface CardVerificationValue1Member {
@@ -339,6 +373,7 @@ export declare namespace CardVerificationAttributes {
339
373
  $unknown?: never;
340
374
  }
341
375
  /**
376
+ * @public
342
377
  * <p>Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.</p>
343
378
  */
344
379
  interface CardVerificationValue2Member {
@@ -353,6 +388,7 @@ export declare namespace CardVerificationAttributes {
353
388
  $unknown?: never;
354
389
  }
355
390
  /**
391
+ * @public
356
392
  * <p>Card data parameters that are required to verify a cardholder verification value for the payment card.</p>
357
393
  */
358
394
  interface CardHolderVerificationValueMember {
@@ -367,6 +403,7 @@ export declare namespace CardVerificationAttributes {
367
403
  $unknown?: never;
368
404
  }
369
405
  /**
406
+ * @public
370
407
  * <p>Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.</p>
371
408
  */
372
409
  interface DynamicCardVerificationCodeMember {
@@ -381,6 +418,7 @@ export declare namespace CardVerificationAttributes {
381
418
  $unknown?: never;
382
419
  }
383
420
  /**
421
+ * @public
384
422
  * <p>Card data parameters that are required to verify CDynamic Card Verification Value (dCVV) for the payment card.</p>
385
423
  */
386
424
  interface DynamicCardVerificationValueMember {
@@ -395,6 +433,7 @@ export declare namespace CardVerificationAttributes {
395
433
  $unknown?: never;
396
434
  }
397
435
  /**
436
+ * @public
398
437
  * <p>Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.</p>
399
438
  */
400
439
  interface DiscoverDynamicCardVerificationCodeMember {
@@ -408,6 +447,9 @@ export declare namespace CardVerificationAttributes {
408
447
  DiscoverDynamicCardVerificationCode: DiscoverDynamicCardVerificationCode;
409
448
  $unknown?: never;
410
449
  }
450
+ /**
451
+ * @public
452
+ */
411
453
  interface $UnknownMember {
412
454
  AmexCardSecurityCodeVersion1?: never;
413
455
  AmexCardSecurityCodeVersion2?: never;
@@ -438,6 +480,7 @@ export declare namespace CardVerificationAttributes {
438
480
  */
439
481
  export interface CryptogramVerificationArpcMethod1 {
440
482
  /**
483
+ * @public
441
484
  * <p>The auth code used to calculate APRC after ARQC verification is successful. This is the same auth code used for ARQC generation outside of Amazon Web Services Payment Cryptography.</p>
442
485
  */
443
486
  AuthResponseCode: string | undefined;
@@ -448,10 +491,12 @@ export interface CryptogramVerificationArpcMethod1 {
448
491
  */
449
492
  export interface CryptogramVerificationArpcMethod2 {
450
493
  /**
494
+ * @public
451
495
  * <p>The data indicating whether the issuer approves or declines an online transaction using an EMV chip card.</p>
452
496
  */
453
497
  CardStatusUpdate: string | undefined;
454
498
  /**
499
+ * @public
455
500
  * <p>The proprietary authentication data used by issuer for communication during online transaction using an EMV chip card.</p>
456
501
  */
457
502
  ProprietaryAuthenticationData?: string;
@@ -466,6 +511,7 @@ export type CryptogramAuthResponse = CryptogramAuthResponse.ArpcMethod1Member |
466
511
  */
467
512
  export declare namespace CryptogramAuthResponse {
468
513
  /**
514
+ * @public
469
515
  * <p>Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.</p>
470
516
  */
471
517
  interface ArpcMethod1Member {
@@ -474,6 +520,7 @@ export declare namespace CryptogramAuthResponse {
474
520
  $unknown?: never;
475
521
  }
476
522
  /**
523
+ * @public
477
524
  * <p>Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.</p>
478
525
  */
479
526
  interface ArpcMethod2Member {
@@ -481,6 +528,9 @@ export declare namespace CryptogramAuthResponse {
481
528
  ArpcMethod2: CryptogramVerificationArpcMethod2;
482
529
  $unknown?: never;
483
530
  }
531
+ /**
532
+ * @public
533
+ */
484
534
  interface $UnknownMember {
485
535
  ArpcMethod1?: never;
486
536
  ArpcMethod2?: never;
@@ -539,24 +589,29 @@ export type DukptEncryptionMode = (typeof DukptEncryptionMode)[keyof typeof Dukp
539
589
  */
540
590
  export interface DukptEncryptionAttributes {
541
591
  /**
592
+ * @public
542
593
  * <p>The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.</p>
543
594
  */
544
595
  KeySerialNumber: string | undefined;
545
596
  /**
597
+ * @public
546
598
  * <p>The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.</p>
547
599
  * <p>The default is CBC.</p>
548
600
  */
549
601
  Mode?: DukptEncryptionMode | string;
550
602
  /**
603
+ * @public
551
604
  * <p>The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use <code>AES_128</code> as a derivation type for a BDK of <code>AES_128</code> or <code>TDES_2KEY</code>
552
605
  * </p>
553
606
  */
554
607
  DukptKeyDerivationType?: DukptDerivationType | string;
555
608
  /**
609
+ * @public
556
610
  * <p>The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.</p>
557
611
  */
558
612
  DukptKeyVariant?: DukptKeyVariant | string;
559
613
  /**
614
+ * @public
560
615
  * <p>An input to cryptographic primitive used to provide the intial state. Typically the <code>InitializationVector</code> must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.</p>
561
616
  */
562
617
  InitializationVector?: string;
@@ -585,14 +640,17 @@ export type EncryptionMode = (typeof EncryptionMode)[keyof typeof EncryptionMode
585
640
  */
586
641
  export interface SymmetricEncryptionAttributes {
587
642
  /**
643
+ * @public
588
644
  * <p>The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.</p>
589
645
  */
590
646
  Mode: EncryptionMode | string | undefined;
591
647
  /**
648
+ * @public
592
649
  * <p>An input to cryptographic primitive used to provide the intial state. The <code>InitializationVector</code> is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.</p>
593
650
  */
594
651
  InitializationVector?: string;
595
652
  /**
653
+ * @public
596
654
  * <p>The padding to be included with the data.</p>
597
655
  */
598
656
  PaddingType?: PaddingType | string;
@@ -607,6 +665,7 @@ export type EncryptionDecryptionAttributes = EncryptionDecryptionAttributes.Asym
607
665
  */
608
666
  export declare namespace EncryptionDecryptionAttributes {
609
667
  /**
668
+ * @public
610
669
  * <p>Parameters that are required to perform encryption and decryption using symmetric keys.</p>
611
670
  */
612
671
  interface SymmetricMember {
@@ -616,6 +675,7 @@ export declare namespace EncryptionDecryptionAttributes {
616
675
  $unknown?: never;
617
676
  }
618
677
  /**
678
+ * @public
619
679
  * <p>Parameters for plaintext encryption using asymmetric keys.</p>
620
680
  */
621
681
  interface AsymmetricMember {
@@ -625,6 +685,7 @@ export declare namespace EncryptionDecryptionAttributes {
625
685
  $unknown?: never;
626
686
  }
627
687
  /**
688
+ * @public
628
689
  * <p>Parameters that are required to encrypt plaintext data using DUKPT.</p>
629
690
  */
630
691
  interface DukptMember {
@@ -633,6 +694,9 @@ export declare namespace EncryptionDecryptionAttributes {
633
694
  Dukpt: DukptEncryptionAttributes;
634
695
  $unknown?: never;
635
696
  }
697
+ /**
698
+ * @public
699
+ */
636
700
  interface $UnknownMember {
637
701
  Symmetric?: never;
638
702
  Asymmetric?: never;
@@ -652,14 +716,17 @@ export declare namespace EncryptionDecryptionAttributes {
652
716
  */
653
717
  export interface DecryptDataInput {
654
718
  /**
719
+ * @public
655
720
  * <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.</p>
656
721
  */
657
722
  KeyIdentifier: string | undefined;
658
723
  /**
724
+ * @public
659
725
  * <p>The ciphertext to decrypt.</p>
660
726
  */
661
727
  CipherText: string | undefined;
662
728
  /**
729
+ * @public
663
730
  * <p>The encryption key type and attributes for ciphertext decryption.</p>
664
731
  */
665
732
  DecryptionAttributes: EncryptionDecryptionAttributes | undefined;
@@ -669,14 +736,17 @@ export interface DecryptDataInput {
669
736
  */
670
737
  export interface DecryptDataOutput {
671
738
  /**
739
+ * @public
672
740
  * <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.</p>
673
741
  */
674
742
  KeyArn: string | undefined;
675
743
  /**
744
+ * @public
676
745
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
677
746
  */
678
747
  KeyCheckValue: string | undefined;
679
748
  /**
749
+ * @public
680
750
  * <p>The decrypted plaintext data.</p>
681
751
  */
682
752
  PlainText: string | undefined;
@@ -702,6 +772,7 @@ export declare class ResourceNotFoundException extends __BaseException {
702
772
  readonly name: "ResourceNotFoundException";
703
773
  readonly $fault: "client";
704
774
  /**
775
+ * @public
705
776
  * <p>The resource that is missing.</p>
706
777
  */
707
778
  ResourceId?: string;
@@ -729,10 +800,12 @@ export declare class ThrottlingException extends __BaseException {
729
800
  */
730
801
  export interface ValidationExceptionField {
731
802
  /**
803
+ * @public
732
804
  * <p>The request was denied due to an invalid request error.</p>
733
805
  */
734
806
  path: string | undefined;
735
807
  /**
808
+ * @public
736
809
  * <p>The request was denied due to an invalid request error.</p>
737
810
  */
738
811
  message: string | undefined;
@@ -745,6 +818,7 @@ export declare class ValidationException extends __BaseException {
745
818
  readonly name: "ValidationException";
746
819
  readonly $fault: "client";
747
820
  /**
821
+ * @public
748
822
  * <p>The request was denied due to an invalid request error.</p>
749
823
  */
750
824
  fieldList?: ValidationExceptionField[];
@@ -759,10 +833,12 @@ export declare class ValidationException extends __BaseException {
759
833
  */
760
834
  export interface DukptAttributes {
761
835
  /**
836
+ * @public
762
837
  * <p>The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.</p>
763
838
  */
764
839
  KeySerialNumber: string | undefined;
765
840
  /**
841
+ * @public
766
842
  * <p>The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use <code>AES_128</code> as a derivation type for a BDK of <code>AES_128</code> or <code>TDES_2KEY</code>.</p>
767
843
  */
768
844
  DukptDerivationType: DukptDerivationType | string | undefined;
@@ -773,15 +849,18 @@ export interface DukptAttributes {
773
849
  */
774
850
  export interface DukptDerivationAttributes {
775
851
  /**
852
+ * @public
776
853
  * <p>The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.</p>
777
854
  */
778
855
  KeySerialNumber: string | undefined;
779
856
  /**
857
+ * @public
780
858
  * <p>The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use <code>AES_128</code> as a derivation type for a BDK of <code>AES_128</code> or <code>TDES_2KEY</code>
781
859
  * </p>
782
860
  */
783
861
  DukptKeyDerivationType?: DukptDerivationType | string;
784
862
  /**
863
+ * @public
785
864
  * <p>The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.</p>
786
865
  */
787
866
  DukptKeyVariant?: DukptKeyVariant | string;
@@ -791,14 +870,17 @@ export interface DukptDerivationAttributes {
791
870
  */
792
871
  export interface EncryptDataInput {
793
872
  /**
873
+ * @public
794
874
  * <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.</p>
795
875
  */
796
876
  KeyIdentifier: string | undefined;
797
877
  /**
878
+ * @public
798
879
  * <p>The plaintext to be encrypted.</p>
799
880
  */
800
881
  PlainText: string | undefined;
801
882
  /**
883
+ * @public
802
884
  * <p>The encryption key type and attributes for plaintext encryption.</p>
803
885
  */
804
886
  EncryptionAttributes: EncryptionDecryptionAttributes | undefined;
@@ -808,14 +890,17 @@ export interface EncryptDataInput {
808
890
  */
809
891
  export interface EncryptDataOutput {
810
892
  /**
893
+ * @public
811
894
  * <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.</p>
812
895
  */
813
896
  KeyArn: string | undefined;
814
897
  /**
898
+ * @public
815
899
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
816
900
  */
817
901
  KeyCheckValue: string | undefined;
818
902
  /**
903
+ * @public
819
904
  * <p>The encrypted ciphertext.</p>
820
905
  */
821
906
  CipherText: string | undefined;
@@ -825,18 +910,22 @@ export interface EncryptDataOutput {
825
910
  */
826
911
  export interface GenerateCardValidationDataInput {
827
912
  /**
913
+ * @public
828
914
  * <p>The <code>keyARN</code> of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.</p>
829
915
  */
830
916
  KeyIdentifier: string | undefined;
831
917
  /**
918
+ * @public
832
919
  * <p>The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.</p>
833
920
  */
834
921
  PrimaryAccountNumber: string | undefined;
835
922
  /**
923
+ * @public
836
924
  * <p>The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.</p>
837
925
  */
838
926
  GenerationAttributes: CardGenerationAttributes | undefined;
839
927
  /**
928
+ * @public
840
929
  * <p>The length of the CVV or CSC to be generated. The default value is 3.</p>
841
930
  */
842
931
  ValidationDataLength?: number;
@@ -846,14 +935,17 @@ export interface GenerateCardValidationDataInput {
846
935
  */
847
936
  export interface GenerateCardValidationDataOutput {
848
937
  /**
938
+ * @public
849
939
  * <p>The <code>keyARN</code> of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate CVV or CSC.</p>
850
940
  */
851
941
  KeyArn: string | undefined;
852
942
  /**
943
+ * @public
853
944
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
854
945
  */
855
946
  KeyCheckValue: string | undefined;
856
947
  /**
948
+ * @public
857
949
  * <p>The CVV or CSC value that Amazon Web Services Payment Cryptography generates for the card.</p>
858
950
  */
859
951
  ValidationData: string | undefined;
@@ -881,14 +973,17 @@ export type MacAlgorithm = (typeof MacAlgorithm)[keyof typeof MacAlgorithm];
881
973
  */
882
974
  export interface MacAlgorithmDukpt {
883
975
  /**
976
+ * @public
884
977
  * <p>The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.</p>
885
978
  */
886
979
  KeySerialNumber: string | undefined;
887
980
  /**
981
+ * @public
888
982
  * <p>The type of use of DUKPT, which can be MAC generation, MAC verification, or both.</p>
889
983
  */
890
984
  DukptKeyVariant: DukptKeyVariant | string | undefined;
891
985
  /**
986
+ * @public
892
987
  * <p>The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use <code>AES_128</code> as a derivation type for a BDK of <code>AES_128</code> or <code>TDES_2KEY</code>.</p>
893
988
  */
894
989
  DukptDerivationType?: DukptDerivationType | string;
@@ -930,6 +1025,7 @@ export type SessionKeyDerivationValue = SessionKeyDerivationValue.ApplicationCry
930
1025
  */
931
1026
  export declare namespace SessionKeyDerivationValue {
932
1027
  /**
1028
+ * @public
933
1029
  * <p>The cryptogram provided by the terminal during transaction processing.</p>
934
1030
  */
935
1031
  interface ApplicationCryptogramMember {
@@ -938,6 +1034,7 @@ export declare namespace SessionKeyDerivationValue {
938
1034
  $unknown?: never;
939
1035
  }
940
1036
  /**
1037
+ * @public
941
1038
  * <p>The transaction counter that is provided by the terminal during transaction processing.</p>
942
1039
  */
943
1040
  interface ApplicationTransactionCounterMember {
@@ -945,6 +1042,9 @@ export declare namespace SessionKeyDerivationValue {
945
1042
  ApplicationTransactionCounter: string;
946
1043
  $unknown?: never;
947
1044
  }
1045
+ /**
1046
+ * @public
1047
+ */
948
1048
  interface $UnknownMember {
949
1049
  ApplicationCryptogram?: never;
950
1050
  ApplicationTransactionCounter?: never;
@@ -963,22 +1063,27 @@ export declare namespace SessionKeyDerivationValue {
963
1063
  */
964
1064
  export interface MacAlgorithmEmv {
965
1065
  /**
1066
+ * @public
966
1067
  * <p>The method to use when deriving the master key for EMV MAC generation or verification.</p>
967
1068
  */
968
1069
  MajorKeyDerivationMode: MajorKeyDerivationMode | string | undefined;
969
1070
  /**
1071
+ * @public
970
1072
  * <p>The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.</p>
971
1073
  */
972
1074
  PrimaryAccountNumber: string | undefined;
973
1075
  /**
1076
+ * @public
974
1077
  * <p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>
975
1078
  */
976
1079
  PanSequenceNumber: string | undefined;
977
1080
  /**
1081
+ * @public
978
1082
  * <p>The method of deriving a session key for EMV MAC generation or verification.</p>
979
1083
  */
980
1084
  SessionKeyDerivationMode: SessionKeyDerivationMode | string | undefined;
981
1085
  /**
1086
+ * @public
982
1087
  * <p>Parameters that are required to generate session key for EMV generation and verification.</p>
983
1088
  */
984
1089
  SessionKeyDerivationValue: SessionKeyDerivationValue | undefined;
@@ -993,6 +1098,7 @@ export type MacAttributes = MacAttributes.AlgorithmMember | MacAttributes.DukptC
993
1098
  */
994
1099
  export declare namespace MacAttributes {
995
1100
  /**
1101
+ * @public
996
1102
  * <p>The encryption algorithm for MAC generation or verification.</p>
997
1103
  */
998
1104
  interface AlgorithmMember {
@@ -1004,6 +1110,7 @@ export declare namespace MacAttributes {
1004
1110
  $unknown?: never;
1005
1111
  }
1006
1112
  /**
1113
+ * @public
1007
1114
  * <p>Parameters that are required for MAC generation or verification using EMV MAC algorithm.</p>
1008
1115
  */
1009
1116
  interface EmvMacMember {
@@ -1015,6 +1122,7 @@ export declare namespace MacAttributes {
1015
1122
  $unknown?: never;
1016
1123
  }
1017
1124
  /**
1125
+ * @public
1018
1126
  * <p>Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.</p>
1019
1127
  */
1020
1128
  interface DukptIso9797Algorithm1Member {
@@ -1026,6 +1134,7 @@ export declare namespace MacAttributes {
1026
1134
  $unknown?: never;
1027
1135
  }
1028
1136
  /**
1137
+ * @public
1029
1138
  * <p>Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.</p>
1030
1139
  */
1031
1140
  interface DukptIso9797Algorithm3Member {
@@ -1037,6 +1146,7 @@ export declare namespace MacAttributes {
1037
1146
  $unknown?: never;
1038
1147
  }
1039
1148
  /**
1149
+ * @public
1040
1150
  * <p>Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.</p>
1041
1151
  */
1042
1152
  interface DukptCmacMember {
@@ -1047,6 +1157,9 @@ export declare namespace MacAttributes {
1047
1157
  DukptCmac: MacAlgorithmDukpt;
1048
1158
  $unknown?: never;
1049
1159
  }
1160
+ /**
1161
+ * @public
1162
+ */
1050
1163
  interface $UnknownMember {
1051
1164
  Algorithm?: never;
1052
1165
  EmvMac?: never;
@@ -1070,18 +1183,22 @@ export declare namespace MacAttributes {
1070
1183
  */
1071
1184
  export interface GenerateMacInput {
1072
1185
  /**
1186
+ * @public
1073
1187
  * <p>The <code>keyARN</code> of the MAC generation encryption key.</p>
1074
1188
  */
1075
1189
  KeyIdentifier: string | undefined;
1076
1190
  /**
1191
+ * @public
1077
1192
  * <p>The data for which a MAC is under generation.</p>
1078
1193
  */
1079
1194
  MessageData: string | undefined;
1080
1195
  /**
1196
+ * @public
1081
1197
  * <p>The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.</p>
1082
1198
  */
1083
1199
  GenerationAttributes: MacAttributes | undefined;
1084
1200
  /**
1201
+ * @public
1085
1202
  * <p>The length of a MAC under generation.</p>
1086
1203
  */
1087
1204
  MacLength?: number;
@@ -1091,14 +1208,17 @@ export interface GenerateMacInput {
1091
1208
  */
1092
1209
  export interface GenerateMacOutput {
1093
1210
  /**
1211
+ * @public
1094
1212
  * <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.</p>
1095
1213
  */
1096
1214
  KeyArn: string | undefined;
1097
1215
  /**
1216
+ * @public
1098
1217
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
1099
1218
  */
1100
1219
  KeyCheckValue: string | undefined;
1101
1220
  /**
1221
+ * @public
1102
1222
  * <p>The MAC cryptogram generated within Amazon Web Services Payment Cryptography.</p>
1103
1223
  */
1104
1224
  Mac: string | undefined;
@@ -1109,14 +1229,17 @@ export interface GenerateMacOutput {
1109
1229
  */
1110
1230
  export interface Ibm3624NaturalPin {
1111
1231
  /**
1232
+ * @public
1112
1233
  * <p>The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.</p>
1113
1234
  */
1114
1235
  DecimalizationTable: string | undefined;
1115
1236
  /**
1237
+ * @public
1116
1238
  * <p>The padding character for validation data.</p>
1117
1239
  */
1118
1240
  PinValidationDataPadCharacter: string | undefined;
1119
1241
  /**
1242
+ * @public
1120
1243
  * <p>The unique data for cardholder identification.</p>
1121
1244
  */
1122
1245
  PinValidationData: string | undefined;
@@ -1127,18 +1250,22 @@ export interface Ibm3624NaturalPin {
1127
1250
  */
1128
1251
  export interface Ibm3624PinFromOffset {
1129
1252
  /**
1253
+ * @public
1130
1254
  * <p>The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.</p>
1131
1255
  */
1132
1256
  DecimalizationTable: string | undefined;
1133
1257
  /**
1258
+ * @public
1134
1259
  * <p>The padding character for validation data.</p>
1135
1260
  */
1136
1261
  PinValidationDataPadCharacter: string | undefined;
1137
1262
  /**
1263
+ * @public
1138
1264
  * <p>The unique data for cardholder identification.</p>
1139
1265
  */
1140
1266
  PinValidationData: string | undefined;
1141
1267
  /**
1268
+ * @public
1142
1269
  * <p>The PIN offset value.</p>
1143
1270
  */
1144
1271
  PinOffset: string | undefined;
@@ -1149,18 +1276,22 @@ export interface Ibm3624PinFromOffset {
1149
1276
  */
1150
1277
  export interface Ibm3624PinOffset {
1151
1278
  /**
1279
+ * @public
1152
1280
  * <p>The encrypted PIN block data. According to ISO 9564 standard, a PIN Block is an encoded representation of a payment card Personal Account Number (PAN) and the cardholder Personal Identification Number (PIN).</p>
1153
1281
  */
1154
1282
  EncryptedPinBlock: string | undefined;
1155
1283
  /**
1284
+ * @public
1156
1285
  * <p>The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.</p>
1157
1286
  */
1158
1287
  DecimalizationTable: string | undefined;
1159
1288
  /**
1289
+ * @public
1160
1290
  * <p>The padding character for validation data.</p>
1161
1291
  */
1162
1292
  PinValidationDataPadCharacter: string | undefined;
1163
1293
  /**
1294
+ * @public
1164
1295
  * <p>The unique data for cardholder identification.</p>
1165
1296
  */
1166
1297
  PinValidationData: string | undefined;
@@ -1171,14 +1302,17 @@ export interface Ibm3624PinOffset {
1171
1302
  */
1172
1303
  export interface Ibm3624RandomPin {
1173
1304
  /**
1305
+ * @public
1174
1306
  * <p>The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.</p>
1175
1307
  */
1176
1308
  DecimalizationTable: string | undefined;
1177
1309
  /**
1310
+ * @public
1178
1311
  * <p>The padding character for validation data.</p>
1179
1312
  */
1180
1313
  PinValidationDataPadCharacter: string | undefined;
1181
1314
  /**
1315
+ * @public
1182
1316
  * <p>The unique data for cardholder identification.</p>
1183
1317
  */
1184
1318
  PinValidationData: string | undefined;
@@ -1189,6 +1323,7 @@ export interface Ibm3624RandomPin {
1189
1323
  */
1190
1324
  export interface VisaPin {
1191
1325
  /**
1326
+ * @public
1192
1327
  * <p>The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).</p>
1193
1328
  */
1194
1329
  PinVerificationKeyIndex: number | undefined;
@@ -1199,10 +1334,12 @@ export interface VisaPin {
1199
1334
  */
1200
1335
  export interface VisaPinVerificationValue {
1201
1336
  /**
1337
+ * @public
1202
1338
  * <p>The encrypted PIN block data to verify.</p>
1203
1339
  */
1204
1340
  EncryptedPinBlock: string | undefined;
1205
1341
  /**
1342
+ * @public
1206
1343
  * <p>The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).</p>
1207
1344
  */
1208
1345
  PinVerificationKeyIndex: number | undefined;
@@ -1217,6 +1354,7 @@ export type PinGenerationAttributes = PinGenerationAttributes.Ibm3624NaturalPinM
1217
1354
  */
1218
1355
  export declare namespace PinGenerationAttributes {
1219
1356
  /**
1357
+ * @public
1220
1358
  * <p>Parameters that are required to generate or verify Visa PIN.</p>
1221
1359
  */
1222
1360
  interface VisaPinMember {
@@ -1229,6 +1367,7 @@ export declare namespace PinGenerationAttributes {
1229
1367
  $unknown?: never;
1230
1368
  }
1231
1369
  /**
1370
+ * @public
1232
1371
  * <p>Parameters that are required to generate or verify Visa PIN Verification Value (PVV).</p>
1233
1372
  */
1234
1373
  interface VisaPinVerificationValueMember {
@@ -1241,6 +1380,7 @@ export declare namespace PinGenerationAttributes {
1241
1380
  $unknown?: never;
1242
1381
  }
1243
1382
  /**
1383
+ * @public
1244
1384
  * <p>Parameters that are required to generate or verify Ibm3624 PIN offset PIN.</p>
1245
1385
  */
1246
1386
  interface Ibm3624PinOffsetMember {
@@ -1253,6 +1393,7 @@ export declare namespace PinGenerationAttributes {
1253
1393
  $unknown?: never;
1254
1394
  }
1255
1395
  /**
1396
+ * @public
1256
1397
  * <p>Parameters that are required to generate or verify Ibm3624 natural PIN.</p>
1257
1398
  */
1258
1399
  interface Ibm3624NaturalPinMember {
@@ -1265,6 +1406,7 @@ export declare namespace PinGenerationAttributes {
1265
1406
  $unknown?: never;
1266
1407
  }
1267
1408
  /**
1409
+ * @public
1268
1410
  * <p>Parameters that are required to generate or verify Ibm3624 random PIN.</p>
1269
1411
  */
1270
1412
  interface Ibm3624RandomPinMember {
@@ -1277,6 +1419,7 @@ export declare namespace PinGenerationAttributes {
1277
1419
  $unknown?: never;
1278
1420
  }
1279
1421
  /**
1422
+ * @public
1280
1423
  * <p>Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.</p>
1281
1424
  */
1282
1425
  interface Ibm3624PinFromOffsetMember {
@@ -1288,6 +1431,9 @@ export declare namespace PinGenerationAttributes {
1288
1431
  Ibm3624PinFromOffset: Ibm3624PinFromOffset;
1289
1432
  $unknown?: never;
1290
1433
  }
1434
+ /**
1435
+ * @public
1436
+ */
1291
1437
  interface $UnknownMember {
1292
1438
  VisaPin?: never;
1293
1439
  VisaPinVerificationValue?: never;
@@ -1325,26 +1471,32 @@ export type PinBlockFormatForPinData = (typeof PinBlockFormatForPinData)[keyof t
1325
1471
  */
1326
1472
  export interface GeneratePinDataInput {
1327
1473
  /**
1474
+ * @public
1328
1475
  * <p>The <code>keyARN</code> of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.</p>
1329
1476
  */
1330
1477
  GenerationKeyIdentifier: string | undefined;
1331
1478
  /**
1479
+ * @public
1332
1480
  * <p>The <code>keyARN</code> of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.</p>
1333
1481
  */
1334
1482
  EncryptionKeyIdentifier: string | undefined;
1335
1483
  /**
1484
+ * @public
1336
1485
  * <p>The attributes and values to use for PIN, PVV, or PIN Offset generation.</p>
1337
1486
  */
1338
1487
  GenerationAttributes: PinGenerationAttributes | undefined;
1339
1488
  /**
1489
+ * @public
1340
1490
  * <p>The length of PIN under generation.</p>
1341
1491
  */
1342
1492
  PinDataLength?: number;
1343
1493
  /**
1494
+ * @public
1344
1495
  * <p>The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.</p>
1345
1496
  */
1346
1497
  PrimaryAccountNumber: string | undefined;
1347
1498
  /**
1499
+ * @public
1348
1500
  * <p>The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports <code>ISO_Format_0</code> and <code>ISO_Format_3</code>.</p>
1349
1501
  * <p>The <code>ISO_Format_0</code> PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.</p>
1350
1502
  * <p>The <code>ISO_Format_3</code> PIN block format is the same as <code>ISO_Format_0</code> except that the fill digits are random values from 10 to 15.</p>
@@ -1361,6 +1513,7 @@ export type PinData = PinData.PinOffsetMember | PinData.VerificationValueMember
1361
1513
  */
1362
1514
  export declare namespace PinData {
1363
1515
  /**
1516
+ * @public
1364
1517
  * <p>The PIN offset value.</p>
1365
1518
  */
1366
1519
  interface PinOffsetMember {
@@ -1369,6 +1522,7 @@ export declare namespace PinData {
1369
1522
  $unknown?: never;
1370
1523
  }
1371
1524
  /**
1525
+ * @public
1372
1526
  * <p>The unique data to identify a cardholder. In most cases, this is the same as cardholder's Primary Account Number (PAN). If a value is not provided, it defaults to PAN.</p>
1373
1527
  */
1374
1528
  interface VerificationValueMember {
@@ -1376,6 +1530,9 @@ export declare namespace PinData {
1376
1530
  VerificationValue: string;
1377
1531
  $unknown?: never;
1378
1532
  }
1533
+ /**
1534
+ * @public
1535
+ */
1379
1536
  interface $UnknownMember {
1380
1537
  PinOffset?: never;
1381
1538
  VerificationValue?: never;
@@ -1393,26 +1550,32 @@ export declare namespace PinData {
1393
1550
  */
1394
1551
  export interface GeneratePinDataOutput {
1395
1552
  /**
1553
+ * @public
1396
1554
  * <p>The <code>keyARN</code> of the pin data generation key that Amazon Web Services Payment Cryptography uses for PIN, PVV or PIN Offset generation.</p>
1397
1555
  */
1398
1556
  GenerationKeyArn: string | undefined;
1399
1557
  /**
1558
+ * @public
1400
1559
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
1401
1560
  */
1402
1561
  GenerationKeyCheckValue: string | undefined;
1403
1562
  /**
1563
+ * @public
1404
1564
  * <p>The <code>keyARN</code> of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.</p>
1405
1565
  */
1406
1566
  EncryptionKeyArn: string | undefined;
1407
1567
  /**
1568
+ * @public
1408
1569
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
1409
1570
  */
1410
1571
  EncryptionKeyCheckValue: string | undefined;
1411
1572
  /**
1573
+ * @public
1412
1574
  * <p>The PIN block encrypted under PEK from Amazon Web Services Payment Cryptography. The encrypted PIN block is a composite of PAN (Primary Account Number) and PIN (Personal Identification Number), generated in accordance with ISO 9564 standard.</p>
1413
1575
  */
1414
1576
  EncryptedPinBlock: string | undefined;
1415
1577
  /**
1578
+ * @public
1416
1579
  * <p>The attributes and values Amazon Web Services Payment Cryptography uses for pin data generation.</p>
1417
1580
  */
1418
1581
  PinData: PinData | undefined;
@@ -1423,18 +1586,22 @@ export interface GeneratePinDataOutput {
1423
1586
  */
1424
1587
  export interface Ibm3624PinVerification {
1425
1588
  /**
1589
+ * @public
1426
1590
  * <p>The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.</p>
1427
1591
  */
1428
1592
  DecimalizationTable: string | undefined;
1429
1593
  /**
1594
+ * @public
1430
1595
  * <p>The padding character for validation data.</p>
1431
1596
  */
1432
1597
  PinValidationDataPadCharacter: string | undefined;
1433
1598
  /**
1599
+ * @public
1434
1600
  * <p>The unique data for cardholder identification.</p>
1435
1601
  */
1436
1602
  PinValidationData: string | undefined;
1437
1603
  /**
1604
+ * @public
1438
1605
  * <p>The PIN offset value.</p>
1439
1606
  */
1440
1607
  PinOffset: string | undefined;
@@ -1449,6 +1616,7 @@ export type ReEncryptionAttributes = ReEncryptionAttributes.DukptMember | ReEncr
1449
1616
  */
1450
1617
  export declare namespace ReEncryptionAttributes {
1451
1618
  /**
1619
+ * @public
1452
1620
  * <p>Parameters that are required to encrypt data using symmetric keys.</p>
1453
1621
  */
1454
1622
  interface SymmetricMember {
@@ -1457,6 +1625,7 @@ export declare namespace ReEncryptionAttributes {
1457
1625
  $unknown?: never;
1458
1626
  }
1459
1627
  /**
1628
+ * @public
1460
1629
  * <p>Parameters that are required to encrypt plaintext data using DUKPT.</p>
1461
1630
  */
1462
1631
  interface DukptMember {
@@ -1464,6 +1633,9 @@ export declare namespace ReEncryptionAttributes {
1464
1633
  Dukpt: DukptEncryptionAttributes;
1465
1634
  $unknown?: never;
1466
1635
  }
1636
+ /**
1637
+ * @public
1638
+ */
1467
1639
  interface $UnknownMember {
1468
1640
  Symmetric?: never;
1469
1641
  Dukpt?: never;
@@ -1481,22 +1653,27 @@ export declare namespace ReEncryptionAttributes {
1481
1653
  */
1482
1654
  export interface ReEncryptDataInput {
1483
1655
  /**
1656
+ * @public
1484
1657
  * <p>The <code>keyARN</code> of the encryption key of incoming ciphertext data.</p>
1485
1658
  */
1486
1659
  IncomingKeyIdentifier: string | undefined;
1487
1660
  /**
1661
+ * @public
1488
1662
  * <p>The <code>keyARN</code> of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.</p>
1489
1663
  */
1490
1664
  OutgoingKeyIdentifier: string | undefined;
1491
1665
  /**
1666
+ * @public
1492
1667
  * <p>Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.</p>
1493
1668
  */
1494
1669
  CipherText: string | undefined;
1495
1670
  /**
1671
+ * @public
1496
1672
  * <p>The attributes and values for incoming ciphertext.</p>
1497
1673
  */
1498
1674
  IncomingEncryptionAttributes: ReEncryptionAttributes | undefined;
1499
1675
  /**
1676
+ * @public
1500
1677
  * <p>The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.</p>
1501
1678
  */
1502
1679
  OutgoingEncryptionAttributes: ReEncryptionAttributes | undefined;
@@ -1506,14 +1683,17 @@ export interface ReEncryptDataInput {
1506
1683
  */
1507
1684
  export interface ReEncryptDataOutput {
1508
1685
  /**
1686
+ * @public
1509
1687
  * <p>The keyARN (Amazon Resource Name) of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.</p>
1510
1688
  */
1511
1689
  KeyArn: string | undefined;
1512
1690
  /**
1691
+ * @public
1513
1692
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
1514
1693
  */
1515
1694
  KeyCheckValue: string | undefined;
1516
1695
  /**
1696
+ * @public
1517
1697
  * <p>The encrypted ciphertext.</p>
1518
1698
  */
1519
1699
  CipherText: string | undefined;
@@ -1524,6 +1704,7 @@ export interface ReEncryptDataOutput {
1524
1704
  */
1525
1705
  export interface TranslationPinDataIsoFormat034 {
1526
1706
  /**
1707
+ * @public
1527
1708
  * <p>The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.</p>
1528
1709
  */
1529
1710
  PrimaryAccountNumber: string | undefined;
@@ -1544,6 +1725,7 @@ export type TranslationIsoFormats = TranslationIsoFormats.IsoFormat0Member | Tra
1544
1725
  */
1545
1726
  export declare namespace TranslationIsoFormats {
1546
1727
  /**
1728
+ * @public
1547
1729
  * <p>Parameters that are required for ISO9564 PIN format 0 tranlation.</p>
1548
1730
  */
1549
1731
  interface IsoFormat0Member {
@@ -1554,6 +1736,7 @@ export declare namespace TranslationIsoFormats {
1554
1736
  $unknown?: never;
1555
1737
  }
1556
1738
  /**
1739
+ * @public
1557
1740
  * <p>Parameters that are required for ISO9564 PIN format 1 tranlation.</p>
1558
1741
  */
1559
1742
  interface IsoFormat1Member {
@@ -1564,6 +1747,7 @@ export declare namespace TranslationIsoFormats {
1564
1747
  $unknown?: never;
1565
1748
  }
1566
1749
  /**
1750
+ * @public
1567
1751
  * <p>Parameters that are required for ISO9564 PIN format 3 tranlation.</p>
1568
1752
  */
1569
1753
  interface IsoFormat3Member {
@@ -1574,6 +1758,7 @@ export declare namespace TranslationIsoFormats {
1574
1758
  $unknown?: never;
1575
1759
  }
1576
1760
  /**
1761
+ * @public
1577
1762
  * <p>Parameters that are required for ISO9564 PIN format 4 tranlation.</p>
1578
1763
  */
1579
1764
  interface IsoFormat4Member {
@@ -1583,6 +1768,9 @@ export declare namespace TranslationIsoFormats {
1583
1768
  IsoFormat4: TranslationPinDataIsoFormat034;
1584
1769
  $unknown?: never;
1585
1770
  }
1771
+ /**
1772
+ * @public
1773
+ */
1586
1774
  interface $UnknownMember {
1587
1775
  IsoFormat0?: never;
1588
1776
  IsoFormat1?: never;
@@ -1604,30 +1792,37 @@ export declare namespace TranslationIsoFormats {
1604
1792
  */
1605
1793
  export interface TranslatePinDataInput {
1606
1794
  /**
1795
+ * @public
1607
1796
  * <p>The <code>keyARN</code> of the encryption key under which incoming PIN block data is encrypted. This key type can be PEK or BDK.</p>
1608
1797
  */
1609
1798
  IncomingKeyIdentifier: string | undefined;
1610
1799
  /**
1800
+ * @public
1611
1801
  * <p>The <code>keyARN</code> of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.</p>
1612
1802
  */
1613
1803
  OutgoingKeyIdentifier: string | undefined;
1614
1804
  /**
1805
+ * @public
1615
1806
  * <p>The format of the incoming PIN block data for tranlation within Amazon Web Services Payment Cryptography.</p>
1616
1807
  */
1617
1808
  IncomingTranslationAttributes: TranslationIsoFormats | undefined;
1618
1809
  /**
1810
+ * @public
1619
1811
  * <p>The format of the outgoing PIN block data after tranlation by Amazon Web Services Payment Cryptography.</p>
1620
1812
  */
1621
1813
  OutgoingTranslationAttributes: TranslationIsoFormats | undefined;
1622
1814
  /**
1815
+ * @public
1623
1816
  * <p>The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.</p>
1624
1817
  */
1625
1818
  EncryptedPinBlock: string | undefined;
1626
1819
  /**
1820
+ * @public
1627
1821
  * <p>The attributes and values to use for incoming DUKPT encryption key for PIN block tranlation.</p>
1628
1822
  */
1629
1823
  IncomingDukptAttributes?: DukptDerivationAttributes;
1630
1824
  /**
1825
+ * @public
1631
1826
  * <p>The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.</p>
1632
1827
  */
1633
1828
  OutgoingDukptAttributes?: DukptDerivationAttributes;
@@ -1637,14 +1832,17 @@ export interface TranslatePinDataInput {
1637
1832
  */
1638
1833
  export interface TranslatePinDataOutput {
1639
1834
  /**
1835
+ * @public
1640
1836
  * <p>The ougoing encrypted PIN block data after tranlation.</p>
1641
1837
  */
1642
1838
  PinBlock: string | undefined;
1643
1839
  /**
1840
+ * @public
1644
1841
  * <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses to encrypt outgoing PIN block data after translation.</p>
1645
1842
  */
1646
1843
  KeyArn: string | undefined;
1647
1844
  /**
1845
+ * @public
1648
1846
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
1649
1847
  */
1650
1848
  KeyCheckValue: string | undefined;
@@ -1671,6 +1869,7 @@ export declare class VerificationFailedException extends __BaseException {
1671
1869
  readonly name: "VerificationFailedException";
1672
1870
  readonly $fault: "client";
1673
1871
  /**
1872
+ * @public
1674
1873
  * <p>The reason for the exception.</p>
1675
1874
  */
1676
1875
  Reason: VerificationFailedReason | string | undefined;
@@ -1686,10 +1885,12 @@ export declare class VerificationFailedException extends __BaseException {
1686
1885
  */
1687
1886
  export interface SessionKeyAmex {
1688
1887
  /**
1888
+ * @public
1689
1889
  * <p>The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.</p>
1690
1890
  */
1691
1891
  PrimaryAccountNumber: string | undefined;
1692
1892
  /**
1893
+ * @public
1693
1894
  * <p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>
1694
1895
  */
1695
1896
  PanSequenceNumber: string | undefined;
@@ -1700,14 +1901,17 @@ export interface SessionKeyAmex {
1700
1901
  */
1701
1902
  export interface SessionKeyEmv2000 {
1702
1903
  /**
1904
+ * @public
1703
1905
  * <p>The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.</p>
1704
1906
  */
1705
1907
  PrimaryAccountNumber: string | undefined;
1706
1908
  /**
1909
+ * @public
1707
1910
  * <p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>
1708
1911
  */
1709
1912
  PanSequenceNumber: string | undefined;
1710
1913
  /**
1914
+ * @public
1711
1915
  * <p>The transaction counter that is provided by the terminal during transaction processing.</p>
1712
1916
  */
1713
1917
  ApplicationTransactionCounter: string | undefined;
@@ -1718,14 +1922,17 @@ export interface SessionKeyEmv2000 {
1718
1922
  */
1719
1923
  export interface SessionKeyEmvCommon {
1720
1924
  /**
1925
+ * @public
1721
1926
  * <p>The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.</p>
1722
1927
  */
1723
1928
  PrimaryAccountNumber: string | undefined;
1724
1929
  /**
1930
+ * @public
1725
1931
  * <p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>
1726
1932
  */
1727
1933
  PanSequenceNumber: string | undefined;
1728
1934
  /**
1935
+ * @public
1729
1936
  * <p>The transaction counter that is provided by the terminal during transaction processing.</p>
1730
1937
  */
1731
1938
  ApplicationTransactionCounter: string | undefined;
@@ -1736,18 +1943,22 @@ export interface SessionKeyEmvCommon {
1736
1943
  */
1737
1944
  export interface SessionKeyMastercard {
1738
1945
  /**
1946
+ * @public
1739
1947
  * <p>The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.</p>
1740
1948
  */
1741
1949
  PrimaryAccountNumber: string | undefined;
1742
1950
  /**
1951
+ * @public
1743
1952
  * <p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>
1744
1953
  */
1745
1954
  PanSequenceNumber: string | undefined;
1746
1955
  /**
1956
+ * @public
1747
1957
  * <p>The transaction counter that is provided by the terminal during transaction processing.</p>
1748
1958
  */
1749
1959
  ApplicationTransactionCounter: string | undefined;
1750
1960
  /**
1961
+ * @public
1751
1962
  * <p>A random number generated by the issuer.</p>
1752
1963
  */
1753
1964
  UnpredictableNumber: string | undefined;
@@ -1758,10 +1969,12 @@ export interface SessionKeyMastercard {
1758
1969
  */
1759
1970
  export interface SessionKeyVisa {
1760
1971
  /**
1972
+ * @public
1761
1973
  * <p>The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.</p>
1762
1974
  */
1763
1975
  PrimaryAccountNumber: string | undefined;
1764
1976
  /**
1977
+ * @public
1765
1978
  * <p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>
1766
1979
  */
1767
1980
  PanSequenceNumber: string | undefined;
@@ -1776,6 +1989,7 @@ export type SessionKeyDerivation = SessionKeyDerivation.AmexMember | SessionKeyD
1776
1989
  */
1777
1990
  export declare namespace SessionKeyDerivation {
1778
1991
  /**
1992
+ * @public
1779
1993
  * <p>Parameters to derive session key for an Emv common payment card for ARQC verification.</p>
1780
1994
  */
1781
1995
  interface EmvCommonMember {
@@ -1787,6 +2001,7 @@ export declare namespace SessionKeyDerivation {
1787
2001
  $unknown?: never;
1788
2002
  }
1789
2003
  /**
2004
+ * @public
1790
2005
  * <p>Parameters to derive session key for a Mastercard payment card for ARQC verification.</p>
1791
2006
  */
1792
2007
  interface MastercardMember {
@@ -1798,6 +2013,7 @@ export declare namespace SessionKeyDerivation {
1798
2013
  $unknown?: never;
1799
2014
  }
1800
2015
  /**
2016
+ * @public
1801
2017
  * <p>Parameters to derive session key for an Emv2000 payment card for ARQC verification.</p>
1802
2018
  */
1803
2019
  interface Emv2000Member {
@@ -1809,6 +2025,7 @@ export declare namespace SessionKeyDerivation {
1809
2025
  $unknown?: never;
1810
2026
  }
1811
2027
  /**
2028
+ * @public
1812
2029
  * <p>Parameters to derive session key for an Amex payment card for ARQC verification.</p>
1813
2030
  */
1814
2031
  interface AmexMember {
@@ -1820,6 +2037,7 @@ export declare namespace SessionKeyDerivation {
1820
2037
  $unknown?: never;
1821
2038
  }
1822
2039
  /**
2040
+ * @public
1823
2041
  * <p>Parameters to derive session key for a Visa payment cardfor ARQC verification.</p>
1824
2042
  */
1825
2043
  interface VisaMember {
@@ -1830,6 +2048,9 @@ export declare namespace SessionKeyDerivation {
1830
2048
  Visa: SessionKeyVisa;
1831
2049
  $unknown?: never;
1832
2050
  }
2051
+ /**
2052
+ * @public
2053
+ */
1833
2054
  interface $UnknownMember {
1834
2055
  EmvCommon?: never;
1835
2056
  Mastercard?: never;
@@ -1853,26 +2074,32 @@ export declare namespace SessionKeyDerivation {
1853
2074
  */
1854
2075
  export interface VerifyAuthRequestCryptogramInput {
1855
2076
  /**
2077
+ * @public
1856
2078
  * <p>The <code>keyARN</code> of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.</p>
1857
2079
  */
1858
2080
  KeyIdentifier: string | undefined;
1859
2081
  /**
2082
+ * @public
1860
2083
  * <p>The transaction data that Amazon Web Services Payment Cryptography uses for ARQC verification. The same transaction is used for ARQC generation outside of Amazon Web Services Payment Cryptography.</p>
1861
2084
  */
1862
2085
  TransactionData: string | undefined;
1863
2086
  /**
2087
+ * @public
1864
2088
  * <p>The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.</p>
1865
2089
  */
1866
2090
  AuthRequestCryptogram: string | undefined;
1867
2091
  /**
2092
+ * @public
1868
2093
  * <p>The method to use when deriving the major encryption key for ARQC verification within Amazon Web Services Payment Cryptography. The same key derivation mode was used for ARQC generation outside of Amazon Web Services Payment Cryptography.</p>
1869
2094
  */
1870
2095
  MajorKeyDerivationMode: MajorKeyDerivationMode | string | undefined;
1871
2096
  /**
2097
+ * @public
1872
2098
  * <p>The attributes and values to use for deriving a session key for ARQC verification within Amazon Web Services Payment Cryptography. The same attributes were used for ARQC generation outside of Amazon Web Services Payment Cryptography.</p>
1873
2099
  */
1874
2100
  SessionKeyDerivationAttributes: SessionKeyDerivation | undefined;
1875
2101
  /**
2102
+ * @public
1876
2103
  * <p>The attributes and values for auth request cryptogram verification. These parameters are required in case using ARPC Method 1 or Method 2 for ARQC verification.</p>
1877
2104
  */
1878
2105
  AuthResponseAttributes?: CryptogramAuthResponse;
@@ -1882,14 +2109,17 @@ export interface VerifyAuthRequestCryptogramInput {
1882
2109
  */
1883
2110
  export interface VerifyAuthRequestCryptogramOutput {
1884
2111
  /**
2112
+ * @public
1885
2113
  * <p>The <code>keyARN</code> of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.</p>
1886
2114
  */
1887
2115
  KeyArn: string | undefined;
1888
2116
  /**
2117
+ * @public
1889
2118
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
1890
2119
  */
1891
2120
  KeyCheckValue: string | undefined;
1892
2121
  /**
2122
+ * @public
1893
2123
  * <p>The result for ARQC verification or ARPC generation within Amazon Web Services Payment Cryptography.</p>
1894
2124
  */
1895
2125
  AuthResponseValue?: string;
@@ -1899,18 +2129,22 @@ export interface VerifyAuthRequestCryptogramOutput {
1899
2129
  */
1900
2130
  export interface VerifyCardValidationDataInput {
1901
2131
  /**
2132
+ * @public
1902
2133
  * <p>The <code>keyARN</code> of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify card data.</p>
1903
2134
  */
1904
2135
  KeyIdentifier: string | undefined;
1905
2136
  /**
2137
+ * @public
1906
2138
  * <p>The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.</p>
1907
2139
  */
1908
2140
  PrimaryAccountNumber: string | undefined;
1909
2141
  /**
2142
+ * @public
1910
2143
  * <p>The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography.</p>
1911
2144
  */
1912
2145
  VerificationAttributes: CardVerificationAttributes | undefined;
1913
2146
  /**
2147
+ * @public
1914
2148
  * <p>The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.</p>
1915
2149
  */
1916
2150
  ValidationData: string | undefined;
@@ -1920,10 +2154,12 @@ export interface VerifyCardValidationDataInput {
1920
2154
  */
1921
2155
  export interface VerifyCardValidationDataOutput {
1922
2156
  /**
2157
+ * @public
1923
2158
  * <p>The <code>keyARN</code> of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify CVV or CSC.</p>
1924
2159
  */
1925
2160
  KeyArn: string | undefined;
1926
2161
  /**
2162
+ * @public
1927
2163
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
1928
2164
  */
1929
2165
  KeyCheckValue: string | undefined;
@@ -1933,22 +2169,27 @@ export interface VerifyCardValidationDataOutput {
1933
2169
  */
1934
2170
  export interface VerifyMacInput {
1935
2171
  /**
2172
+ * @public
1936
2173
  * <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.</p>
1937
2174
  */
1938
2175
  KeyIdentifier: string | undefined;
1939
2176
  /**
2177
+ * @public
1940
2178
  * <p>The data on for which MAC is under verification.</p>
1941
2179
  */
1942
2180
  MessageData: string | undefined;
1943
2181
  /**
2182
+ * @public
1944
2183
  * <p>The MAC being verified.</p>
1945
2184
  */
1946
2185
  Mac: string | undefined;
1947
2186
  /**
2187
+ * @public
1948
2188
  * <p>The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.</p>
1949
2189
  */
1950
2190
  VerificationAttributes: MacAttributes | undefined;
1951
2191
  /**
2192
+ * @public
1952
2193
  * <p>The length of the MAC.</p>
1953
2194
  */
1954
2195
  MacLength?: number;
@@ -1958,10 +2199,12 @@ export interface VerifyMacInput {
1958
2199
  */
1959
2200
  export interface VerifyMacOutput {
1960
2201
  /**
2202
+ * @public
1961
2203
  * <p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for MAC verification.</p>
1962
2204
  */
1963
2205
  KeyArn: string | undefined;
1964
2206
  /**
2207
+ * @public
1965
2208
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
1966
2209
  */
1967
2210
  KeyCheckValue: string | undefined;
@@ -1972,10 +2215,12 @@ export interface VerifyMacOutput {
1972
2215
  */
1973
2216
  export interface VisaPinVerification {
1974
2217
  /**
2218
+ * @public
1975
2219
  * <p>The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).</p>
1976
2220
  */
1977
2221
  PinVerificationKeyIndex: number | undefined;
1978
2222
  /**
2223
+ * @public
1979
2224
  * <p>Parameters that are required to generate or verify Visa PVV (PIN Verification Value).</p>
1980
2225
  */
1981
2226
  VerificationValue: string | undefined;
@@ -1990,6 +2235,7 @@ export type PinVerificationAttributes = PinVerificationAttributes.Ibm3624PinMemb
1990
2235
  */
1991
2236
  export declare namespace PinVerificationAttributes {
1992
2237
  /**
2238
+ * @public
1993
2239
  * <p>Parameters that are required to generate or verify Visa PIN.</p>
1994
2240
  */
1995
2241
  interface VisaPinMember {
@@ -1998,6 +2244,7 @@ export declare namespace PinVerificationAttributes {
1998
2244
  $unknown?: never;
1999
2245
  }
2000
2246
  /**
2247
+ * @public
2001
2248
  * <p>Parameters that are required to generate or verify Ibm3624 PIN.</p>
2002
2249
  */
2003
2250
  interface Ibm3624PinMember {
@@ -2005,6 +2252,9 @@ export declare namespace PinVerificationAttributes {
2005
2252
  Ibm3624Pin: Ibm3624PinVerification;
2006
2253
  $unknown?: never;
2007
2254
  }
2255
+ /**
2256
+ * @public
2257
+ */
2008
2258
  interface $UnknownMember {
2009
2259
  VisaPin?: never;
2010
2260
  Ibm3624Pin?: never;
@@ -2022,36 +2272,44 @@ export declare namespace PinVerificationAttributes {
2022
2272
  */
2023
2273
  export interface VerifyPinDataInput {
2024
2274
  /**
2275
+ * @public
2025
2276
  * <p>The <code>keyARN</code> of the PIN verification key.</p>
2026
2277
  */
2027
2278
  VerificationKeyIdentifier: string | undefined;
2028
2279
  /**
2280
+ * @public
2029
2281
  * <p>The <code>keyARN</code> of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.</p>
2030
2282
  */
2031
2283
  EncryptionKeyIdentifier: string | undefined;
2032
2284
  /**
2285
+ * @public
2033
2286
  * <p>The attributes and values for PIN data verification.</p>
2034
2287
  */
2035
2288
  VerificationAttributes: PinVerificationAttributes | undefined;
2036
2289
  /**
2290
+ * @public
2037
2291
  * <p>The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.</p>
2038
2292
  */
2039
2293
  EncryptedPinBlock: string | undefined;
2040
2294
  /**
2295
+ * @public
2041
2296
  * <p>The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.</p>
2042
2297
  */
2043
2298
  PrimaryAccountNumber: string | undefined;
2044
2299
  /**
2300
+ * @public
2045
2301
  * <p>The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports <code>ISO_Format_0</code> and <code>ISO_Format_3</code>.</p>
2046
2302
  * <p>The <code>ISO_Format_0</code> PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.</p>
2047
2303
  * <p>The <code>ISO_Format_3</code> PIN block format is the same as <code>ISO_Format_0</code> except that the fill digits are random values from 10 to 15.</p>
2048
2304
  */
2049
2305
  PinBlockFormat: PinBlockFormatForPinData | string | undefined;
2050
2306
  /**
2307
+ * @public
2051
2308
  * <p>The length of PIN being verified.</p>
2052
2309
  */
2053
2310
  PinDataLength?: number;
2054
2311
  /**
2312
+ * @public
2055
2313
  * <p>The attributes and values for the DUKPT encrypted PIN block data.</p>
2056
2314
  */
2057
2315
  DukptAttributes?: DukptAttributes;
@@ -2061,18 +2319,22 @@ export interface VerifyPinDataInput {
2061
2319
  */
2062
2320
  export interface VerifyPinDataOutput {
2063
2321
  /**
2322
+ * @public
2064
2323
  * <p>The <code>keyARN</code> of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.</p>
2065
2324
  */
2066
2325
  VerificationKeyArn: string | undefined;
2067
2326
  /**
2327
+ * @public
2068
2328
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
2069
2329
  */
2070
2330
  VerificationKeyCheckValue: string | undefined;
2071
2331
  /**
2332
+ * @public
2072
2333
  * <p>The <code>keyARN</code> of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.</p>
2073
2334
  */
2074
2335
  EncryptionKeyArn: string | undefined;
2075
2336
  /**
2337
+ * @public
2076
2338
  * <p>The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed. Amazon Web Services Payment Cryptography calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.</p>
2077
2339
  */
2078
2340
  EncryptionKeyCheckValue: string | undefined;