1{ 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2022-02-03", 5 "endpointPrefix":"dataplane.payment-cryptography", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceFullName":"Payment Cryptography Data Plane", 9 "serviceId":"Payment Cryptography Data", 10 "signatureVersion":"v4", 11 "signingName":"payment-cryptography", 12 "uid":"payment-cryptography-data-2022-02-03" 13 }, 14 "operations":{ 15 "DecryptData":{ 16 "name":"DecryptData", 17 "http":{ 18 "method":"POST", 19 "requestUri":"/keys/{KeyIdentifier}/decrypt", 20 "responseCode":200 21 }, 22 "input":{"shape":"DecryptDataInput"}, 23 "output":{"shape":"DecryptDataOutput"}, 24 "errors":[ 25 {"shape":"ValidationException"}, 26 {"shape":"AccessDeniedException"}, 27 {"shape":"ResourceNotFoundException"}, 28 {"shape":"ThrottlingException"}, 29 {"shape":"InternalServerException"} 30 ], 31 "documentation":"<p>Decrypts ciphertext data to plaintext using symmetric, asymmetric, or DUKPT data encryption key. For more information, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/decrypt-data.html\">Decrypt data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>You can use an encryption key generated within Amazon Web Services Payment Cryptography, or you can import your own encryption key by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a>. For this operation, the key must have <code>KeyModesOfUse</code> set to <code>Decrypt</code>. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext using the private component of the asymmetric encryption key pair. For data encryption outside of Amazon Web Services Payment Cryptography, you can export the public component of the asymmetric key pair by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html\">GetPublicCertificate</a>.</p> <p>For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports <code>TDES</code> and <code>AES</code> algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports <code>RSA</code>. When you use DUKPT, for <code>TDES</code> algorithm, the ciphertext data length must be a multiple of 16 bytes. For <code>AES</code> algorithm, the ciphertext data length must be a multiple of 32 bytes.</p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. </p> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>EncryptData</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html\">GetPublicCertificate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a> </p> </li> </ul>" 32 }, 33 "EncryptData":{ 34 "name":"EncryptData", 35 "http":{ 36 "method":"POST", 37 "requestUri":"/keys/{KeyIdentifier}/encrypt", 38 "responseCode":200 39 }, 40 "input":{"shape":"EncryptDataInput"}, 41 "output":{"shape":"EncryptDataOutput"}, 42 "errors":[ 43 {"shape":"ValidationException"}, 44 {"shape":"AccessDeniedException"}, 45 {"shape":"ResourceNotFoundException"}, 46 {"shape":"ThrottlingException"}, 47 {"shape":"InternalServerException"} 48 ], 49 "documentation":"<p>Encrypts plaintext data to ciphertext using symmetric, asymmetric, or DUKPT data encryption key. For more information, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/encrypt-data.html\">Encrypt data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>You can generate an encryption key within Amazon Web Services Payment Cryptography by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html\">CreateKey</a>. You can import your own encryption key by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a>. For this operation, the key must have <code>KeyModesOfUse</code> set to <code>Encrypt</code>. In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a>). </p> <p>for symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports <code>TDES</code> and <code>AES</code> algorithms. For asymmetric encryption, Amazon Web Services Payment Cryptography supports <code>RSA</code>. To encrypt using DUKPT, you must already have a DUKPT key in your account with <code>KeyModesOfUse</code> set to <code>DeriveKey</code>, or you can generate a new DUKPT key by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html\">CreateKey</a>.</p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DecryptData</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html\">GetPublicCertificate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a> </p> </li> <li> <p> <a>ReEncryptData</a> </p> </li> </ul>" 50 }, 51 "GenerateCardValidationData":{ 52 "name":"GenerateCardValidationData", 53 "http":{ 54 "method":"POST", 55 "requestUri":"/cardvalidationdata/generate", 56 "responseCode":200 57 }, 58 "input":{"shape":"GenerateCardValidationDataInput"}, 59 "output":{"shape":"GenerateCardValidationDataOutput"}, 60 "errors":[ 61 {"shape":"ValidationException"}, 62 {"shape":"AccessDeniedException"}, 63 {"shape":"ResourceNotFoundException"}, 64 {"shape":"ThrottlingException"}, 65 {"shape":"InternalServerException"} 66 ], 67 "documentation":"<p>Generates card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC). For more information, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-card-data.html\">Generate card data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>This operation generates a CVV or CSC value that is printed on a payment credit or debit card during card production. The CVV or CSC, PAN (Primary Account Number) and expiration date of the card are required to check its validity during transaction processing. To begin this operation, a CVK (Card Verification Key) encryption key is required. You can use <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html\">CreateKey</a> or <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a> to establish a CVK within Amazon Web Services Payment Cryptography. The <code>KeyModesOfUse</code> should be set to <code>Generate</code> and <code>Verify</code> for a CVK encryption key. </p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. </p> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a> </p> </li> <li> <p> <a>VerifyCardValidationData</a> </p> </li> </ul>" 68 }, 69 "GenerateMac":{ 70 "name":"GenerateMac", 71 "http":{ 72 "method":"POST", 73 "requestUri":"/mac/generate", 74 "responseCode":200 75 }, 76 "input":{"shape":"GenerateMacInput"}, 77 "output":{"shape":"GenerateMacOutput"}, 78 "errors":[ 79 {"shape":"ValidationException"}, 80 {"shape":"AccessDeniedException"}, 81 {"shape":"ResourceNotFoundException"}, 82 {"shape":"ThrottlingException"}, 83 {"shape":"InternalServerException"} 84 ], 85 "documentation":"<p>Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography. </p> <p>You can use this operation when keys won't be shared but mutual data is present on both ends for validation. In this case, known data values are used to generate a MAC on both ends for comparision without sending or receiving data in ciphertext or plaintext. You can use this operation to generate a DUPKT, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for <code>KeyUsage</code> such as <code>TR31_M7_HMAC_KEY</code> for HMAC generation, and they key must have <code>KeyModesOfUse</code> set to <code>Generate</code> and <code>Verify</code>.</p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. </p> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>VerifyMac</a> </p> </li> </ul>" 86 }, 87 "GeneratePinData":{ 88 "name":"GeneratePinData", 89 "http":{ 90 "method":"POST", 91 "requestUri":"/pindata/generate", 92 "responseCode":200 93 }, 94 "input":{"shape":"GeneratePinDataInput"}, 95 "output":{"shape":"GeneratePinDataOutput"}, 96 "errors":[ 97 {"shape":"ValidationException"}, 98 {"shape":"AccessDeniedException"}, 99 {"shape":"ResourceNotFoundException"}, 100 {"shape":"ThrottlingException"}, 101 {"shape":"InternalServerException"} 102 ], 103 "documentation":"<p>Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance. For more information, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/generate-pin-data.html\">Generate PIN data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation generates PIN, PVV, or PIN Offset and then encrypts it using Pin Encryption Key (PEK) to create an <code>EncryptedPinBlock</code> for transmission from Amazon Web Services Payment Cryptography. This operation uses a separate Pin Verification Key (PVK) for VISA PVV generation. </p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>GenerateCardValidationData</a> </p> </li> <li> <p> <a>TranslatePinData</a> </p> </li> <li> <p> <a>VerifyPinData</a> </p> </li> </ul>" 104 }, 105 "ReEncryptData":{ 106 "name":"ReEncryptData", 107 "http":{ 108 "method":"POST", 109 "requestUri":"/keys/{IncomingKeyIdentifier}/reencrypt", 110 "responseCode":200 111 }, 112 "input":{"shape":"ReEncryptDataInput"}, 113 "output":{"shape":"ReEncryptDataOutput"}, 114 "errors":[ 115 {"shape":"ValidationException"}, 116 {"shape":"AccessDeniedException"}, 117 {"shape":"ResourceNotFoundException"}, 118 {"shape":"ThrottlingException"}, 119 {"shape":"InternalServerException"} 120 ], 121 "documentation":"<p>Re-encrypt ciphertext using DUKPT, Symmetric and Asymmetric Data Encryption Keys. </p> <p>You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html\">CreateKey</a> or import your own encryption key by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a>. The <code>KeyArn</code> for use with this operation must be in a compatible key state with <code>KeyModesOfUse</code> set to <code>Encrypt</code>. In asymmetric encryption, ciphertext is encrypted using public component (imported by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a>) of the asymmetric key pair created outside of Amazon Web Services Payment Cryptography. </p> <p>For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports <code>TDES</code> and <code>AES</code> algorithms. For asymmetric encryption, Amazon Web Services Payment Cryptography supports <code>RSA</code>. To encrypt using DUKPT, a DUKPT key must already exist within your account with <code>KeyModesOfUse</code> set to <code>DeriveKey</code> or a new DUKPT can be generated by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html\">CreateKey</a>.</p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. </p> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>DecryptData</a> </p> </li> <li> <p> <a>EncryptData</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_GetPublicKeyCertificate.html\">GetPublicCertificate</a> </p> </li> <li> <p> <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a> </p> </li> </ul>" 122 }, 123 "TranslatePinData":{ 124 "name":"TranslatePinData", 125 "http":{ 126 "method":"POST", 127 "requestUri":"/pindata/translate", 128 "responseCode":200 129 }, 130 "input":{"shape":"TranslatePinDataInput"}, 131 "output":{"shape":"TranslatePinDataOutput"}, 132 "errors":[ 133 {"shape":"ValidationException"}, 134 {"shape":"AccessDeniedException"}, 135 {"shape":"ResourceNotFoundException"}, 136 {"shape":"ThrottlingException"}, 137 {"shape":"InternalServerException"} 138 ], 139 "documentation":"<p>Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/translate-pin-data.html\">Translate PIN data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>PIN block translation involves changing the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports <code>TDES</code> and <code>AES</code> key derivation type for DUKPT tranlations. You can use this operation for P2PE (Point to Point Encryption) use cases where the encryption keys should change but the processing system either does not need to, or is not permitted to, decrypt the data.</p> <p>The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for generation. </p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <note> <p>At this time, Amazon Web Services Payment Cryptography does not support translations to PIN format 4.</p> </note> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>GeneratePinData</a> </p> </li> <li> <p> <a>VerifyPinData</a> </p> </li> </ul>" 140 }, 141 "VerifyAuthRequestCryptogram":{ 142 "name":"VerifyAuthRequestCryptogram", 143 "http":{ 144 "method":"POST", 145 "requestUri":"/cryptogram/verify", 146 "responseCode":200 147 }, 148 "input":{"shape":"VerifyAuthRequestCryptogramInput"}, 149 "output":{"shape":"VerifyAuthRequestCryptogramOutput"}, 150 "errors":[ 151 {"shape":"ValidationException"}, 152 {"shape":"VerificationFailedException"}, 153 {"shape":"AccessDeniedException"}, 154 {"shape":"ResourceNotFoundException"}, 155 {"shape":"ThrottlingException"}, 156 {"shape":"InternalServerException"} 157 ], 158 "documentation":"<p>Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization. For more information, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/data-operations.verifyauthrequestcryptogram.html\">Verify auth request cryptogram</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>ARQC generation is done outside of Amazon Web Services Payment Cryptography and is typically generated on a point of sale terminal for an EMV chip card to obtain payment authorization during transaction time. For ARQC verification, you must first import the ARQC generated outside of Amazon Web Services Payment Cryptography by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_ImportKey.html\">ImportKey</a>. This operation uses the imported ARQC and an major encryption key (DUKPT) created by calling <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/API_CreateKey.html\">CreateKey</a> to either provide a boolean ARQC verification result or provide an APRC (Authorization Response Cryptogram) response using Method 1 or Method 2. The <code>ARPC_METHOD_1</code> uses <code>AuthResponseCode</code> to generate ARPC and <code>ARPC_METHOD_2</code> uses <code>CardStatusUpdate</code> to generate ARPC. </p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>VerifyCardValidationData</a> </p> </li> <li> <p> <a>VerifyPinData</a> </p> </li> </ul>" 159 }, 160 "VerifyCardValidationData":{ 161 "name":"VerifyCardValidationData", 162 "http":{ 163 "method":"POST", 164 "requestUri":"/cardvalidationdata/verify", 165 "responseCode":200 166 }, 167 "input":{"shape":"VerifyCardValidationDataInput"}, 168 "output":{"shape":"VerifyCardValidationDataOutput"}, 169 "errors":[ 170 {"shape":"ValidationException"}, 171 {"shape":"VerificationFailedException"}, 172 {"shape":"AccessDeniedException"}, 173 {"shape":"ResourceNotFoundException"}, 174 {"shape":"ThrottlingException"}, 175 {"shape":"InternalServerException"} 176 ], 177 "documentation":"<p>Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC). For more information, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-card-data.html\">Verify card data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>This operation validates the CVV or CSC codes that is printed on a payment credit or debit card during card payment transaction. The input values are typically provided as part of an inbound transaction to an issuer or supporting platform partner. Amazon Web Services Payment Cryptography uses CVV or CSC, PAN (Primary Account Number) and expiration date of the card to check its validity during transaction processing. In this operation, the CVK (Card Verification Key) encryption key for use with card data verification is same as the one in used for <a>GenerateCardValidationData</a>. </p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. </p> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>GenerateCardValidationData</a> </p> </li> <li> <p> <a>VerifyAuthRequestCryptogram</a> </p> </li> <li> <p> <a>VerifyPinData</a> </p> </li> </ul>" 178 }, 179 "VerifyMac":{ 180 "name":"VerifyMac", 181 "http":{ 182 "method":"POST", 183 "requestUri":"/mac/verify", 184 "responseCode":200 185 }, 186 "input":{"shape":"VerifyMacInput"}, 187 "output":{"shape":"VerifyMacOutput"}, 188 "errors":[ 189 {"shape":"ValidationException"}, 190 {"shape":"VerificationFailedException"}, 191 {"shape":"AccessDeniedException"}, 192 {"shape":"ResourceNotFoundException"}, 193 {"shape":"ThrottlingException"}, 194 {"shape":"InternalServerException"} 195 ], 196 "documentation":"<p>Verifies a Message Authentication Code (MAC). </p> <p>You can use this operation when keys won't be shared but mutual data is present on both ends for validation. In this case, known data values are used to generate a MAC on both ends for verification without sending or receiving data in ciphertext or plaintext. You can use this operation to verify a DUPKT, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. Use the same encryption key for MAC verification as you use for <a>GenerateMac</a>. </p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. </p> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>GenerateMac</a> </p> </li> </ul>" 197 }, 198 "VerifyPinData":{ 199 "name":"VerifyPinData", 200 "http":{ 201 "method":"POST", 202 "requestUri":"/pindata/verify", 203 "responseCode":200 204 }, 205 "input":{"shape":"VerifyPinDataInput"}, 206 "output":{"shape":"VerifyPinDataOutput"}, 207 "errors":[ 208 {"shape":"ValidationException"}, 209 {"shape":"VerificationFailedException"}, 210 {"shape":"AccessDeniedException"}, 211 {"shape":"ResourceNotFoundException"}, 212 {"shape":"ThrottlingException"}, 213 {"shape":"InternalServerException"} 214 ], 215 "documentation":"<p>Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/verify-pin-data.html\">Verify PIN data</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>This operation verifies PIN data for user payment card. A card holder PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN Offset generation and then encrypts it using PIN Encryption Key (PEK) to create an <code>EncryptedPinBlock</code> for transmission from Amazon Web Services Payment Cryptography. </p> <p>For information about valid keys for this operation, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/keys-validattributes.html\">Understanding key attributes</a> and <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/crypto-ops-validkeys-ops.html\">Key types for specific data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>. </p> <p> <b>Cross-account use</b>: This operation can't be used across different Amazon Web Services accounts.</p> <p> <b>Related operations:</b> </p> <ul> <li> <p> <a>GeneratePinData</a> </p> </li> <li> <p> <a>TranslatePinData</a> </p> </li> </ul>" 216 } 217 }, 218 "shapes":{ 219 "AccessDeniedException":{ 220 "type":"structure", 221 "members":{ 222 "Message":{"shape":"String"} 223 }, 224 "documentation":"<p>You do not have sufficient access to perform this action.</p>", 225 "error":{ 226 "httpStatusCode":403, 227 "senderFault":true 228 }, 229 "exception":true 230 }, 231 "AmexCardSecurityCodeVersion1":{ 232 "type":"structure", 233 "required":["CardExpiryDate"], 234 "members":{ 235 "CardExpiryDate":{ 236 "shape":"NumberLengthEquals4", 237 "documentation":"<p>The expiry date of a payment card.</p>" 238 } 239 }, 240 "documentation":"<p>Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.</p>" 241 }, 242 "AmexCardSecurityCodeVersion2":{ 243 "type":"structure", 244 "required":[ 245 "CardExpiryDate", 246 "ServiceCode" 247 ], 248 "members":{ 249 "CardExpiryDate":{ 250 "shape":"NumberLengthEquals4", 251 "documentation":"<p>The expiry date of a payment card.</p>" 252 }, 253 "ServiceCode":{ 254 "shape":"NumberLengthEquals3", 255 "documentation":"<p>The service code of the AMEX payment card. This is different from the Card Security Code (CSC).</p>" 256 } 257 }, 258 "documentation":"<p>Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.</p>" 259 }, 260 "AsymmetricEncryptionAttributes":{ 261 "type":"structure", 262 "members":{ 263 "PaddingType":{ 264 "shape":"PaddingType", 265 "documentation":"<p>The padding to be included with the data.</p>" 266 } 267 }, 268 "documentation":"<p>Parameters for plaintext encryption using asymmetric keys.</p>" 269 }, 270 "CardGenerationAttributes":{ 271 "type":"structure", 272 "members":{ 273 "AmexCardSecurityCodeVersion1":{"shape":"AmexCardSecurityCodeVersion1"}, 274 "AmexCardSecurityCodeVersion2":{ 275 "shape":"AmexCardSecurityCodeVersion2", 276 "documentation":"<p>Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.</p>" 277 }, 278 "CardHolderVerificationValue":{ 279 "shape":"CardHolderVerificationValue", 280 "documentation":"<p>Card data parameters that are required to generate a cardholder verification value for the payment card.</p>" 281 }, 282 "CardVerificationValue1":{ 283 "shape":"CardVerificationValue1", 284 "documentation":"<p>Card data parameters that are required to generate Card Verification Value (CVV) for the payment card.</p>" 285 }, 286 "CardVerificationValue2":{ 287 "shape":"CardVerificationValue2", 288 "documentation":"<p>Card data parameters that are required to generate Card Verification Value (CVV2) for the payment card.</p>" 289 }, 290 "DynamicCardVerificationCode":{ 291 "shape":"DynamicCardVerificationCode", 292 "documentation":"<p>Card data parameters that are required to generate CDynamic Card Verification Code (dCVC) for the payment card.</p>" 293 }, 294 "DynamicCardVerificationValue":{ 295 "shape":"DynamicCardVerificationValue", 296 "documentation":"<p>Card data parameters that are required to generate CDynamic Card Verification Value (dCVV) for the payment card.</p>" 297 } 298 }, 299 "documentation":"<p>Card data parameters that are required to generate Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).</p>", 300 "union":true 301 }, 302 "CardHolderVerificationValue":{ 303 "type":"structure", 304 "required":[ 305 "ApplicationTransactionCounter", 306 "PanSequenceNumber", 307 "UnpredictableNumber" 308 ], 309 "members":{ 310 "ApplicationTransactionCounter":{ 311 "shape":"HexLengthBetween2And4", 312 "documentation":"<p>The transaction counter value that comes from a point of sale terminal.</p>" 313 }, 314 "PanSequenceNumber":{ 315 "shape":"HexLengthEquals2", 316 "documentation":"<p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>" 317 }, 318 "UnpredictableNumber":{ 319 "shape":"HexLengthBetween2And8", 320 "documentation":"<p>A random number generated by the issuer.</p>" 321 } 322 }, 323 "documentation":"<p>Card data parameters that are required to generate a cardholder verification value for the payment card.</p>" 324 }, 325 "CardVerificationAttributes":{ 326 "type":"structure", 327 "members":{ 328 "AmexCardSecurityCodeVersion1":{"shape":"AmexCardSecurityCodeVersion1"}, 329 "AmexCardSecurityCodeVersion2":{ 330 "shape":"AmexCardSecurityCodeVersion2", 331 "documentation":"<p>Card data parameters that are required to verify a Card Security Code (CSC2) for an AMEX payment card.</p>" 332 }, 333 "CardHolderVerificationValue":{ 334 "shape":"CardHolderVerificationValue", 335 "documentation":"<p>Card data parameters that are required to verify a cardholder verification value for the payment card.</p>" 336 }, 337 "CardVerificationValue1":{ 338 "shape":"CardVerificationValue1", 339 "documentation":"<p>Card data parameters that are required to verify Card Verification Value (CVV) for the payment card.</p>" 340 }, 341 "CardVerificationValue2":{ 342 "shape":"CardVerificationValue2", 343 "documentation":"<p>Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.</p>" 344 }, 345 "DiscoverDynamicCardVerificationCode":{ 346 "shape":"DiscoverDynamicCardVerificationCode", 347 "documentation":"<p>Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.</p>" 348 }, 349 "DynamicCardVerificationCode":{ 350 "shape":"DynamicCardVerificationCode", 351 "documentation":"<p>Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.</p>" 352 }, 353 "DynamicCardVerificationValue":{ 354 "shape":"DynamicCardVerificationValue", 355 "documentation":"<p>Card data parameters that are required to verify CDynamic Card Verification Value (dCVV) for the payment card.</p>" 356 } 357 }, 358 "documentation":"<p>Card data parameters that are requried to verify Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).</p>", 359 "union":true 360 }, 361 "CardVerificationValue1":{ 362 "type":"structure", 363 "required":[ 364 "CardExpiryDate", 365 "ServiceCode" 366 ], 367 "members":{ 368 "CardExpiryDate":{ 369 "shape":"NumberLengthEquals4", 370 "documentation":"<p>The expiry date of a payment card.</p>" 371 }, 372 "ServiceCode":{ 373 "shape":"NumberLengthEquals3", 374 "documentation":"<p>The service code of the payment card. This is different from Card Security Code (CSC).</p>" 375 } 376 }, 377 "documentation":"<p>Card data parameters that are required to verify CVV (Card Verification Value) for the payment card.</p>" 378 }, 379 "CardVerificationValue2":{ 380 "type":"structure", 381 "required":["CardExpiryDate"], 382 "members":{ 383 "CardExpiryDate":{ 384 "shape":"NumberLengthEquals4", 385 "documentation":"<p>The expiry date of a payment card.</p>" 386 } 387 }, 388 "documentation":"<p>Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.</p>" 389 }, 390 "CryptogramAuthResponse":{ 391 "type":"structure", 392 "members":{ 393 "ArpcMethod1":{ 394 "shape":"CryptogramVerificationArpcMethod1", 395 "documentation":"<p>Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.</p>" 396 }, 397 "ArpcMethod2":{ 398 "shape":"CryptogramVerificationArpcMethod2", 399 "documentation":"<p>Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.</p>" 400 } 401 }, 402 "documentation":"<p>Parameters that are required for Authorization Response Cryptogram (ARPC) generation after Authorization Request Cryptogram (ARQC) verification is successful.</p>", 403 "union":true 404 }, 405 "CryptogramVerificationArpcMethod1":{ 406 "type":"structure", 407 "required":["AuthResponseCode"], 408 "members":{ 409 "AuthResponseCode":{ 410 "shape":"HexLengthEquals4", 411 "documentation":"<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>" 412 } 413 }, 414 "documentation":"<p>Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.</p>" 415 }, 416 "CryptogramVerificationArpcMethod2":{ 417 "type":"structure", 418 "required":["CardStatusUpdate"], 419 "members":{ 420 "CardStatusUpdate":{ 421 "shape":"HexLengthEquals8", 422 "documentation":"<p>The data indicating whether the issuer approves or declines an online transaction using an EMV chip card.</p>" 423 }, 424 "ProprietaryAuthenticationData":{ 425 "shape":"HexLengthBetween1And16", 426 "documentation":"<p>The proprietary authentication data used by issuer for communication during online transaction using an EMV chip card.</p>" 427 } 428 }, 429 "documentation":"<p>Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.</p>" 430 }, 431 "DecryptDataInput":{ 432 "type":"structure", 433 "required":[ 434 "CipherText", 435 "DecryptionAttributes", 436 "KeyIdentifier" 437 ], 438 "members":{ 439 "CipherText":{ 440 "shape":"HexEvenLengthBetween16And4096", 441 "documentation":"<p>The ciphertext to decrypt.</p>" 442 }, 443 "DecryptionAttributes":{ 444 "shape":"EncryptionDecryptionAttributes", 445 "documentation":"<p>The encryption key type and attributes for ciphertext decryption.</p>" 446 }, 447 "KeyIdentifier":{ 448 "shape":"KeyArnOrKeyAliasType", 449 "documentation":"<p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.</p>", 450 "location":"uri", 451 "locationName":"KeyIdentifier" 452 } 453 } 454 }, 455 "DecryptDataOutput":{ 456 "type":"structure", 457 "required":[ 458 "KeyArn", 459 "KeyCheckValue", 460 "PlainText" 461 ], 462 "members":{ 463 "KeyArn":{ 464 "shape":"KeyArn", 465 "documentation":"<p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.</p>" 466 }, 467 "KeyCheckValue":{ 468 "shape":"KeyCheckValue", 469 "documentation":"<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>" 470 }, 471 "PlainText":{ 472 "shape":"HexEvenLengthBetween16And4096", 473 "documentation":"<p>The decrypted plaintext data.</p>" 474 } 475 } 476 }, 477 "DiscoverDynamicCardVerificationCode":{ 478 "type":"structure", 479 "required":[ 480 "ApplicationTransactionCounter", 481 "CardExpiryDate", 482 "UnpredictableNumber" 483 ], 484 "members":{ 485 "ApplicationTransactionCounter":{ 486 "shape":"HexLengthBetween2And4", 487 "documentation":"<p>The transaction counter value that comes from the terminal.</p>" 488 }, 489 "CardExpiryDate":{ 490 "shape":"NumberLengthEquals4", 491 "documentation":"<p>The expiry date of a payment card.</p>" 492 }, 493 "UnpredictableNumber":{ 494 "shape":"HexLengthBetween2And8", 495 "documentation":"<p>A random number that is generated by the issuer.</p>" 496 } 497 }, 498 "documentation":"<p>Parameters that are required to generate or verify dCVC (Dynamic Card Verification Code).</p>" 499 }, 500 "DukptAttributes":{ 501 "type":"structure", 502 "required":[ 503 "DukptDerivationType", 504 "KeySerialNumber" 505 ], 506 "members":{ 507 "DukptDerivationType":{ 508 "shape":"DukptDerivationType", 509 "documentation":"<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>" 510 }, 511 "KeySerialNumber":{ 512 "shape":"HexLengthBetween10And24", 513 "documentation":"<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>" 514 } 515 }, 516 "documentation":"<p>Parameters that are used for Derived Unique Key Per Transaction (DUKPT) derivation algorithm.</p>" 517 }, 518 "DukptDerivationAttributes":{ 519 "type":"structure", 520 "required":["KeySerialNumber"], 521 "members":{ 522 "DukptKeyDerivationType":{ 523 "shape":"DukptDerivationType", 524 "documentation":"<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>" 525 }, 526 "DukptKeyVariant":{ 527 "shape":"DukptKeyVariant", 528 "documentation":"<p>The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.</p>" 529 }, 530 "KeySerialNumber":{ 531 "shape":"HexLengthBetween10And24", 532 "documentation":"<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>" 533 } 534 }, 535 "documentation":"<p>Parameters required for encryption or decryption of data using DUKPT.</p>" 536 }, 537 "DukptDerivationType":{ 538 "type":"string", 539 "enum":[ 540 "TDES_2KEY", 541 "TDES_3KEY", 542 "AES_128", 543 "AES_192", 544 "AES_256" 545 ] 546 }, 547 "DukptEncryptionAttributes":{ 548 "type":"structure", 549 "required":["KeySerialNumber"], 550 "members":{ 551 "DukptKeyDerivationType":{ 552 "shape":"DukptDerivationType", 553 "documentation":"<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> </p>" 554 }, 555 "DukptKeyVariant":{ 556 "shape":"DukptKeyVariant", 557 "documentation":"<p>The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.</p>" 558 }, 559 "InitializationVector":{ 560 "shape":"HexLength16Or32", 561 "documentation":"<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>" 562 }, 563 "KeySerialNumber":{ 564 "shape":"HexLengthBetween10And24", 565 "documentation":"<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>" 566 }, 567 "Mode":{ 568 "shape":"DukptEncryptionMode", 569 "documentation":"<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> <p>The default is CBC.</p>" 570 } 571 }, 572 "documentation":"<p>Parameters that are required to encrypt plaintext data using DUKPT.</p>" 573 }, 574 "DukptEncryptionMode":{ 575 "type":"string", 576 "enum":[ 577 "ECB", 578 "CBC" 579 ] 580 }, 581 "DukptKeyVariant":{ 582 "type":"string", 583 "enum":[ 584 "BIDIRECTIONAL", 585 "REQUEST", 586 "RESPONSE" 587 ] 588 }, 589 "DynamicCardVerificationCode":{ 590 "type":"structure", 591 "required":[ 592 "ApplicationTransactionCounter", 593 "PanSequenceNumber", 594 "TrackData", 595 "UnpredictableNumber" 596 ], 597 "members":{ 598 "ApplicationTransactionCounter":{ 599 "shape":"HexLengthBetween2And4", 600 "documentation":"<p>The transaction counter value that comes from the terminal.</p>" 601 }, 602 "PanSequenceNumber":{ 603 "shape":"HexLengthEquals2", 604 "documentation":"<p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>" 605 }, 606 "TrackData":{ 607 "shape":"HexLengthBetween2And160", 608 "documentation":"<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>" 609 }, 610 "UnpredictableNumber":{ 611 "shape":"HexLengthBetween2And8", 612 "documentation":"<p>A random number generated by the issuer.</p>" 613 } 614 }, 615 "documentation":"<p>Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).</p>" 616 }, 617 "DynamicCardVerificationValue":{ 618 "type":"structure", 619 "required":[ 620 "ApplicationTransactionCounter", 621 "CardExpiryDate", 622 "PanSequenceNumber", 623 "ServiceCode" 624 ], 625 "members":{ 626 "ApplicationTransactionCounter":{ 627 "shape":"HexLengthBetween2And4", 628 "documentation":"<p>The transaction counter value that comes from the terminal.</p>" 629 }, 630 "CardExpiryDate":{ 631 "shape":"NumberLengthEquals4", 632 "documentation":"<p>The expiry date of a payment card.</p>" 633 }, 634 "PanSequenceNumber":{ 635 "shape":"HexLengthEquals2", 636 "documentation":"<p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>" 637 }, 638 "ServiceCode":{ 639 "shape":"NumberLengthEquals3", 640 "documentation":"<p>The service code of the payment card. This is different from Card Security Code (CSC).</p>" 641 } 642 }, 643 "documentation":"<p>Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).</p>" 644 }, 645 "EncryptDataInput":{ 646 "type":"structure", 647 "required":[ 648 "EncryptionAttributes", 649 "KeyIdentifier", 650 "PlainText" 651 ], 652 "members":{ 653 "EncryptionAttributes":{ 654 "shape":"EncryptionDecryptionAttributes", 655 "documentation":"<p>The encryption key type and attributes for plaintext encryption.</p>" 656 }, 657 "KeyIdentifier":{ 658 "shape":"KeyArnOrKeyAliasType", 659 "documentation":"<p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.</p>", 660 "location":"uri", 661 "locationName":"KeyIdentifier" 662 }, 663 "PlainText":{ 664 "shape":"HexEvenLengthBetween16And4064", 665 "documentation":"<p>The plaintext to be encrypted.</p>" 666 } 667 } 668 }, 669 "EncryptDataOutput":{ 670 "type":"structure", 671 "required":[ 672 "CipherText", 673 "KeyArn" 674 ], 675 "members":{ 676 "CipherText":{ 677 "shape":"HexEvenLengthBetween16And4096", 678 "documentation":"<p>The encrypted ciphertext.</p>" 679 }, 680 "KeyArn":{ 681 "shape":"KeyArn", 682 "documentation":"<p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.</p>" 683 }, 684 "KeyCheckValue":{ 685 "shape":"KeyCheckValue", 686 "documentation":"<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>" 687 } 688 } 689 }, 690 "EncryptionDecryptionAttributes":{ 691 "type":"structure", 692 "members":{ 693 "Asymmetric":{"shape":"AsymmetricEncryptionAttributes"}, 694 "Dukpt":{"shape":"DukptEncryptionAttributes"}, 695 "Symmetric":{ 696 "shape":"SymmetricEncryptionAttributes", 697 "documentation":"<p>Parameters that are required to perform encryption and decryption using symmetric keys.</p>" 698 } 699 }, 700 "documentation":"<p>Parameters that are required to perform encryption and decryption operations.</p>", 701 "union":true 702 }, 703 "EncryptionMode":{ 704 "type":"string", 705 "enum":[ 706 "ECB", 707 "CBC", 708 "CFB", 709 "CFB1", 710 "CFB8", 711 "CFB64", 712 "CFB128", 713 "OFB" 714 ] 715 }, 716 "GenerateCardValidationDataInput":{ 717 "type":"structure", 718 "required":[ 719 "GenerationAttributes", 720 "KeyIdentifier", 721 "PrimaryAccountNumber" 722 ], 723 "members":{ 724 "GenerationAttributes":{ 725 "shape":"CardGenerationAttributes", 726 "documentation":"<p>The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.</p>" 727 }, 728 "KeyIdentifier":{ 729 "shape":"KeyArnOrKeyAliasType", 730 "documentation":"<p>The <code>keyARN</code> of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.</p>" 731 }, 732 "PrimaryAccountNumber":{ 733 "shape":"NumberLengthBetween12And19", 734 "documentation":"<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>" 735 }, 736 "ValidationDataLength":{ 737 "shape":"IntegerRangeBetween3And5Type", 738 "documentation":"<p>The length of the CVV or CSC to be generated. The default value is 3.</p>" 739 } 740 } 741 }, 742 "GenerateCardValidationDataOutput":{ 743 "type":"structure", 744 "required":[ 745 "KeyArn", 746 "KeyCheckValue", 747 "ValidationData" 748 ], 749 "members":{ 750 "KeyArn":{ 751 "shape":"KeyArn", 752 "documentation":"<p>The <code>keyARN</code> of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate CVV or CSC.</p>" 753 }, 754 "KeyCheckValue":{ 755 "shape":"KeyCheckValue", 756 "documentation":"<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>" 757 }, 758 "ValidationData":{ 759 "shape":"NumberLengthBetween3And5", 760 "documentation":"<p>The CVV or CSC value that Amazon Web Services Payment Cryptography generates for the card.</p>" 761 } 762 } 763 }, 764 "GenerateMacInput":{ 765 "type":"structure", 766 "required":[ 767 "GenerationAttributes", 768 "KeyIdentifier", 769 "MessageData" 770 ], 771 "members":{ 772 "GenerationAttributes":{ 773 "shape":"MacAttributes", 774 "documentation":"<p>The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.</p>" 775 }, 776 "KeyIdentifier":{ 777 "shape":"KeyArnOrKeyAliasType", 778 "documentation":"<p>The <code>keyARN</code> of the MAC generation encryption key.</p>" 779 }, 780 "MacLength":{ 781 "shape":"IntegerRangeBetween4And16", 782 "documentation":"<p>The length of a MAC under generation.</p>" 783 }, 784 "MessageData":{ 785 "shape":"HexEvenLengthBetween2And4096", 786 "documentation":"<p>The data for which a MAC is under generation.</p>" 787 } 788 } 789 }, 790 "GenerateMacOutput":{ 791 "type":"structure", 792 "required":[ 793 "KeyArn", 794 "KeyCheckValue", 795 "Mac" 796 ], 797 "members":{ 798 "KeyArn":{ 799 "shape":"KeyArn", 800 "documentation":"<p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.</p>" 801 }, 802 "KeyCheckValue":{ 803 "shape":"KeyCheckValue", 804 "documentation":"<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>" 805 }, 806 "Mac":{ 807 "shape":"HexLengthBetween4And128", 808 "documentation":"<p>The MAC cryptogram generated within Amazon Web Services Payment Cryptography.</p>" 809 } 810 } 811 }, 812 "GeneratePinDataInput":{ 813 "type":"structure", 814 "required":[ 815 "EncryptionKeyIdentifier", 816 "GenerationAttributes", 817 "GenerationKeyIdentifier", 818 "PinBlockFormat", 819 "PrimaryAccountNumber" 820 ], 821 "members":{ 822 "EncryptionKeyIdentifier":{ 823 "shape":"KeyArnOrKeyAliasType", 824 "documentation":"<p>The <code>keyARN</code> of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.</p>" 825 }, 826 "GenerationAttributes":{ 827 "shape":"PinGenerationAttributes", 828 "documentation":"<p>The attributes and values to use for PIN, PVV, or PIN Offset generation.</p>" 829 }, 830 "GenerationKeyIdentifier":{ 831 "shape":"KeyArnOrKeyAliasType", 832 "documentation":"<p>The <code>keyARN</code> of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.</p>" 833 }, 834 "PinBlockFormat":{ 835 "shape":"PinBlockFormatForPinData", 836 "documentation":"<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> <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> <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>" 837 }, 838 "PinDataLength":{ 839 "shape":"IntegerRangeBetween4And12", 840 "documentation":"<p>The length of PIN under generation.</p>", 841 "box":true 842 }, 843 "PrimaryAccountNumber":{ 844 "shape":"NumberLengthBetween12And19", 845 "documentation":"<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>" 846 } 847 } 848 }, 849 "GeneratePinDataOutput":{ 850 "type":"structure", 851 "required":[ 852 "EncryptedPinBlock", 853 "EncryptionKeyArn", 854 "EncryptionKeyCheckValue", 855 "GenerationKeyArn", 856 "GenerationKeyCheckValue", 857 "PinData" 858 ], 859 "members":{ 860 "EncryptedPinBlock":{ 861 "shape":"HexLengthBetween16And32", 862 "documentation":"<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>" 863 }, 864 "EncryptionKeyArn":{ 865 "shape":"KeyArn", 866 "documentation":"<p>The <code>keyARN</code> of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.</p>" 867 }, 868 "EncryptionKeyCheckValue":{ 869 "shape":"KeyCheckValue", 870 "documentation":"<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>" 871 }, 872 "GenerationKeyArn":{ 873 "shape":"KeyArn", 874 "documentation":"<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>" 875 }, 876 "GenerationKeyCheckValue":{ 877 "shape":"KeyCheckValue", 878 "documentation":"<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>" 879 }, 880 "PinData":{ 881 "shape":"PinData", 882 "documentation":"<p>The attributes and values Amazon Web Services Payment Cryptography uses for pin data generation.</p>" 883 } 884 } 885 }, 886 "HexEvenLengthBetween16And32":{ 887 "type":"string", 888 "max":32, 889 "min":16, 890 "pattern":"^(?:[0-9a-fA-F][0-9a-fA-F])+$", 891 "sensitive":true 892 }, 893 "HexEvenLengthBetween16And4064":{ 894 "type":"string", 895 "max":4064, 896 "min":16, 897 "pattern":"^(?:[0-9a-fA-F][0-9a-fA-F])+$", 898 "sensitive":true 899 }, 900 "HexEvenLengthBetween16And4096":{ 901 "type":"string", 902 "max":4096, 903 "min":16, 904 "pattern":"^(?:[0-9a-fA-F][0-9a-fA-F])+$", 905 "sensitive":true 906 }, 907 "HexEvenLengthBetween2And4096":{ 908 "type":"string", 909 "max":4096, 910 "min":2, 911 "pattern":"^(?:[0-9a-fA-F][0-9a-fA-F])+$", 912 "sensitive":true 913 }, 914 "HexEvenLengthBetween4And128":{ 915 "type":"string", 916 "max":128, 917 "min":4, 918 "pattern":"^(?:[0-9a-fA-F][0-9a-fA-F])+$", 919 "sensitive":true 920 }, 921 "HexLength16Or32":{ 922 "type":"string", 923 "max":32, 924 "min":16, 925 "pattern":"^(?:[0-9a-fA-F]{16}|[0-9a-fA-F]{32})$", 926 "sensitive":true 927 }, 928 "HexLengthBetween10And24":{ 929 "type":"string", 930 "max":24, 931 "min":10, 932 "pattern":"^[0-9a-fA-F]+$" 933 }, 934 "HexLengthBetween16And32":{ 935 "type":"string", 936 "max":32, 937 "min":16, 938 "pattern":"^[0-9a-fA-F]+$" 939 }, 940 "HexLengthBetween1And16":{ 941 "type":"string", 942 "max":16, 943 "min":1, 944 "pattern":"^[0-9a-fA-F]+$" 945 }, 946 "HexLengthBetween2And1024":{ 947 "type":"string", 948 "max":1024, 949 "min":2, 950 "pattern":"^[0-9a-fA-F]+$" 951 }, 952 "HexLengthBetween2And160":{ 953 "type":"string", 954 "max":160, 955 "min":2, 956 "pattern":"^[0-9a-fA-F]+$" 957 }, 958 "HexLengthBetween2And4":{ 959 "type":"string", 960 "max":4, 961 "min":2, 962 "pattern":"^[0-9a-fA-F]+$" 963 }, 964 "HexLengthBetween2And8":{ 965 "type":"string", 966 "max":8, 967 "min":2, 968 "pattern":"^[0-9a-fA-F]+$" 969 }, 970 "HexLengthBetween4And128":{ 971 "type":"string", 972 "max":128, 973 "min":4, 974 "pattern":"^[0-9a-fA-F]+$" 975 }, 976 "HexLengthEquals1":{ 977 "type":"string", 978 "max":1, 979 "min":1, 980 "pattern":"^[0-9A-F]+$" 981 }, 982 "HexLengthEquals16":{ 983 "type":"string", 984 "max":16, 985 "min":16, 986 "pattern":"^[0-9a-fA-F]+$" 987 }, 988 "HexLengthEquals2":{ 989 "type":"string", 990 "max":2, 991 "min":2, 992 "pattern":"^[0-9a-fA-F]+$" 993 }, 994 "HexLengthEquals4":{ 995 "type":"string", 996 "max":4, 997 "min":4, 998 "pattern":"^[0-9a-fA-F]+$" 999 }, 1000 "HexLengthEquals8":{ 1001 "type":"string", 1002 "max":8, 1003 "min":8, 1004 "pattern":"^[0-9a-fA-F]+$" 1005 }, 1006 "Ibm3624NaturalPin":{ 1007 "type":"structure", 1008 "required":[ 1009 "DecimalizationTable", 1010 "PinValidationData", 1011 "PinValidationDataPadCharacter" 1012 ], 1013 "members":{ 1014 "DecimalizationTable":{ 1015 "shape":"NumberLengthEquals16", 1016 "documentation":"<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>" 1017 }, 1018 "PinValidationData":{ 1019 "shape":"NumberLengthBetween4And16", 1020 "documentation":"<p>The unique data for cardholder identification.</p>" 1021 }, 1022 "PinValidationDataPadCharacter":{ 1023 "shape":"HexLengthEquals1", 1024 "documentation":"<p>The padding character for validation data.</p>" 1025 } 1026 }, 1027 "documentation":"<p>Parameters that are required to generate or verify Ibm3624 natural PIN.</p>" 1028 }, 1029 "Ibm3624PinFromOffset":{ 1030 "type":"structure", 1031 "required":[ 1032 "DecimalizationTable", 1033 "PinOffset", 1034 "PinValidationData", 1035 "PinValidationDataPadCharacter" 1036 ], 1037 "members":{ 1038 "DecimalizationTable":{ 1039 "shape":"NumberLengthEquals16", 1040 "documentation":"<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>" 1041 }, 1042 "PinOffset":{ 1043 "shape":"NumberLengthBetween4And12", 1044 "documentation":"<p>The PIN offset value.</p>" 1045 }, 1046 "PinValidationData":{ 1047 "shape":"NumberLengthBetween4And16", 1048 "documentation":"<p>The unique data for cardholder identification.</p>" 1049 }, 1050 "PinValidationDataPadCharacter":{ 1051 "shape":"HexLengthEquals1", 1052 "documentation":"<p>The padding character for validation data.</p>" 1053 } 1054 }, 1055 "documentation":"<p>Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.</p>" 1056 }, 1057 "Ibm3624PinOffset":{ 1058 "type":"structure", 1059 "required":[ 1060 "DecimalizationTable", 1061 "EncryptedPinBlock", 1062 "PinValidationData", 1063 "PinValidationDataPadCharacter" 1064 ], 1065 "members":{ 1066 "DecimalizationTable":{ 1067 "shape":"NumberLengthEquals16", 1068 "documentation":"<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>" 1069 }, 1070 "EncryptedPinBlock":{ 1071 "shape":"HexLengthBetween16And32", 1072 "documentation":"<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>" 1073 }, 1074 "PinValidationData":{ 1075 "shape":"NumberLengthBetween4And16", 1076 "documentation":"<p>The unique data for cardholder identification.</p>" 1077 }, 1078 "PinValidationDataPadCharacter":{ 1079 "shape":"HexLengthEquals1", 1080 "documentation":"<p>The padding character for validation data.</p>" 1081 } 1082 }, 1083 "documentation":"<p>Pparameters that are required to generate or verify Ibm3624 PIN offset PIN.</p>" 1084 }, 1085 "Ibm3624PinVerification":{ 1086 "type":"structure", 1087 "required":[ 1088 "DecimalizationTable", 1089 "PinOffset", 1090 "PinValidationData", 1091 "PinValidationDataPadCharacter" 1092 ], 1093 "members":{ 1094 "DecimalizationTable":{ 1095 "shape":"NumberLengthEquals16", 1096 "documentation":"<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>" 1097 }, 1098 "PinOffset":{ 1099 "shape":"NumberLengthBetween4And12", 1100 "documentation":"<p>The PIN offset value.</p>" 1101 }, 1102 "PinValidationData":{ 1103 "shape":"NumberLengthBetween4And16", 1104 "documentation":"<p>The unique data for cardholder identification.</p>" 1105 }, 1106 "PinValidationDataPadCharacter":{ 1107 "shape":"HexLengthEquals1", 1108 "documentation":"<p>The padding character for validation data.</p>" 1109 } 1110 }, 1111 "documentation":"<p>Parameters that are required to generate or verify Ibm3624 PIN verification PIN.</p>" 1112 }, 1113 "Ibm3624RandomPin":{ 1114 "type":"structure", 1115 "required":[ 1116 "DecimalizationTable", 1117 "PinValidationData", 1118 "PinValidationDataPadCharacter" 1119 ], 1120 "members":{ 1121 "DecimalizationTable":{ 1122 "shape":"NumberLengthEquals16", 1123 "documentation":"<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>" 1124 }, 1125 "PinValidationData":{ 1126 "shape":"NumberLengthBetween4And16", 1127 "documentation":"<p>The unique data for cardholder identification.</p>" 1128 }, 1129 "PinValidationDataPadCharacter":{ 1130 "shape":"HexLengthEquals1", 1131 "documentation":"<p>The padding character for validation data.</p>" 1132 } 1133 }, 1134 "documentation":"<p>Parameters that are required to generate or verify Ibm3624 random PIN.</p>" 1135 }, 1136 "IntegerRangeBetween0And9":{ 1137 "type":"integer", 1138 "box":true, 1139 "max":9, 1140 "min":0 1141 }, 1142 "IntegerRangeBetween3And5Type":{ 1143 "type":"integer", 1144 "box":true, 1145 "max":5, 1146 "min":3 1147 }, 1148 "IntegerRangeBetween4And12":{ 1149 "type":"integer", 1150 "max":12, 1151 "min":4 1152 }, 1153 "IntegerRangeBetween4And16":{ 1154 "type":"integer", 1155 "box":true, 1156 "max":16, 1157 "min":4 1158 }, 1159 "InternalServerException":{ 1160 "type":"structure", 1161 "members":{ 1162 "Message":{"shape":"String"} 1163 }, 1164 "documentation":"<p>The request processing has failed because of an unknown error, exception, or failure.</p>", 1165 "error":{"httpStatusCode":500}, 1166 "exception":true, 1167 "fault":true 1168 }, 1169 "KeyArn":{ 1170 "type":"string", 1171 "max":150, 1172 "min":70, 1173 "pattern":"^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}$" 1174 }, 1175 "KeyArnOrKeyAliasType":{ 1176 "type":"string", 1177 "max":322, 1178 "min":7, 1179 "pattern":"^arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+$" 1180 }, 1181 "KeyCheckValue":{ 1182 "type":"string", 1183 "max":16, 1184 "min":4, 1185 "pattern":"^[0-9a-fA-F]+$" 1186 }, 1187 "MacAlgorithm":{ 1188 "type":"string", 1189 "enum":[ 1190 "ISO9797_ALGORITHM1", 1191 "ISO9797_ALGORITHM3", 1192 "CMAC", 1193 "HMAC_SHA224", 1194 "HMAC_SHA256", 1195 "HMAC_SHA384", 1196 "HMAC_SHA512" 1197 ] 1198 }, 1199 "MacAlgorithmDukpt":{ 1200 "type":"structure", 1201 "required":[ 1202 "DukptKeyVariant", 1203 "KeySerialNumber" 1204 ], 1205 "members":{ 1206 "DukptDerivationType":{ 1207 "shape":"DukptDerivationType", 1208 "documentation":"<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>" 1209 }, 1210 "DukptKeyVariant":{ 1211 "shape":"DukptKeyVariant", 1212 "documentation":"<p>The type of use of DUKPT, which can be MAC generation, MAC verification, or both.</p>" 1213 }, 1214 "KeySerialNumber":{ 1215 "shape":"HexLengthBetween10And24", 1216 "documentation":"<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>" 1217 } 1218 }, 1219 "documentation":"<p>Parameters required for DUKPT MAC generation and verification.</p>" 1220 }, 1221 "MacAlgorithmEmv":{ 1222 "type":"structure", 1223 "required":[ 1224 "MajorKeyDerivationMode", 1225 "PanSequenceNumber", 1226 "PrimaryAccountNumber", 1227 "SessionKeyDerivationMode", 1228 "SessionKeyDerivationValue" 1229 ], 1230 "members":{ 1231 "MajorKeyDerivationMode":{ 1232 "shape":"MajorKeyDerivationMode", 1233 "documentation":"<p>The method to use when deriving the master key for EMV MAC generation or verification.</p>" 1234 }, 1235 "PanSequenceNumber":{ 1236 "shape":"HexLengthEquals2", 1237 "documentation":"<p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>" 1238 }, 1239 "PrimaryAccountNumber":{ 1240 "shape":"NumberLengthBetween12And19", 1241 "documentation":"<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>" 1242 }, 1243 "SessionKeyDerivationMode":{ 1244 "shape":"SessionKeyDerivationMode", 1245 "documentation":"<p>The method of deriving a session key for EMV MAC generation or verification.</p>" 1246 }, 1247 "SessionKeyDerivationValue":{ 1248 "shape":"SessionKeyDerivationValue", 1249 "documentation":"<p>Parameters that are required to generate session key for EMV generation and verification.</p>" 1250 } 1251 }, 1252 "documentation":"<p>Parameters that are required for EMV MAC generation and verification.</p>" 1253 }, 1254 "MacAttributes":{ 1255 "type":"structure", 1256 "members":{ 1257 "Algorithm":{ 1258 "shape":"MacAlgorithm", 1259 "documentation":"<p>The encryption algorithm for MAC generation or verification.</p>" 1260 }, 1261 "DukptCmac":{ 1262 "shape":"MacAlgorithmDukpt", 1263 "documentation":"<p>Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.</p>" 1264 }, 1265 "DukptIso9797Algorithm1":{ 1266 "shape":"MacAlgorithmDukpt", 1267 "documentation":"<p>Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.</p>" 1268 }, 1269 "DukptIso9797Algorithm3":{ 1270 "shape":"MacAlgorithmDukpt", 1271 "documentation":"<p>Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.</p>" 1272 }, 1273 "EmvMac":{ 1274 "shape":"MacAlgorithmEmv", 1275 "documentation":"<p>Parameters that are required for MAC generation or verification using EMV MAC algorithm.</p>" 1276 } 1277 }, 1278 "documentation":"<p>Parameters that are required for DUKPT, HMAC, or EMV MAC generation or verification.</p>", 1279 "union":true 1280 }, 1281 "MajorKeyDerivationMode":{ 1282 "type":"string", 1283 "enum":[ 1284 "EMV_OPTION_A", 1285 "EMV_OPTION_B" 1286 ] 1287 }, 1288 "NumberLengthBetween12And19":{ 1289 "type":"string", 1290 "max":19, 1291 "min":12, 1292 "pattern":"^[0-9]+$", 1293 "sensitive":true 1294 }, 1295 "NumberLengthBetween3And5":{ 1296 "type":"string", 1297 "max":5, 1298 "min":3, 1299 "pattern":"^[0-9]+$" 1300 }, 1301 "NumberLengthBetween4And12":{ 1302 "type":"string", 1303 "max":12, 1304 "min":4, 1305 "pattern":"^[0-9]+$" 1306 }, 1307 "NumberLengthBetween4And16":{ 1308 "type":"string", 1309 "max":16, 1310 "min":4, 1311 "pattern":"^[0-9]+$" 1312 }, 1313 "NumberLengthEquals16":{ 1314 "type":"string", 1315 "max":16, 1316 "min":16, 1317 "pattern":"^[0-9]+$" 1318 }, 1319 "NumberLengthEquals3":{ 1320 "type":"string", 1321 "max":3, 1322 "min":3, 1323 "pattern":"^[0-9]+$" 1324 }, 1325 "NumberLengthEquals4":{ 1326 "type":"string", 1327 "max":4, 1328 "min":4, 1329 "pattern":"^[0-9]+$" 1330 }, 1331 "PaddingType":{ 1332 "type":"string", 1333 "enum":[ 1334 "PKCS1", 1335 "OAEP_SHA1", 1336 "OAEP_SHA256", 1337 "OAEP_SHA512" 1338 ] 1339 }, 1340 "PinBlockFormatForPinData":{ 1341 "type":"string", 1342 "enum":[ 1343 "ISO_FORMAT_0", 1344 "ISO_FORMAT_3" 1345 ] 1346 }, 1347 "PinData":{ 1348 "type":"structure", 1349 "members":{ 1350 "PinOffset":{ 1351 "shape":"NumberLengthBetween4And12", 1352 "documentation":"<p>The PIN offset value.</p>" 1353 }, 1354 "VerificationValue":{ 1355 "shape":"NumberLengthBetween4And12", 1356 "documentation":"<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>" 1357 } 1358 }, 1359 "documentation":"<p>Parameters that are required to generate, translate, or verify PIN data.</p>", 1360 "union":true 1361 }, 1362 "PinGenerationAttributes":{ 1363 "type":"structure", 1364 "members":{ 1365 "Ibm3624NaturalPin":{ 1366 "shape":"Ibm3624NaturalPin", 1367 "documentation":"<p>Parameters that are required to generate or verify Ibm3624 natural PIN.</p>" 1368 }, 1369 "Ibm3624PinFromOffset":{ 1370 "shape":"Ibm3624PinFromOffset", 1371 "documentation":"<p>Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.</p>" 1372 }, 1373 "Ibm3624PinOffset":{ 1374 "shape":"Ibm3624PinOffset", 1375 "documentation":"<p>Parameters that are required to generate or verify Ibm3624 PIN offset PIN.</p>" 1376 }, 1377 "Ibm3624RandomPin":{ 1378 "shape":"Ibm3624RandomPin", 1379 "documentation":"<p>Parameters that are required to generate or verify Ibm3624 random PIN.</p>" 1380 }, 1381 "VisaPin":{ 1382 "shape":"VisaPin", 1383 "documentation":"<p>Parameters that are required to generate or verify Visa PIN.</p>" 1384 }, 1385 "VisaPinVerificationValue":{ 1386 "shape":"VisaPinVerificationValue", 1387 "documentation":"<p>Parameters that are required to generate or verify Visa PIN Verification Value (PVV).</p>" 1388 } 1389 }, 1390 "documentation":"<p>Parameters that are required for PIN data generation.</p>", 1391 "union":true 1392 }, 1393 "PinVerificationAttributes":{ 1394 "type":"structure", 1395 "members":{ 1396 "Ibm3624Pin":{ 1397 "shape":"Ibm3624PinVerification", 1398 "documentation":"<p>Parameters that are required to generate or verify Ibm3624 PIN.</p>" 1399 }, 1400 "VisaPin":{ 1401 "shape":"VisaPinVerification", 1402 "documentation":"<p>Parameters that are required to generate or verify Visa PIN.</p>" 1403 } 1404 }, 1405 "documentation":"<p>Parameters that are required for PIN data verification.</p>", 1406 "union":true 1407 }, 1408 "ReEncryptDataInput":{ 1409 "type":"structure", 1410 "required":[ 1411 "CipherText", 1412 "IncomingEncryptionAttributes", 1413 "IncomingKeyIdentifier", 1414 "OutgoingEncryptionAttributes", 1415 "OutgoingKeyIdentifier" 1416 ], 1417 "members":{ 1418 "CipherText":{ 1419 "shape":"HexEvenLengthBetween16And4096", 1420 "documentation":"<p>Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.</p>" 1421 }, 1422 "IncomingEncryptionAttributes":{ 1423 "shape":"ReEncryptionAttributes", 1424 "documentation":"<p>The attributes and values for incoming ciphertext.</p>" 1425 }, 1426 "IncomingKeyIdentifier":{ 1427 "shape":"KeyArnOrKeyAliasType", 1428 "documentation":"<p>The <code>keyARN</code> of the encryption key of incoming ciphertext data.</p>", 1429 "location":"uri", 1430 "locationName":"IncomingKeyIdentifier" 1431 }, 1432 "OutgoingEncryptionAttributes":{ 1433 "shape":"ReEncryptionAttributes", 1434 "documentation":"<p>The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.</p>" 1435 }, 1436 "OutgoingKeyIdentifier":{ 1437 "shape":"KeyArnOrKeyAliasType", 1438 "documentation":"<p>The <code>keyARN</code> of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.</p>" 1439 } 1440 } 1441 }, 1442 "ReEncryptDataOutput":{ 1443 "type":"structure", 1444 "required":[ 1445 "CipherText", 1446 "KeyArn", 1447 "KeyCheckValue" 1448 ], 1449 "members":{ 1450 "CipherText":{ 1451 "shape":"HexEvenLengthBetween16And4096", 1452 "documentation":"<p>The encrypted ciphertext.</p>" 1453 }, 1454 "KeyArn":{ 1455 "shape":"KeyArn", 1456 "documentation":"<p>The keyARN (Amazon Resource Name) of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.</p>" 1457 }, 1458 "KeyCheckValue":{ 1459 "shape":"KeyCheckValue", 1460 "documentation":"<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>" 1461 } 1462 } 1463 }, 1464 "ReEncryptionAttributes":{ 1465 "type":"structure", 1466 "members":{ 1467 "Dukpt":{"shape":"DukptEncryptionAttributes"}, 1468 "Symmetric":{ 1469 "shape":"SymmetricEncryptionAttributes", 1470 "documentation":"<p>Parameters that are required to encrypt data using symmetric keys.</p>" 1471 } 1472 }, 1473 "documentation":"<p>Parameters that are required to perform reencryption operation.</p>", 1474 "union":true 1475 }, 1476 "ResourceNotFoundException":{ 1477 "type":"structure", 1478 "members":{ 1479 "ResourceId":{ 1480 "shape":"String", 1481 "documentation":"<p>The resource that is missing.</p>" 1482 } 1483 }, 1484 "documentation":"<p>The request was denied due to an invalid resource error.</p>", 1485 "error":{ 1486 "httpStatusCode":404, 1487 "senderFault":true 1488 }, 1489 "exception":true 1490 }, 1491 "SessionKeyAmex":{ 1492 "type":"structure", 1493 "required":[ 1494 "PanSequenceNumber", 1495 "PrimaryAccountNumber" 1496 ], 1497 "members":{ 1498 "PanSequenceNumber":{ 1499 "shape":"HexLengthEquals2", 1500 "documentation":"<p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>" 1501 }, 1502 "PrimaryAccountNumber":{ 1503 "shape":"NumberLengthBetween12And19", 1504 "documentation":"<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>" 1505 } 1506 }, 1507 "documentation":"<p>Parameters to derive session key for an Amex payment card.</p>" 1508 }, 1509 "SessionKeyDerivation":{ 1510 "type":"structure", 1511 "members":{ 1512 "Amex":{ 1513 "shape":"SessionKeyAmex", 1514 "documentation":"<p>Parameters to derive session key for an Amex payment card for ARQC verification.</p>" 1515 }, 1516 "Emv2000":{ 1517 "shape":"SessionKeyEmv2000", 1518 "documentation":"<p>Parameters to derive session key for an Emv2000 payment card for ARQC verification.</p>" 1519 }, 1520 "EmvCommon":{ 1521 "shape":"SessionKeyEmvCommon", 1522 "documentation":"<p>Parameters to derive session key for an Emv common payment card for ARQC verification.</p>" 1523 }, 1524 "Mastercard":{ 1525 "shape":"SessionKeyMastercard", 1526 "documentation":"<p>Parameters to derive session key for a Mastercard payment card for ARQC verification.</p>" 1527 }, 1528 "Visa":{ 1529 "shape":"SessionKeyVisa", 1530 "documentation":"<p>Parameters to derive session key for a Visa payment cardfor ARQC verification.</p>" 1531 } 1532 }, 1533 "documentation":"<p>Parameters to derive a session key for Authorization Response Cryptogram (ARQC) verification.</p>", 1534 "union":true 1535 }, 1536 "SessionKeyDerivationMode":{ 1537 "type":"string", 1538 "enum":[ 1539 "EMV_COMMON_SESSION_KEY", 1540 "EMV2000", 1541 "AMEX", 1542 "MASTERCARD_SESSION_KEY", 1543 "VISA" 1544 ] 1545 }, 1546 "SessionKeyDerivationValue":{ 1547 "type":"structure", 1548 "members":{ 1549 "ApplicationCryptogram":{ 1550 "shape":"HexLengthEquals16", 1551 "documentation":"<p>The cryptogram provided by the terminal during transaction processing.</p>" 1552 }, 1553 "ApplicationTransactionCounter":{ 1554 "shape":"HexLengthBetween2And4", 1555 "documentation":"<p>The transaction counter that is provided by the terminal during transaction processing.</p>" 1556 } 1557 }, 1558 "documentation":"<p>Parameters to derive session key value using a MAC EMV algorithm.</p>", 1559 "union":true 1560 }, 1561 "SessionKeyEmv2000":{ 1562 "type":"structure", 1563 "required":[ 1564 "ApplicationTransactionCounter", 1565 "PanSequenceNumber", 1566 "PrimaryAccountNumber" 1567 ], 1568 "members":{ 1569 "ApplicationTransactionCounter":{ 1570 "shape":"HexLengthBetween2And4", 1571 "documentation":"<p>The transaction counter that is provided by the terminal during transaction processing.</p>" 1572 }, 1573 "PanSequenceNumber":{ 1574 "shape":"HexLengthEquals2", 1575 "documentation":"<p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>" 1576 }, 1577 "PrimaryAccountNumber":{ 1578 "shape":"NumberLengthBetween12And19", 1579 "documentation":"<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>" 1580 } 1581 }, 1582 "documentation":"<p>Parameters to derive session key for an Emv2000 payment card for ARQC verification.</p>" 1583 }, 1584 "SessionKeyEmvCommon":{ 1585 "type":"structure", 1586 "required":[ 1587 "ApplicationTransactionCounter", 1588 "PanSequenceNumber", 1589 "PrimaryAccountNumber" 1590 ], 1591 "members":{ 1592 "ApplicationTransactionCounter":{ 1593 "shape":"HexLengthBetween2And4", 1594 "documentation":"<p>The transaction counter that is provided by the terminal during transaction processing.</p>" 1595 }, 1596 "PanSequenceNumber":{ 1597 "shape":"HexLengthEquals2", 1598 "documentation":"<p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>" 1599 }, 1600 "PrimaryAccountNumber":{ 1601 "shape":"NumberLengthBetween12And19", 1602 "documentation":"<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>" 1603 } 1604 }, 1605 "documentation":"<p>Parameters to derive session key for an Emv common payment card for ARQC verification.</p>" 1606 }, 1607 "SessionKeyMastercard":{ 1608 "type":"structure", 1609 "required":[ 1610 "ApplicationTransactionCounter", 1611 "PanSequenceNumber", 1612 "PrimaryAccountNumber", 1613 "UnpredictableNumber" 1614 ], 1615 "members":{ 1616 "ApplicationTransactionCounter":{ 1617 "shape":"HexLengthBetween2And4", 1618 "documentation":"<p>The transaction counter that is provided by the terminal during transaction processing.</p>" 1619 }, 1620 "PanSequenceNumber":{ 1621 "shape":"HexLengthEquals2", 1622 "documentation":"<p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>" 1623 }, 1624 "PrimaryAccountNumber":{ 1625 "shape":"NumberLengthBetween12And19", 1626 "documentation":"<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>" 1627 }, 1628 "UnpredictableNumber":{ 1629 "shape":"HexLengthBetween2And8", 1630 "documentation":"<p>A random number generated by the issuer.</p>" 1631 } 1632 }, 1633 "documentation":"<p>Parameters to derive session key for Mastercard payment card for ARQC verification.</p>" 1634 }, 1635 "SessionKeyVisa":{ 1636 "type":"structure", 1637 "required":[ 1638 "PanSequenceNumber", 1639 "PrimaryAccountNumber" 1640 ], 1641 "members":{ 1642 "PanSequenceNumber":{ 1643 "shape":"HexLengthEquals2", 1644 "documentation":"<p>A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).</p>" 1645 }, 1646 "PrimaryAccountNumber":{ 1647 "shape":"NumberLengthBetween12And19", 1648 "documentation":"<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>" 1649 } 1650 }, 1651 "documentation":"<p>Parameters to derive session key for Visa payment card for ARQC verification.</p>" 1652 }, 1653 "String":{"type":"string"}, 1654 "SymmetricEncryptionAttributes":{ 1655 "type":"structure", 1656 "required":["Mode"], 1657 "members":{ 1658 "InitializationVector":{ 1659 "shape":"HexLength16Or32", 1660 "documentation":"<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>" 1661 }, 1662 "Mode":{ 1663 "shape":"EncryptionMode", 1664 "documentation":"<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>" 1665 }, 1666 "PaddingType":{ 1667 "shape":"PaddingType", 1668 "documentation":"<p>The padding to be included with the data.</p>" 1669 } 1670 }, 1671 "documentation":"<p>Parameters requried to encrypt plaintext data using symmetric keys.</p>" 1672 }, 1673 "ThrottlingException":{ 1674 "type":"structure", 1675 "members":{ 1676 "Message":{"shape":"String"} 1677 }, 1678 "documentation":"<p>The request was denied due to request throttling.</p>", 1679 "error":{ 1680 "httpStatusCode":429, 1681 "senderFault":true 1682 }, 1683 "exception":true 1684 }, 1685 "TranslatePinDataInput":{ 1686 "type":"structure", 1687 "required":[ 1688 "EncryptedPinBlock", 1689 "IncomingKeyIdentifier", 1690 "IncomingTranslationAttributes", 1691 "OutgoingKeyIdentifier", 1692 "OutgoingTranslationAttributes" 1693 ], 1694 "members":{ 1695 "EncryptedPinBlock":{ 1696 "shape":"HexEvenLengthBetween16And32", 1697 "documentation":"<p>The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.</p>" 1698 }, 1699 "IncomingDukptAttributes":{ 1700 "shape":"DukptDerivationAttributes", 1701 "documentation":"<p>The attributes and values to use for incoming DUKPT encryption key for PIN block tranlation.</p>" 1702 }, 1703 "IncomingKeyIdentifier":{ 1704 "shape":"KeyArnOrKeyAliasType", 1705 "documentation":"<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>" 1706 }, 1707 "IncomingTranslationAttributes":{ 1708 "shape":"TranslationIsoFormats", 1709 "documentation":"<p>The format of the incoming PIN block data for tranlation within Amazon Web Services Payment Cryptography.</p>" 1710 }, 1711 "OutgoingDukptAttributes":{ 1712 "shape":"DukptDerivationAttributes", 1713 "documentation":"<p>The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.</p>" 1714 }, 1715 "OutgoingKeyIdentifier":{ 1716 "shape":"KeyArnOrKeyAliasType", 1717 "documentation":"<p>The <code>keyARN</code> of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.</p>" 1718 }, 1719 "OutgoingTranslationAttributes":{ 1720 "shape":"TranslationIsoFormats", 1721 "documentation":"<p>The format of the outgoing PIN block data after tranlation by Amazon Web Services Payment Cryptography.</p>" 1722 } 1723 } 1724 }, 1725 "TranslatePinDataOutput":{ 1726 "type":"structure", 1727 "required":[ 1728 "KeyArn", 1729 "KeyCheckValue", 1730 "PinBlock" 1731 ], 1732 "members":{ 1733 "KeyArn":{ 1734 "shape":"KeyArn", 1735 "documentation":"<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>" 1736 }, 1737 "KeyCheckValue":{ 1738 "shape":"KeyCheckValue", 1739 "documentation":"<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>" 1740 }, 1741 "PinBlock":{ 1742 "shape":"HexLengthBetween16And32", 1743 "documentation":"<p>The ougoing encrypted PIN block data after tranlation.</p>" 1744 } 1745 } 1746 }, 1747 "TranslationIsoFormats":{ 1748 "type":"structure", 1749 "members":{ 1750 "IsoFormat0":{ 1751 "shape":"TranslationPinDataIsoFormat034", 1752 "documentation":"<p>Parameters that are required for ISO9564 PIN format 0 tranlation.</p>" 1753 }, 1754 "IsoFormat1":{ 1755 "shape":"TranslationPinDataIsoFormat1", 1756 "documentation":"<p>Parameters that are required for ISO9564 PIN format 1 tranlation.</p>" 1757 }, 1758 "IsoFormat3":{ 1759 "shape":"TranslationPinDataIsoFormat034", 1760 "documentation":"<p>Parameters that are required for ISO9564 PIN format 3 tranlation.</p>" 1761 }, 1762 "IsoFormat4":{ 1763 "shape":"TranslationPinDataIsoFormat034", 1764 "documentation":"<p>Parameters that are required for ISO9564 PIN format 4 tranlation.</p>" 1765 } 1766 }, 1767 "documentation":"<p>Parameters that are required for translation between ISO9564 PIN block formats 0,1,3,4.</p>", 1768 "union":true 1769 }, 1770 "TranslationPinDataIsoFormat034":{ 1771 "type":"structure", 1772 "required":["PrimaryAccountNumber"], 1773 "members":{ 1774 "PrimaryAccountNumber":{ 1775 "shape":"NumberLengthBetween12And19", 1776 "documentation":"<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>" 1777 } 1778 }, 1779 "documentation":"<p>Parameters that are required for tranlation between ISO9564 PIN format 0,3,4 tranlation.</p>" 1780 }, 1781 "TranslationPinDataIsoFormat1":{ 1782 "type":"structure", 1783 "members":{ 1784 }, 1785 "documentation":"<p>Parameters that are required for ISO9564 PIN format 1 tranlation.</p>" 1786 }, 1787 "ValidationException":{ 1788 "type":"structure", 1789 "required":["message"], 1790 "members":{ 1791 "fieldList":{ 1792 "shape":"ValidationExceptionFieldList", 1793 "documentation":"<p>The request was denied due to an invalid request error.</p>" 1794 }, 1795 "message":{"shape":"String"} 1796 }, 1797 "documentation":"<p>The request was denied due to an invalid request error.</p>", 1798 "exception":true 1799 }, 1800 "ValidationExceptionField":{ 1801 "type":"structure", 1802 "required":[ 1803 "message", 1804 "path" 1805 ], 1806 "members":{ 1807 "message":{ 1808 "shape":"String", 1809 "documentation":"<p>The request was denied due to an invalid request error.</p>" 1810 }, 1811 "path":{ 1812 "shape":"String", 1813 "documentation":"<p>The request was denied due to an invalid request error.</p>" 1814 } 1815 }, 1816 "documentation":"<p>The request was denied due to an invalid request error.</p>" 1817 }, 1818 "ValidationExceptionFieldList":{ 1819 "type":"list", 1820 "member":{"shape":"ValidationExceptionField"} 1821 }, 1822 "VerificationFailedException":{ 1823 "type":"structure", 1824 "required":[ 1825 "Message", 1826 "Reason" 1827 ], 1828 "members":{ 1829 "Message":{"shape":"String"}, 1830 "Reason":{ 1831 "shape":"VerificationFailedReason", 1832 "documentation":"<p>The reason for the exception.</p>" 1833 } 1834 }, 1835 "documentation":"<p>This request failed verification.</p>", 1836 "error":{ 1837 "httpStatusCode":400, 1838 "senderFault":true 1839 }, 1840 "exception":true 1841 }, 1842 "VerificationFailedReason":{ 1843 "type":"string", 1844 "enum":[ 1845 "INVALID_MAC", 1846 "INVALID_PIN", 1847 "INVALID_VALIDATION_DATA", 1848 "INVALID_AUTH_REQUEST_CRYPTOGRAM" 1849 ] 1850 }, 1851 "VerifyAuthRequestCryptogramInput":{ 1852 "type":"structure", 1853 "required":[ 1854 "AuthRequestCryptogram", 1855 "KeyIdentifier", 1856 "MajorKeyDerivationMode", 1857 "SessionKeyDerivationAttributes", 1858 "TransactionData" 1859 ], 1860 "members":{ 1861 "AuthRequestCryptogram":{ 1862 "shape":"HexLengthEquals16", 1863 "documentation":"<p>The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.</p>" 1864 }, 1865 "AuthResponseAttributes":{ 1866 "shape":"CryptogramAuthResponse", 1867 "documentation":"<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>" 1868 }, 1869 "KeyIdentifier":{ 1870 "shape":"KeyArnOrKeyAliasType", 1871 "documentation":"<p>The <code>keyARN</code> of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.</p>" 1872 }, 1873 "MajorKeyDerivationMode":{ 1874 "shape":"MajorKeyDerivationMode", 1875 "documentation":"<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>" 1876 }, 1877 "SessionKeyDerivationAttributes":{ 1878 "shape":"SessionKeyDerivation", 1879 "documentation":"<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>" 1880 }, 1881 "TransactionData":{ 1882 "shape":"HexLengthBetween2And1024", 1883 "documentation":"<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>" 1884 } 1885 } 1886 }, 1887 "VerifyAuthRequestCryptogramOutput":{ 1888 "type":"structure", 1889 "required":[ 1890 "KeyArn", 1891 "KeyCheckValue" 1892 ], 1893 "members":{ 1894 "AuthResponseValue":{ 1895 "shape":"HexLengthBetween1And16", 1896 "documentation":"<p>The result for ARQC verification or ARPC generation within Amazon Web Services Payment Cryptography.</p>" 1897 }, 1898 "KeyArn":{ 1899 "shape":"KeyArn", 1900 "documentation":"<p>The <code>keyARN</code> of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.</p>" 1901 }, 1902 "KeyCheckValue":{ 1903 "shape":"KeyCheckValue", 1904 "documentation":"<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>" 1905 } 1906 } 1907 }, 1908 "VerifyCardValidationDataInput":{ 1909 "type":"structure", 1910 "required":[ 1911 "KeyIdentifier", 1912 "PrimaryAccountNumber", 1913 "ValidationData", 1914 "VerificationAttributes" 1915 ], 1916 "members":{ 1917 "KeyIdentifier":{ 1918 "shape":"KeyArnOrKeyAliasType", 1919 "documentation":"<p>The <code>keyARN</code> of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify card data.</p>" 1920 }, 1921 "PrimaryAccountNumber":{ 1922 "shape":"NumberLengthBetween12And19", 1923 "documentation":"<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>" 1924 }, 1925 "ValidationData":{ 1926 "shape":"NumberLengthBetween3And5", 1927 "documentation":"<p>The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.</p>" 1928 }, 1929 "VerificationAttributes":{ 1930 "shape":"CardVerificationAttributes", 1931 "documentation":"<p>The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography.</p>" 1932 } 1933 } 1934 }, 1935 "VerifyCardValidationDataOutput":{ 1936 "type":"structure", 1937 "required":[ 1938 "KeyArn", 1939 "KeyCheckValue" 1940 ], 1941 "members":{ 1942 "KeyArn":{ 1943 "shape":"KeyArn", 1944 "documentation":"<p>The <code>keyARN</code> of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify CVV or CSC.</p>" 1945 }, 1946 "KeyCheckValue":{ 1947 "shape":"KeyCheckValue", 1948 "documentation":"<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>" 1949 } 1950 } 1951 }, 1952 "VerifyMacInput":{ 1953 "type":"structure", 1954 "required":[ 1955 "KeyIdentifier", 1956 "Mac", 1957 "MessageData", 1958 "VerificationAttributes" 1959 ], 1960 "members":{ 1961 "KeyIdentifier":{ 1962 "shape":"KeyArnOrKeyAliasType", 1963 "documentation":"<p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.</p>" 1964 }, 1965 "Mac":{ 1966 "shape":"HexEvenLengthBetween4And128", 1967 "documentation":"<p>The MAC being verified.</p>" 1968 }, 1969 "MacLength":{ 1970 "shape":"IntegerRangeBetween4And16", 1971 "documentation":"<p>The length of the MAC.</p>" 1972 }, 1973 "MessageData":{ 1974 "shape":"HexEvenLengthBetween2And4096", 1975 "documentation":"<p>The data on for which MAC is under verification.</p>" 1976 }, 1977 "VerificationAttributes":{ 1978 "shape":"MacAttributes", 1979 "documentation":"<p>The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.</p>" 1980 } 1981 } 1982 }, 1983 "VerifyMacOutput":{ 1984 "type":"structure", 1985 "required":[ 1986 "KeyArn", 1987 "KeyCheckValue" 1988 ], 1989 "members":{ 1990 "KeyArn":{ 1991 "shape":"KeyArn", 1992 "documentation":"<p>The <code>keyARN</code> of the encryption key that Amazon Web Services Payment Cryptography uses for MAC verification.</p>" 1993 }, 1994 "KeyCheckValue":{ 1995 "shape":"KeyCheckValue", 1996 "documentation":"<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>" 1997 } 1998 } 1999 }, 2000 "VerifyPinDataInput":{ 2001 "type":"structure", 2002 "required":[ 2003 "EncryptedPinBlock", 2004 "EncryptionKeyIdentifier", 2005 "PinBlockFormat", 2006 "PrimaryAccountNumber", 2007 "VerificationAttributes", 2008 "VerificationKeyIdentifier" 2009 ], 2010 "members":{ 2011 "DukptAttributes":{ 2012 "shape":"DukptAttributes", 2013 "documentation":"<p>The attributes and values for the DUKPT encrypted PIN block data.</p>" 2014 }, 2015 "EncryptedPinBlock":{ 2016 "shape":"HexLengthBetween16And32", 2017 "documentation":"<p>The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.</p>" 2018 }, 2019 "EncryptionKeyIdentifier":{ 2020 "shape":"KeyArnOrKeyAliasType", 2021 "documentation":"<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>" 2022 }, 2023 "PinBlockFormat":{ 2024 "shape":"PinBlockFormatForPinData", 2025 "documentation":"<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> <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> <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>" 2026 }, 2027 "PinDataLength":{ 2028 "shape":"IntegerRangeBetween4And12", 2029 "documentation":"<p>The length of PIN being verified.</p>", 2030 "box":true 2031 }, 2032 "PrimaryAccountNumber":{ 2033 "shape":"NumberLengthBetween12And19", 2034 "documentation":"<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>" 2035 }, 2036 "VerificationAttributes":{ 2037 "shape":"PinVerificationAttributes", 2038 "documentation":"<p>The attributes and values for PIN data verification.</p>" 2039 }, 2040 "VerificationKeyIdentifier":{ 2041 "shape":"KeyArnOrKeyAliasType", 2042 "documentation":"<p>The <code>keyARN</code> of the PIN verification key.</p>" 2043 } 2044 } 2045 }, 2046 "VerifyPinDataOutput":{ 2047 "type":"structure", 2048 "required":[ 2049 "EncryptionKeyArn", 2050 "EncryptionKeyCheckValue", 2051 "VerificationKeyArn", 2052 "VerificationKeyCheckValue" 2053 ], 2054 "members":{ 2055 "EncryptionKeyArn":{ 2056 "shape":"KeyArn", 2057 "documentation":"<p>The <code>keyARN</code> of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.</p>" 2058 }, 2059 "EncryptionKeyCheckValue":{ 2060 "shape":"KeyCheckValue", 2061 "documentation":"<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>" 2062 }, 2063 "VerificationKeyArn":{ 2064 "shape":"KeyArn", 2065 "documentation":"<p>The <code>keyARN</code> of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.</p>" 2066 }, 2067 "VerificationKeyCheckValue":{ 2068 "shape":"KeyCheckValue", 2069 "documentation":"<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>" 2070 } 2071 } 2072 }, 2073 "VisaPin":{ 2074 "type":"structure", 2075 "required":["PinVerificationKeyIndex"], 2076 "members":{ 2077 "PinVerificationKeyIndex":{ 2078 "shape":"IntegerRangeBetween0And9", 2079 "documentation":"<p>The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).</p>" 2080 } 2081 }, 2082 "documentation":"<p>Parameters that are required to generate or verify Visa PIN.</p>" 2083 }, 2084 "VisaPinVerification":{ 2085 "type":"structure", 2086 "required":[ 2087 "PinVerificationKeyIndex", 2088 "VerificationValue" 2089 ], 2090 "members":{ 2091 "PinVerificationKeyIndex":{ 2092 "shape":"IntegerRangeBetween0And9", 2093 "documentation":"<p>The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).</p>" 2094 }, 2095 "VerificationValue":{ 2096 "shape":"NumberLengthBetween4And12", 2097 "documentation":"<p>Parameters that are required to generate or verify Visa PVV (PIN Verification Value).</p>" 2098 } 2099 }, 2100 "documentation":"<p>Parameters that are required to generate or verify Visa PIN.</p>" 2101 }, 2102 "VisaPinVerificationValue":{ 2103 "type":"structure", 2104 "required":[ 2105 "EncryptedPinBlock", 2106 "PinVerificationKeyIndex" 2107 ], 2108 "members":{ 2109 "EncryptedPinBlock":{ 2110 "shape":"HexLengthBetween16And32", 2111 "documentation":"<p>The encrypted PIN block data to verify.</p>" 2112 }, 2113 "PinVerificationKeyIndex":{ 2114 "shape":"IntegerRangeBetween0And9", 2115 "documentation":"<p>The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).</p>" 2116 } 2117 }, 2118 "documentation":"<p>Parameters that are required to generate or verify Visa PVV (PIN Verification Value).</p>" 2119 } 2120 }, 2121 "documentation":"<p>You use the Amazon Web Services Payment Cryptography Data Plane to manage how encryption keys are used for payment-related transaction processing and associated cryptographic operations. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations in Amazon Web Services Payment Cryptography. For more information, see <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/userguide/data-operations.html\">Data operations</a> in the <i>Amazon Web Services Payment Cryptography User Guide</i>.</p> <p>To manage your encryption keys, you use the <a href=\"https://docs.aws.amazon.com/payment-cryptography/latest/APIReference/Welcome.html\">Amazon Web Services Payment Cryptography Control Plane</a>. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys. </p>" 2122} 2123