Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide.
You can use an decryption key generated within Amazon Web Services Payment Cryptography, or you can import your own decryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Decrypt. 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 GetPublicCertificate.
This operation also supports dynamic keys, allowing you to pass a dynamic decryption key as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To decrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped decryption key material. The incoming wrapped key shall have a key purpose of D0 with a mode of use of B or D. For more information, see Using Dynamic Keys in the Amazon Web Services Payment Cryptography User Guide.
For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV decryption, Amazon Web Services Payment Cryptography supports TDES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA.
When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "EncryptData":{ "name":"EncryptData", "http":{ "method":"POST", "requestUri":"/keys/{KeyIdentifier}/encrypt", "responseCode":200 }, "input":{"shape":"EncryptDataInput"}, "output":{"shape":"EncryptDataOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
You can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey.
For this operation, the key must have KeyModesOfUse set to Encrypt. 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 ImportKey.
This operation also supports dynamic keys, allowing you to pass a dynamic encryption key as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To encrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped encryption key material. The incoming wrapped key shall have a key purpose of D0 with a mode of use of B or D. For more information, see Using Dynamic Keys in the Amazon Web Services Payment Cryptography User Guide.
For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For EMV encryption, Amazon Web Services Payment Cryptography supports TDES algorithms.For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA.
When you use TDES or TDES DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.
To encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey. To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "GenerateAs2805KekValidation":{ "name":"GenerateAs2805KekValidation", "http":{ "method":"POST", "requestUri":"/as2805kekvalidation/generate", "responseCode":200 }, "input":{"shape":"GenerateAs2805KekValidationInput"}, "output":{"shape":"GenerateAs2805KekValidationOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Establishes node-to-node initialization between payment processing nodes such as an acquirer, issuer or payment network using Australian Standard 2805 (AS2805).
During node-to-node initialization, both communicating nodes must validate that they possess the correct Key Encrypting Keys (KEKs) before proceeding with session key exchange. In AS2805, the sending KEK (KEKs) of one node corresponds to the receiving KEK (KEKr) of its partner node. Each node uses its KEK to encrypt and decrypt session keys exchanged between the nodes. A KEK can be created or imported into Amazon Web Services Payment Cryptography using either the CreateKey or ImportKey operations.
The node initiating communication can use GenerateAS2805KekValidation to generate a combined KEK validation request and KEK validation response to send to the partnering node for validation. When invoked, the API internally generates a random sending key encrypted under KEKs and provides a receiving key encrypted under KEKr as response. The initiating node sends the response returned by this API to its partner for validation.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
" }, "GenerateCardValidationData":{ "name":"GenerateCardValidationData", "http":{ "method":"POST", "requestUri":"/cardvalidationdata/generate", "responseCode":200 }, "input":{"shape":"GenerateCardValidationDataInput"}, "output":{"shape":"GenerateCardValidationDataOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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 Generate card data in the Amazon Web Services Payment Cryptography User Guide.
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 CreateKey or ImportKey to establish a CVK within Amazon Web Services Payment Cryptography. The KeyModesOfUse should be set to Generate and Verify for a CVK encryption key.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "GenerateMac":{ "name":"GenerateMac", "http":{ "method":"POST", "requestUri":"/mac/generate", "responseCode":200 }, "input":{"shape":"GenerateMacInput"}, "output":{"shape":"GenerateMacOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.
You can use this operation to authenticate card-related data by using known data values to generate MAC for data validation between the sending and receiving parties. This operation uses message data, a secret encryption key and MAC algorithm to generate a unique MAC value for transmission. The receiving party of the MAC must use the same message data, secret encryption key and MAC algorithm to reproduce another MAC value for comparision.
You can use this operation to generate a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC generation, and the key must have KeyModesOfUse set to Generate.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "GenerateMacEmvPinChange":{ "name":"GenerateMacEmvPinChange", "http":{ "method":"POST", "requestUri":"/macemvpinchange/generate", "responseCode":200 }, "input":{"shape":"GenerateMacEmvPinChangeInput"}, "output":{"shape":"GenerateMacEmvPinChangeOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Generates an issuer script mac for EMV payment cards that use offline PINs as the cardholder verification method (CVM).
This operation generates an authenticated issuer script response by appending the incoming message data (APDU command) with the target encrypted PIN block in ISO2 format. The command structure and method to send the issuer script update to the card is not defined by this operation and is typically determined by the applicable payment card scheme.
The primary inputs to this operation include the incoming new encrypted pinblock, PIN encryption key (PEK), issuer master key (IMK), primary account number (PAN), and the payment card derivation method.
The operation uses two issuer master keys - secure messaging for confidentiality (IMK-SMC) and secure messaging for integrity (IMK-SMI). The SMC key is used to internally derive a key to secure the pin, while SMI key is used to internally derive a key to authenticate the script reponse as per the EMV 4.4 - Book 2 - Security and Key Management specification.
This operation supports Amex, EMV2000, EMVCommon, Mastercard and Visa derivation methods, each requiring specific input parameters. Users must follow the specific derivation method and input parameters defined by the respective payment card scheme.
Use GenerateMac operation when sending a script update to an EMV card that does not involve PIN change. When assigning IAM permissions, it is important to understand that EncryptData using EMV keys and GenerateMac perform similar functions to this command.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "GeneratePinData":{ "name":"GeneratePinData", "http":{ "method":"POST", "requestUri":"/pindata/generate", "responseCode":200 }, "input":{"shape":"GeneratePinDataInput"}, "output":{"shape":"GeneratePinDataOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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 Generate PIN data in the Amazon Web Services Payment Cryptography User Guide.
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 EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography. This operation uses a separate Pin Verification Key (PVK) for VISA PVV generation.
Using ECDH key exchange, you can receive cardholder selectable PINs into Amazon Web Services Payment Cryptography. The ECDH derived key protects the incoming PIN block. You can also use it for reveal PIN, wherein the generated PIN block is protected by the ECDH derived key before transmission from Amazon Web Services Payment Cryptography. For more information on establishing ECDH derived keys, see the Generating keys in the Amazon Web Services Payment Cryptography User Guide.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "ReEncryptData":{ "name":"ReEncryptData", "http":{ "method":"POST", "requestUri":"/keys/{IncomingKeyIdentifier}/reencrypt", "responseCode":200 }, "input":{"shape":"ReEncryptDataInput"}, "output":{"shape":"ReEncryptDataOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Re-encrypt ciphertext using DUKPT or Symmetric data encryption keys.
You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt.
This operation also supports dynamic keys, allowing you to pass a dynamic encryption key as a TR-31 WrappedKeyBlock. This can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To re-encrypt using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped encryption key material. The incoming wrapped key shall have a key purpose of D0 with a mode of use of B or D. For more information, see Using Dynamic Keys in the Amazon Web Services Payment Cryptography User Guide.
For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling CreateKey.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "TranslateKeyMaterial":{ "name":"TranslateKeyMaterial", "http":{ "method":"POST", "requestUri":"/keymaterial/translate", "responseCode":200 }, "input":{"shape":"TranslateKeyMaterialInput"}, "output":{"shape":"TranslateKeyMaterialOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Translates an cryptographic key between different wrapping keys without importing the key into Amazon Web Services Payment Cryptography.
This operation can be used when key material is frequently rotated, such as during every card transaction, and there is a need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. It translates short-lived transaction keys such as PEK generated for each transaction and wrapped with an ECDH derived wrapping key to another KEK wrapping key.
Before using this operation, you must first request the public key certificate of the ECC key pair generated within Amazon Web Services Payment Cryptography to establish an ECDH key agreement. In TranslateKeyData, the service uses its own ECC key pair, public certificate of receiving ECC key pair, and the key derivation parameters to generate a derived key. The service uses this derived key to unwrap the incoming transaction key received as a TR31WrappedKeyBlock and re-wrap using a user provided KEK to generate an outgoing Tr31WrappedKeyBlock.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "TranslatePinData":{ "name":"TranslatePinData", "http":{ "method":"POST", "requestUri":"/pindata/translate", "responseCode":200 }, "input":{"shape":"TranslatePinDataInput"}, "output":{"shape":"TranslatePinDataOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide.
PIN block translation involves changing a PIN block from one encryption key to another and optionally change its format. PIN block translation occurs entirely within the HSM boundary and PIN data never enters or leaves Amazon Web Services Payment Cryptography in clear text. 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 also supports use of dynamic keys and ECDH (Elliptic Curve Diffie-Hellman) based key exchange for this operation.
Dynamic keys allow you to pass a PEK as a TR-31 WrappedKeyBlock. They can be used when key material is frequently rotated, such as during every card transaction, and there is need to avoid importing short-lived keys into Amazon Web Services Payment Cryptography. To translate PIN block using dynamic keys, the keyARN is the Key Encryption Key (KEK) of the TR-31 wrapped PEK. The incoming wrapped key shall have a key purpose of P0 with a mode of use of B or D. For more information, see Using Dynamic Keys in the Amazon Web Services Payment Cryptography User Guide.
Using ECDH key exchange, you can receive cardholder selectable PINs into Amazon Web Services Payment Cryptography. The ECDH derived key protects the incoming PIN block, which is translated to a PEK encrypted PIN block for use within the service. You can also use ECDH for reveal PIN, wherein the service translates the PIN block from PEK to a ECDH derived encryption key. For more information on establishing ECDH derived keys, see the Creating keys in the Amazon Web Services Payment Cryptography User Guide.
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.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Amazon Web Services Payment Cryptography currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length. That is, PAN is the right most 12 digits excluding the check digits.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "VerifyAuthRequestCryptogram":{ "name":"VerifyAuthRequestCryptogram", "http":{ "method":"POST", "requestUri":"/cryptogram/verify", "responseCode":200 }, "input":{"shape":"VerifyAuthRequestCryptogramInput"}, "output":{"shape":"VerifyAuthRequestCryptogramOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"VerificationFailedException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization. For more information, see Verify auth request cryptogram in the Amazon Web Services Payment Cryptography User Guide.
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 ImportKey. This operation uses the imported ARQC and an major encryption key (DUKPT) created by calling CreateKey to either provide a boolean ARQC verification result or provide an APRC (Authorization Response Cryptogram) response using Method 1 or Method 2. The ARPC_METHOD_1 uses AuthResponseCode to generate ARPC and ARPC_METHOD_2 uses CardStatusUpdate to generate ARPC.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "VerifyCardValidationData":{ "name":"VerifyCardValidationData", "http":{ "method":"POST", "requestUri":"/cardvalidationdata/verify", "responseCode":200 }, "input":{"shape":"VerifyCardValidationDataInput"}, "output":{"shape":"VerifyCardValidationDataOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"VerificationFailedException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"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 Verify card data in the Amazon Web Services Payment Cryptography User Guide.
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 GenerateCardValidationData.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "VerifyMac":{ "name":"VerifyMac", "http":{ "method":"POST", "requestUri":"/mac/verify", "responseCode":200 }, "input":{"shape":"VerifyMacInput"}, "output":{"shape":"VerifyMacOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"VerificationFailedException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Verifies a Message Authentication Code (MAC).
You can use this operation to verify MAC for message data authentication such as . In this operation, you must use the same message data, secret encryption key and MAC algorithm that was used to generate MAC. You can use this operation to verify a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" }, "VerifyPinData":{ "name":"VerifyPinData", "http":{ "method":"POST", "requestUri":"/pindata/verify", "responseCode":200 }, "input":{"shape":"VerifyPinDataInput"}, "output":{"shape":"VerifyPinDataOutput"}, "errors":[ {"shape":"ValidationException"}, {"shape":"VerificationFailedException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"}, {"shape":"InternalServerException"} ], "documentation":"Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see Verify PIN data in the Amazon Web Services Payment Cryptography User Guide.
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 EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography.
For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.
Cross-account use: This operation can't be used across different Amazon Web Services accounts.
Related operations:
" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"You do not have sufficient access to perform this action.
", "error":{ "httpStatusCode":403, "senderFault":true }, "exception":true }, "AmexAttributes":{ "type":"structure", "required":[ "MajorKeyDerivationMode", "PrimaryAccountNumber", "PanSequenceNumber", "ApplicationTransactionCounter", "AuthorizationRequestKeyIdentifier" ], "members":{ "MajorKeyDerivationMode":{ "shape":"MajorKeyDerivationMode", "documentation":"The method to use when deriving the master key for a payment card using Amex derivation.
" }, "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"The Primary Account Number (PAN) of the cardholder.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthEquals4", "documentation":"The transaction counter of the current transaction that is provided by the terminal during transaction processing.
" }, "AuthorizationRequestKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyArn of the issuer master key for cryptogram (IMK-AC) for the payment card.
The encrypted pinblock of the old pin stored on the chip card.
" } }, "documentation":"Parameters to derive the confidentiality and integrity keys for a payment card using Amex derivation method.
" }, "AmexCardSecurityCodeVersion1":{ "type":"structure", "required":["CardExpiryDate"], "members":{ "CardExpiryDate":{ "shape":"CardExpiryDateType", "documentation":"The expiry date of a payment card.
" } }, "documentation":"Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
" }, "AmexCardSecurityCodeVersion2":{ "type":"structure", "required":[ "CardExpiryDate", "ServiceCode" ], "members":{ "CardExpiryDate":{ "shape":"CardExpiryDateType", "documentation":"The expiry date of a payment card.
" }, "ServiceCode":{ "shape":"ServiceCodeType", "documentation":"The service code of the AMEX payment card. This is different from the Card Security Code (CSC).
" } }, "documentation":"Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
" }, "ApplicationCryptogramType":{ "type":"string", "max":16, "min":16, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "As2805KekValidationType":{ "type":"structure", "members":{ "KekValidationRequest":{ "shape":"KekValidationRequest", "documentation":"Parameter information for generating a KEK validation request during node-to-node initialization.
" }, "KekValidationResponse":{ "shape":"KekValidationResponse", "documentation":"Parameter information for generating a KEK validation response during node-to-node initialization.
" } }, "documentation":"Parameter information for generating a random key for KEK validation to perform node-to-node initialization.
", "union":true }, "As2805PekDerivationAttributes":{ "type":"structure", "required":[ "SystemTraceAuditNumber", "TransactionAmount" ], "members":{ "SystemTraceAuditNumber":{ "shape":"SystemTraceAuditNumberType", "documentation":"The system trace audit number for the transaction.
" }, "TransactionAmount":{ "shape":"TransactionAmountType", "documentation":"The transaction amount for the transaction.
" } }, "documentation":"Parameter information to use a PEK derived using AS2805.
" }, "As2805RandomKeyMaterial":{ "type":"string", "max":48, "min":32, "pattern":"(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{48})", "sensitive":true }, "AsymmetricEncryptionAttributes":{ "type":"structure", "members":{ "PaddingType":{ "shape":"PaddingType", "documentation":"The padding to be included with the data.
" } }, "documentation":"Parameters for plaintext encryption using asymmetric keys.
" }, "AuthRequestCryptogramType":{ "type":"string", "max":16, "min":16, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "AuthResponseValueType":{ "type":"string", "max":16, "min":1, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "CardExpiryDateType":{ "type":"string", "max":4, "min":4, "pattern":"[0-9]+", "sensitive":true }, "CardGenerationAttributes":{ "type":"structure", "members":{ "AmexCardSecurityCodeVersion1":{"shape":"AmexCardSecurityCodeVersion1"}, "AmexCardSecurityCodeVersion2":{ "shape":"AmexCardSecurityCodeVersion2", "documentation":"Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
" }, "CardVerificationValue1":{ "shape":"CardVerificationValue1", "documentation":"Card data parameters that are required to generate Card Verification Value (CVV) for the payment card.
" }, "CardVerificationValue2":{ "shape":"CardVerificationValue2", "documentation":"Card data parameters that are required to generate Card Verification Value (CVV2) for the payment card.
" }, "CardHolderVerificationValue":{ "shape":"CardHolderVerificationValue", "documentation":"Card data parameters that are required to generate a cardholder verification value for the payment card.
" }, "DynamicCardVerificationCode":{ "shape":"DynamicCardVerificationCode", "documentation":"Card data parameters that are required to generate CDynamic Card Verification Code (dCVC) for the payment card.
" }, "DynamicCardVerificationValue":{ "shape":"DynamicCardVerificationValue", "documentation":"Card data parameters that are required to generate CDynamic Card Verification Value (dCVV) for the payment card.
" } }, "documentation":"Card data parameters that are required to generate Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).
", "union":true }, "CardHolderVerificationValue":{ "type":"structure", "required":[ "UnpredictableNumber", "PanSequenceNumber", "ApplicationTransactionCounter" ], "members":{ "UnpredictableNumber":{ "shape":"HexLengthBetween2And8", "documentation":"A random number generated by the issuer.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthBetween2And4", "documentation":"The transaction counter value that comes from a point of sale terminal.
" } }, "documentation":"Card data parameters that are required to generate a cardholder verification value for the payment card.
" }, "CardVerificationAttributes":{ "type":"structure", "members":{ "AmexCardSecurityCodeVersion1":{"shape":"AmexCardSecurityCodeVersion1"}, "AmexCardSecurityCodeVersion2":{ "shape":"AmexCardSecurityCodeVersion2", "documentation":"Card data parameters that are required to verify a Card Security Code (CSC2) for an AMEX payment card.
" }, "CardVerificationValue1":{ "shape":"CardVerificationValue1", "documentation":"Card data parameters that are required to verify Card Verification Value (CVV) for the payment card.
" }, "CardVerificationValue2":{ "shape":"CardVerificationValue2", "documentation":"Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.
" }, "CardHolderVerificationValue":{ "shape":"CardHolderVerificationValue", "documentation":"Card data parameters that are required to verify a cardholder verification value for the payment card.
" }, "DynamicCardVerificationCode":{ "shape":"DynamicCardVerificationCode", "documentation":"Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.
" }, "DynamicCardVerificationValue":{ "shape":"DynamicCardVerificationValue", "documentation":"Card data parameters that are required to verify CDynamic Card Verification Value (dCVV) for the payment card.
" }, "DiscoverDynamicCardVerificationCode":{ "shape":"DiscoverDynamicCardVerificationCode", "documentation":"Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.
" } }, "documentation":"Card data parameters that are requried to verify Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).
", "union":true }, "CardVerificationValue1":{ "type":"structure", "required":[ "CardExpiryDate", "ServiceCode" ], "members":{ "CardExpiryDate":{ "shape":"CardExpiryDateType", "documentation":"The expiry date of a payment card.
" }, "ServiceCode":{ "shape":"ServiceCodeType", "documentation":"The service code of the payment card. This is different from Card Security Code (CSC).
" } }, "documentation":"Card data parameters that are required to verify CVV (Card Verification Value) for the payment card.
" }, "CardVerificationValue2":{ "type":"structure", "required":["CardExpiryDate"], "members":{ "CardExpiryDate":{ "shape":"CardExpiryDateType", "documentation":"The expiry date of a payment card.
" } }, "documentation":"Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.
" }, "CertificateType":{ "type":"string", "max":32768, "min":1, "pattern":"[^\\[;\\]<>]+" }, "CipherTextType":{ "type":"string", "max":4224, "min":2, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "CommandMessageDataType":{ "type":"string", "max":1024, "min":16, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "CryptogramAuthResponse":{ "type":"structure", "members":{ "ArpcMethod1":{ "shape":"CryptogramVerificationArpcMethod1", "documentation":"Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.
" }, "ArpcMethod2":{ "shape":"CryptogramVerificationArpcMethod2", "documentation":"Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.
" } }, "documentation":"Parameters that are required for Authorization Response Cryptogram (ARPC) generation after Authorization Request Cryptogram (ARQC) verification is successful.
", "union":true }, "CryptogramVerificationArpcMethod1":{ "type":"structure", "required":["AuthResponseCode"], "members":{ "AuthResponseCode":{ "shape":"HexLengthEquals4", "documentation":"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.
" } }, "documentation":"Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.
" }, "CryptogramVerificationArpcMethod2":{ "type":"structure", "required":["CardStatusUpdate"], "members":{ "CardStatusUpdate":{ "shape":"HexLengthEquals8", "documentation":"The data indicating whether the issuer approves or declines an online transaction using an EMV chip card.
" }, "ProprietaryAuthenticationData":{ "shape":"ProprietaryAuthenticationDataType", "documentation":"The proprietary authentication data used by issuer for communication during online transaction using an EMV chip card.
" } }, "documentation":"Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.
" }, "CurrentPinAttributes":{ "type":"structure", "required":[ "CurrentPinPekIdentifier", "CurrentEncryptedPinBlock" ], "members":{ "CurrentPinPekIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyArn of the current PIN PEK.
The encrypted pinblock of the current pin stored on the chip card.
" } }, "documentation":"The parameter values of the current PIN to be changed on the EMV chip card.
" }, "DecimalizationTableType":{ "type":"string", "max":16, "min":16, "pattern":"[0-9]+", "sensitive":true }, "DecryptDataInput":{ "type":"structure", "required":[ "KeyIdentifier", "CipherText", "DecryptionAttributes" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
", "location":"uri", "locationName":"KeyIdentifier" }, "CipherText":{ "shape":"CipherTextType", "documentation":"The ciphertext to decrypt.
" }, "DecryptionAttributes":{ "shape":"EncryptionDecryptionAttributes", "documentation":"The encryption key type and attributes for ciphertext decryption.
" }, "WrappedKey":{ "shape":"WrappedKey", "documentation":"The WrappedKeyBlock containing the encryption key for ciphertext decryption.
" } } }, "DecryptDataOutput":{ "type":"structure", "required":[ "KeyArn", "KeyCheckValue", "PlainText" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.
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 computes the KCV according to the CMAC specification.
" }, "PlainText":{ "shape":"PlainTextOutputType", "documentation":"The decrypted plaintext data in hexBinary format.
" } } }, "DerivationMethodAttributes":{ "type":"structure", "members":{ "EmvCommon":{ "shape":"EmvCommonAttributes", "documentation":"Parameters to derive the confidentiality and integrity keys for a payment card using Emv common derivation method.
" }, "Amex":{ "shape":"AmexAttributes", "documentation":"Parameters to derive the confidentiality and integrity keys for a payment card using Amex derivation method.
" }, "Visa":{ "shape":"VisaAttributes", "documentation":"Parameters to derive the confidentiality and integrity keys for a a payment card using Visa derivation method.
" }, "Emv2000":{ "shape":"Emv2000Attributes", "documentation":"Parameters to derive the confidentiality and integrity keys for a payment card using Emv2000 derivation method.
" }, "Mastercard":{ "shape":"MasterCardAttributes", "documentation":"Parameters to derive the confidentiality and integrity keys for a payment card using Mastercard derivation method.
" } }, "documentation":"Parameters to derive the payment card specific confidentiality and integrity keys.
", "union":true }, "DiffieHellmanDerivationData":{ "type":"structure", "members":{ "SharedInformation":{ "shape":"SharedInformation", "documentation":"A string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes. It is not recommended to reuse shared information for multiple ECDH key derivations, as it could result in derived key material being the same across different derivations.
" } }, "documentation":"The shared information used when deriving a key using ECDH.
", "union":true }, "DiscoverDynamicCardVerificationCode":{ "type":"structure", "required":[ "CardExpiryDate", "UnpredictableNumber", "ApplicationTransactionCounter" ], "members":{ "CardExpiryDate":{ "shape":"CardExpiryDateType", "documentation":"The expiry date of a payment card.
" }, "UnpredictableNumber":{ "shape":"HexLengthBetween2And8", "documentation":"A random number that is generated by the issuer.
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthBetween2And4", "documentation":"The transaction counter value that comes from the terminal.
" } }, "documentation":"Parameters that are required to generate or verify dCVC (Dynamic Card Verification Code).
" }, "DukptAttributes":{ "type":"structure", "required":[ "KeySerialNumber", "DukptDerivationType" ], "members":{ "KeySerialNumber":{ "shape":"HexLength16Or20Or24", "documentation":"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.
" }, "DukptDerivationType":{ "shape":"DukptDerivationType", "documentation":"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 AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
Parameters that are used for Derived Unique Key Per Transaction (DUKPT) derivation algorithm.
" }, "DukptDerivationAttributes":{ "type":"structure", "required":["KeySerialNumber"], "members":{ "KeySerialNumber":{ "shape":"HexLength16Or20Or24", "documentation":"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.
" }, "DukptKeyDerivationType":{ "shape":"DukptDerivationType", "documentation":"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 AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.
" } }, "documentation":"Parameters required for encryption or decryption of data using DUKPT.
" }, "DukptDerivationType":{ "type":"string", "enum":[ "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256" ] }, "DukptEncryptionAttributes":{ "type":"structure", "required":["KeySerialNumber"], "members":{ "KeySerialNumber":{ "shape":"HexLength16Or20Or24", "documentation":"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.
" }, "Mode":{ "shape":"DukptEncryptionMode", "documentation":"The block cipher method to use for encryption.
The default is CBC.
" }, "DukptKeyDerivationType":{ "shape":"DukptDerivationType", "documentation":"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 AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
" }, "InitializationVector":{ "shape":"InitializationVectorType", "documentation":"An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" } }, "documentation":"Parameters that are required to encrypt plaintext data using DUKPT.
" }, "DukptEncryptionMode":{ "type":"string", "enum":[ "ECB", "CBC" ] }, "DukptKeyVariant":{ "type":"string", "enum":[ "BIDIRECTIONAL", "REQUEST", "RESPONSE" ] }, "DynamicCardVerificationCode":{ "type":"structure", "required":[ "UnpredictableNumber", "PanSequenceNumber", "ApplicationTransactionCounter", "TrackData" ], "members":{ "UnpredictableNumber":{ "shape":"HexLengthBetween2And8", "documentation":"A random number generated by the issuer.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthBetween2And4", "documentation":"The transaction counter value that comes from the terminal.
" }, "TrackData":{ "shape":"TrackDataType", "documentation":"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.
" } }, "documentation":"Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).
" }, "DynamicCardVerificationValue":{ "type":"structure", "required":[ "PanSequenceNumber", "CardExpiryDate", "ServiceCode", "ApplicationTransactionCounter" ], "members":{ "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, "CardExpiryDate":{ "shape":"CardExpiryDateType", "documentation":"The expiry date of a payment card.
" }, "ServiceCode":{ "shape":"ServiceCodeType", "documentation":"The service code of the payment card. This is different from Card Security Code (CSC).
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthBetween2And4", "documentation":"The transaction counter value that comes from the terminal.
" } }, "documentation":"Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).
" }, "EcdhDerivationAttributes":{ "type":"structure", "required":[ "CertificateAuthorityPublicKeyIdentifier", "PublicKeyCertificate", "KeyAlgorithm", "KeyDerivationFunction", "KeyDerivationHashAlgorithm", "SharedInformation" ], "members":{ "CertificateAuthorityPublicKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyArn of the certificate that signed the client's PublicKeyCertificate.
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
" }, "KeyAlgorithm":{ "shape":"SymmetricKeyAlgorithm", "documentation":"The key algorithm of the derived ECDH key.
" }, "KeyDerivationFunction":{ "shape":"KeyDerivationFunction", "documentation":"The key derivation function to use for deriving a key using ECDH.
" }, "KeyDerivationHashAlgorithm":{ "shape":"KeyDerivationHashAlgorithm", "documentation":"The hash type to use for deriving a key using ECDH.
" }, "SharedInformation":{ "shape":"SharedInformation", "documentation":"A byte string containing information that binds the ECDH derived key to the two parties involved or to the context of the key.
It may include details like identities of the two parties deriving the key, context of the operation, session IDs, and optionally a nonce. It must not contain zero bytes, and re-using shared information for multiple ECDH key derivations is not recommended.
" } }, "documentation":"Parameters required to establish ECDH based key exchange.
" }, "Emv2000Attributes":{ "type":"structure", "required":[ "MajorKeyDerivationMode", "PrimaryAccountNumber", "PanSequenceNumber", "ApplicationTransactionCounter" ], "members":{ "MajorKeyDerivationMode":{ "shape":"MajorKeyDerivationMode", "documentation":"The method to use when deriving the master key for the payment card.
" }, "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"The Primary Account Number (PAN) of the cardholder.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthEquals4", "documentation":"The transaction counter of the current transaction that is provided by the terminal during transaction processing.
" } }, "documentation":"Parameters to derive the confidentiality and integrity keys for a payment card using EMV2000 deruv.
" }, "EmvCommonAttributes":{ "type":"structure", "required":[ "MajorKeyDerivationMode", "PrimaryAccountNumber", "PanSequenceNumber", "ApplicationCryptogram", "Mode", "PinBlockPaddingType", "PinBlockLengthPosition" ], "members":{ "MajorKeyDerivationMode":{ "shape":"MajorKeyDerivationMode", "documentation":"The method to use when deriving the master key for the payment card.
" }, "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"The Primary Account Number (PAN) of the cardholder.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.
" }, "ApplicationCryptogram":{ "shape":"ApplicationCryptogramType", "documentation":"The application cryptogram for the current transaction that is provided by the terminal during transaction processing.
" }, "Mode":{ "shape":"EmvEncryptionMode", "documentation":"The block cipher method to use for encryption.
" }, "PinBlockPaddingType":{ "shape":"PinBlockPaddingType", "documentation":"The padding to be added to the PIN block prior to encryption.
Padding type should be ISO_IEC_7816_4, if PinBlockLengthPosition is set to FRONT_OF_PIN_BLOCK. No padding is required, if PinBlockLengthPosition is set to NONE.
Specifies if PIN block length should be added to front of the pin block.
If value is set to FRONT_OF_PIN_BLOCK, then PIN block padding type should be ISO_IEC_7816_4.
Parameters to derive the confidentiality and integrity keys for an Emv common payment card.
" }, "EmvEncryptionAttributes":{ "type":"structure", "required":[ "MajorKeyDerivationMode", "PrimaryAccountNumber", "PanSequenceNumber", "SessionDerivationData" ], "members":{ "MajorKeyDerivationMode":{ "shape":"EmvMajorKeyDerivationMode", "documentation":"The EMV derivation mode to use for ICC master key derivation as per EMV version 4.3 book 2.
" }, "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.
" }, "SessionDerivationData":{ "shape":"SessionDerivationDataType", "documentation":"The derivation value used to derive the ICC session key. It is typically the application transaction counter value padded with zeros or previous ARQC value padded with zeros as per EMV version 4.3 book 2.
" }, "Mode":{ "shape":"EmvEncryptionMode", "documentation":"The block cipher method to use for encryption.
" }, "InitializationVector":{ "shape":"InitializationVectorType", "documentation":"An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" } }, "documentation":"Parameters for plaintext encryption using EMV keys.
" }, "EmvEncryptionMode":{ "type":"string", "enum":[ "ECB", "CBC" ] }, "EmvMajorKeyDerivationMode":{ "type":"string", "enum":[ "EMV_OPTION_A", "EMV_OPTION_B" ] }, "EncryptDataInput":{ "type":"structure", "required":[ "KeyIdentifier", "PlainText", "EncryptionAttributes" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
", "location":"uri", "locationName":"KeyIdentifier" }, "PlainText":{ "shape":"PlainTextType", "documentation":"The plaintext to be encrypted.
For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.
The encryption key type and attributes for plaintext encryption.
" }, "WrappedKey":{ "shape":"WrappedKey", "documentation":"The WrappedKeyBlock containing the encryption key for plaintext encryption.
" } } }, "EncryptDataOutput":{ "type":"structure", "required":[ "KeyArn", "CipherText" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
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 computes the KCV according to the CMAC specification.
" }, "CipherText":{ "shape":"CipherTextType", "documentation":"The encrypted ciphertext.
" } } }, "EncryptedPinBlockType":{ "type":"string", "max":32, "min":16, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "EncryptionDecryptionAttributes":{ "type":"structure", "members":{ "Symmetric":{ "shape":"SymmetricEncryptionAttributes", "documentation":"Parameters that are required to perform encryption and decryption using symmetric keys.
" }, "Asymmetric":{"shape":"AsymmetricEncryptionAttributes"}, "Dukpt":{"shape":"DukptEncryptionAttributes"}, "Emv":{ "shape":"EmvEncryptionAttributes", "documentation":"Parameters for plaintext encryption using EMV keys.
" } }, "documentation":"Parameters that are required to perform encryption and decryption operations.
", "union":true }, "EncryptionMode":{ "type":"string", "enum":[ "ECB", "CBC", "CFB", "CFB1", "CFB8", "CFB64", "CFB128", "OFB" ] }, "GenerateAs2805KekValidationInput":{ "type":"structure", "required":[ "KeyIdentifier", "KekValidationType", "RandomKeySendVariantMask" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of sending KEK that Amazon Web Services Payment Cryptography uses for node-to-node initialization
Parameter information for generating a random key for KEK validation to perform node-to-node initialization.
" }, "RandomKeySendVariantMask":{ "shape":"RandomKeySendVariantMask", "documentation":"The key variant to use for generating a random key for KEK validation during node-to-node initialization.
" } } }, "GenerateAs2805KekValidationOutput":{ "type":"structure", "required":[ "KeyArn", "KeyCheckValue", "RandomKeySend", "RandomKeyReceive" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of sending KEK that Amazon Web Services Payment Cryptography validates for node-to-node initialization
The key check value (KCV) of the sending KEK that Amazon Web Services Payment Cryptography validates for node-to-node initialization.
" }, "RandomKeySend":{ "shape":"As2805RandomKeyMaterial", "documentation":"The random key generated for sending KEK validation.
" }, "RandomKeyReceive":{ "shape":"As2805RandomKeyMaterial", "documentation":"The random key generated for receiving KEK validation. The initiating node sends this key to its partner node for validation.
" } } }, "GenerateCardValidationDataInput":{ "type":"structure", "required":[ "KeyIdentifier", "PrimaryAccountNumber", "GenerationAttributes" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" }, "GenerationAttributes":{ "shape":"CardGenerationAttributes", "documentation":"The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.
" }, "ValidationDataLength":{ "shape":"IntegerRangeBetween3And5Type", "documentation":"The length of the CVV or CSC to be generated. The default value is 3.
" } } }, "GenerateCardValidationDataOutput":{ "type":"structure", "required":[ "KeyArn", "KeyCheckValue", "ValidationData" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate CVV or CSC.
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 computes the KCV according to the CMAC specification.
" }, "ValidationData":{ "shape":"ValidationDataType", "documentation":"The CVV or CSC value that Amazon Web Services Payment Cryptography generates for the card.
" } } }, "GenerateMacEmvPinChangeInput":{ "type":"structure", "required":[ "NewPinPekIdentifier", "NewEncryptedPinBlock", "PinBlockFormat", "SecureMessagingIntegrityKeyIdentifier", "SecureMessagingConfidentialityKeyIdentifier", "MessageData", "DerivationMethodAttributes" ], "members":{ "NewPinPekIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the PEK protecting the incoming new encrypted PIN block.
The incoming new encrypted PIN block data for offline pin change on an EMV card.
" }, "PinBlockFormat":{ "shape":"PinBlockFormatForEmvPinChange", "documentation":"The PIN encoding format of the incoming new encrypted PIN block as specified in ISO 9564.
" }, "SecureMessagingIntegrityKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the issuer master key (IMK-SMI) used to authenticate the issuer script response.
The keyARN of the issuer master key (IMK-SMC) used to protect the PIN block data in the issuer script response.
The message data is the APDU command from the card reader or terminal. The target encrypted PIN block, after translation to ISO2 format, is appended to this message data to generate an issuer script response.
" }, "DerivationMethodAttributes":{ "shape":"DerivationMethodAttributes", "documentation":"The attributes and data values to derive payment card specific confidentiality and integrity keys.
" } } }, "GenerateMacEmvPinChangeOutput":{ "type":"structure", "required":[ "NewPinPekArn", "SecureMessagingIntegrityKeyArn", "SecureMessagingConfidentialityKeyArn", "Mac", "EncryptedPinBlock", "NewPinPekKeyCheckValue", "SecureMessagingIntegrityKeyCheckValue", "SecureMessagingConfidentialityKeyCheckValue" ], "members":{ "NewPinPekArn":{ "shape":"KeyArn", "documentation":"Returns the keyArn of the PEK protecting the incoming new encrypted PIN block.
Returns the keyArn of the IMK-SMI used by the operation.
Returns the keyArn of the IMK-SMC used by the operation.
Returns the mac of the issuer script containing message data and appended target encrypted pin block in ISO2 format.
" }, "EncryptedPinBlock":{ "shape":"EncryptedPinBlockType", "documentation":"Returns the incoming new encrpted PIN block.
" }, "NewPinPekKeyCheckValue":{ "shape":"KeyCheckValue", "documentation":"The key check value (KCV) of the PEK uprotecting the incoming new encrypted PIN block.
" }, "SecureMessagingIntegrityKeyCheckValue":{ "shape":"KeyCheckValue", "documentation":"The key check value (KCV) of the SMI issuer master key used by the operation.
" }, "SecureMessagingConfidentialityKeyCheckValue":{ "shape":"KeyCheckValue", "documentation":"The key check value (KCV) of the SMC issuer master key used by the operation.
" }, "VisaAmexDerivationOutputs":{ "shape":"VisaAmexDerivationOutputs", "documentation":"The attribute values used for Amex and Visa derivation methods.
" } } }, "GenerateMacInput":{ "type":"structure", "required":[ "KeyIdentifier", "MessageData", "GenerationAttributes" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the MAC generation encryption key.
The data for which a MAC is under generation. This value must be hexBinary.
" }, "GenerationAttributes":{ "shape":"MacAttributes", "documentation":"The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.
" }, "MacLength":{ "shape":"IntegerRangeBetween4And16", "documentation":"The length of a MAC under generation.
" } } }, "GenerateMacOutput":{ "type":"structure", "required":[ "KeyArn", "KeyCheckValue", "Mac" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.
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 computes the KCV according to the CMAC specification.
" }, "Mac":{ "shape":"MacOutputType", "documentation":"The MAC cryptogram generated within Amazon Web Services Payment Cryptography.
" } } }, "GeneratePinDataInput":{ "type":"structure", "required":[ "GenerationKeyIdentifier", "EncryptionKeyIdentifier", "GenerationAttributes", "PinBlockFormat" ], "members":{ "GenerationKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block. For ECDH, it is the keyARN of the asymmetric ECC key.
The attributes and values to use for PIN, PVV, or PIN Offset generation.
" }, "PinDataLength":{ "shape":"IntegerRangeBetween4And12", "documentation":"The length of PIN under generation.
" }, "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" }, "PinBlockFormat":{ "shape":"PinBlockFormatForPinData", "documentation":"The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0, ISO_Format_3 and ISO_Format_4.
The ISO_Format_0 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.
The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
The ISO_Format_4 PIN block format is the only one supporting AES encryption.
The keyARN of the pin data generation key that Amazon Web Services Payment Cryptography uses for PIN, PVV or PIN Offset generation.
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 computes the KCV according to the CMAC specification.
" }, "EncryptionKeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation. For ECDH, it is the keyARN of the asymmetric ECC key.
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 computes the KCV according to the CMAC specification.
" }, "EncryptedPinBlock":{ "shape":"EncryptedPinBlockType", "documentation":"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.
" }, "PinData":{ "shape":"PinData", "documentation":"The attributes and values Amazon Web Services Payment Cryptography uses for pin data generation.
" } } }, "HexEvenLengthBetween16And32":{ "type":"string", "max":32, "min":16, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "HexLength16Or20Or24":{ "type":"string", "max":24, "min":16, "pattern":"(?:[0-9a-fA-F]{16}|[0-9a-fA-F]{20}|[0-9a-fA-F]{24})" }, "HexLengthBetween2And4":{ "type":"string", "max":4, "min":2, "pattern":"[0-9a-fA-F]+" }, "HexLengthBetween2And8":{ "type":"string", "max":8, "min":2, "pattern":"[0-9a-fA-F]+" }, "HexLengthEquals1":{ "type":"string", "max":1, "min":1, "pattern":"[0-9A-F]+" }, "HexLengthEquals4":{ "type":"string", "max":4, "min":4, "pattern":"[0-9a-fA-F]+" }, "HexLengthEquals8":{ "type":"string", "max":8, "min":8, "pattern":"[0-9a-fA-F]+" }, "Ibm3624NaturalPin":{ "type":"structure", "required":[ "DecimalizationTable", "PinValidationDataPadCharacter", "PinValidationData" ], "members":{ "DecimalizationTable":{ "shape":"DecimalizationTableType", "documentation":"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.
" }, "PinValidationDataPadCharacter":{ "shape":"HexLengthEquals1", "documentation":"The padding character for validation data.
" }, "PinValidationData":{ "shape":"PinValidationDataType", "documentation":"The unique data for cardholder identification.
" } }, "documentation":"Parameters that are required to generate or verify Ibm3624 natural PIN.
" }, "Ibm3624PinFromOffset":{ "type":"structure", "required":[ "DecimalizationTable", "PinValidationDataPadCharacter", "PinValidationData", "PinOffset" ], "members":{ "DecimalizationTable":{ "shape":"DecimalizationTableType", "documentation":"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.
" }, "PinValidationDataPadCharacter":{ "shape":"HexLengthEquals1", "documentation":"The padding character for validation data.
" }, "PinValidationData":{ "shape":"PinValidationDataType", "documentation":"The unique data for cardholder identification.
" }, "PinOffset":{ "shape":"PinOffsetType", "documentation":"The PIN offset value.
" } }, "documentation":"Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
" }, "Ibm3624PinOffset":{ "type":"structure", "required":[ "EncryptedPinBlock", "DecimalizationTable", "PinValidationDataPadCharacter", "PinValidationData" ], "members":{ "EncryptedPinBlock":{ "shape":"EncryptedPinBlockType", "documentation":"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).
" }, "DecimalizationTable":{ "shape":"DecimalizationTableType", "documentation":"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.
" }, "PinValidationDataPadCharacter":{ "shape":"HexLengthEquals1", "documentation":"The padding character for validation data.
" }, "PinValidationData":{ "shape":"PinValidationDataType", "documentation":"The unique data for cardholder identification.
" } }, "documentation":"Pparameters that are required to generate or verify Ibm3624 PIN offset PIN.
" }, "Ibm3624PinVerification":{ "type":"structure", "required":[ "DecimalizationTable", "PinValidationDataPadCharacter", "PinValidationData", "PinOffset" ], "members":{ "DecimalizationTable":{ "shape":"DecimalizationTableType", "documentation":"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.
" }, "PinValidationDataPadCharacter":{ "shape":"HexLengthEquals1", "documentation":"The padding character for validation data.
" }, "PinValidationData":{ "shape":"PinValidationDataType", "documentation":"The unique data for cardholder identification.
" }, "PinOffset":{ "shape":"PinOffsetType", "documentation":"The PIN offset value.
" } }, "documentation":"Parameters that are required to generate or verify Ibm3624 PIN verification PIN.
" }, "Ibm3624RandomPin":{ "type":"structure", "required":[ "DecimalizationTable", "PinValidationDataPadCharacter", "PinValidationData" ], "members":{ "DecimalizationTable":{ "shape":"DecimalizationTableType", "documentation":"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.
" }, "PinValidationDataPadCharacter":{ "shape":"HexLengthEquals1", "documentation":"The padding character for validation data.
" }, "PinValidationData":{ "shape":"PinValidationDataType", "documentation":"The unique data for cardholder identification.
" } }, "documentation":"Parameters that are required to generate or verify Ibm3624 random PIN.
" }, "IncomingDiffieHellmanTr31KeyBlock":{ "type":"structure", "required":[ "PrivateKeyIdentifier", "CertificateAuthorityPublicKeyIdentifier", "PublicKeyCertificate", "DeriveKeyAlgorithm", "KeyDerivationFunction", "KeyDerivationHashAlgorithm", "DerivationData", "WrappedKeyBlock" ], "members":{ "PrivateKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the asymmetric ECC key pair.
The keyArn of the certificate that signed the client's PublicKeyCertificate.
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
" }, "DeriveKeyAlgorithm":{ "shape":"SymmetricKeyAlgorithm", "documentation":"The key algorithm of the derived ECDH key.
" }, "KeyDerivationFunction":{ "shape":"KeyDerivationFunction", "documentation":"The key derivation function to use for deriving a key using ECDH.
" }, "KeyDerivationHashAlgorithm":{ "shape":"KeyDerivationHashAlgorithm", "documentation":"The hash type to use for deriving a key using ECDH.
" }, "DerivationData":{"shape":"DiffieHellmanDerivationData"}, "WrappedKeyBlock":{ "shape":"Tr31WrappedKeyBlock", "documentation":"The WrappedKeyBlock containing the transaction key wrapped using an ECDH dervied key.
" } }, "documentation":"Parameter information of a TR31KeyBlock wrapped using an ECDH derived key.
" }, "IncomingKeyMaterial":{ "type":"structure", "members":{ "DiffieHellmanTr31KeyBlock":{ "shape":"IncomingDiffieHellmanTr31KeyBlock", "documentation":"Parameter information of the TR31WrappedKeyBlock containing the transaction key wrapped using an ECDH dervied key.
" } }, "documentation":"Parameter information of the incoming WrappedKeyBlock containing the transaction key.
", "union":true }, "InitializationVectorType":{ "type":"string", "max":32, "min":16, "pattern":"(?:[0-9a-fA-F]{16}|[0-9a-fA-F]{32})", "sensitive":true }, "IntegerRangeBetween0And6":{ "type":"integer", "box":true, "max":6, "min":0 }, "IntegerRangeBetween3And5Type":{ "type":"integer", "box":true, "max":5, "min":3 }, "IntegerRangeBetween4And12":{ "type":"integer", "box":true, "max":12, "min":4 }, "IntegerRangeBetween4And16":{ "type":"integer", "box":true, "max":16, "min":4 }, "InternalServerException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The request processing has failed because of an unknown error, exception, or failure.
", "error":{"httpStatusCode":500}, "exception":true, "fault":true }, "KekValidationRequest":{ "type":"structure", "required":["DeriveKeyAlgorithm"], "members":{ "DeriveKeyAlgorithm":{ "shape":"SymmetricKeyAlgorithm", "documentation":"The key derivation algorithm to use for generating a KEK validation request.
" } }, "documentation":"Parameter information for generating a KEK validation request during node-to-node initialization.
" }, "KekValidationResponse":{ "type":"structure", "required":["RandomKeySend"], "members":{ "RandomKeySend":{ "shape":"As2805RandomKeyMaterial", "documentation":"The random key for generating a KEK validation response.
" } }, "documentation":"Parameter information for generating a KEK validation response during node-to-node initialization.
" }, "KeyArn":{ "type":"string", "max":150, "min":70, "pattern":"arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}" }, "KeyArnOrKeyAliasType":{ "type":"string", "max":322, "min":7, "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/_-]+" }, "KeyCheckValue":{ "type":"string", "max":16, "min":4, "pattern":"[0-9a-fA-F]+" }, "KeyCheckValueAlgorithm":{ "type":"string", "enum":[ "CMAC", "ANSI_X9_24", "HMAC", "SHA_1" ] }, "KeyDerivationFunction":{ "type":"string", "enum":[ "NIST_SP800", "ANSI_X963" ] }, "KeyDerivationHashAlgorithm":{ "type":"string", "enum":[ "SHA_256", "SHA_384", "SHA_512" ] }, "KeyMaterial":{ "type":"string", "max":16384, "min":32, "sensitive":true }, "MacAlgorithm":{ "type":"string", "enum":[ "ISO9797_ALGORITHM1", "ISO9797_ALGORITHM3", "CMAC", "HMAC", "HMAC_SHA224", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "AS2805_4_1" ] }, "MacAlgorithmDukpt":{ "type":"structure", "required":[ "KeySerialNumber", "DukptKeyVariant" ], "members":{ "KeySerialNumber":{ "shape":"HexLength16Or20Or24", "documentation":"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.
" }, "DukptKeyVariant":{ "shape":"DukptKeyVariant", "documentation":"The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
" }, "DukptDerivationType":{ "shape":"DukptDerivationType", "documentation":"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 AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.
Parameters required for DUKPT MAC generation and verification.
" }, "MacAlgorithmEmv":{ "type":"structure", "required":[ "MajorKeyDerivationMode", "PrimaryAccountNumber", "PanSequenceNumber", "SessionKeyDerivationMode", "SessionKeyDerivationValue" ], "members":{ "MajorKeyDerivationMode":{ "shape":"MajorKeyDerivationMode", "documentation":"The method to use when deriving the master key for EMV MAC generation or verification.
" }, "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, "SessionKeyDerivationMode":{ "shape":"SessionKeyDerivationMode", "documentation":"The method of deriving a session key for EMV MAC generation or verification.
" }, "SessionKeyDerivationValue":{ "shape":"SessionKeyDerivationValue", "documentation":"Parameters that are required to generate session key for EMV generation and verification.
" } }, "documentation":"Parameters that are required for EMV MAC generation and verification.
" }, "MacAttributes":{ "type":"structure", "members":{ "Algorithm":{ "shape":"MacAlgorithm", "documentation":"The encryption algorithm for MAC generation or verification.
" }, "EmvMac":{ "shape":"MacAlgorithmEmv", "documentation":"Parameters that are required for MAC generation or verification using EMV MAC algorithm.
" }, "DukptIso9797Algorithm1":{ "shape":"MacAlgorithmDukpt", "documentation":"Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
" }, "DukptIso9797Algorithm3":{ "shape":"MacAlgorithmDukpt", "documentation":"Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.
" }, "DukptCmac":{ "shape":"MacAlgorithmDukpt", "documentation":"Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
" } }, "documentation":"Parameters that are required for DUKPT, HMAC, or EMV MAC generation or verification.
", "union":true }, "MacOutputType":{ "type":"string", "max":128, "min":4, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "MacType":{ "type":"string", "max":128, "min":4, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "MajorKeyDerivationMode":{ "type":"string", "enum":[ "EMV_OPTION_A", "EMV_OPTION_B" ] }, "MasterCardAttributes":{ "type":"structure", "required":[ "MajorKeyDerivationMode", "PrimaryAccountNumber", "PanSequenceNumber", "ApplicationCryptogram" ], "members":{ "MajorKeyDerivationMode":{ "shape":"MajorKeyDerivationMode", "documentation":"The method to use when deriving the master key for the payment card.
" }, "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"The Primary Account Number (PAN) of the cardholder.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.
" }, "ApplicationCryptogram":{ "shape":"ApplicationCryptogramType", "documentation":"The application cryptogram for the current transaction that is provided by the terminal during transaction processing.
" } }, "documentation":"Parameters to derive the confidentiality and integrity keys for a Mastercard payment card.
" }, "MessageDataType":{ "type":"string", "max":8192, "min":2, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "NumberLengthEquals2":{ "type":"string", "max":2, "min":2, "pattern":"[0-9]+" }, "OutgoingKeyMaterial":{ "type":"structure", "members":{ "Tr31KeyBlock":{ "shape":"OutgoingTr31KeyBlock", "documentation":"Parameter information of the TR31WrappedKeyBlock containing the transaction key wrapped using a KEK.
" } }, "documentation":"Parameter information of the outgoing TR31WrappedKeyBlock containing the transaction key.
", "union":true }, "OutgoingTr31KeyBlock":{ "type":"structure", "required":["WrappingKeyIdentifier"], "members":{ "WrappingKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the KEK used to wrap the transaction key.
Parameter information of the TR31WrappedKeyBlock containing the transaction key wrapped using a KEK.
" }, "PaddingType":{ "type":"string", "enum":[ "PKCS1", "OAEP_SHA1", "OAEP_SHA256", "OAEP_SHA512" ] }, "PinBlockFormatForEmvPinChange":{ "type":"string", "enum":[ "ISO_FORMAT_0", "ISO_FORMAT_1", "ISO_FORMAT_3" ] }, "PinBlockFormatForPinData":{ "type":"string", "enum":[ "ISO_FORMAT_0", "ISO_FORMAT_1", "ISO_FORMAT_3", "ISO_FORMAT_4" ] }, "PinBlockLengthEquals16":{ "type":"string", "max":16, "min":16, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "PinBlockLengthPosition":{ "type":"string", "enum":[ "NONE", "FRONT_OF_PIN_BLOCK" ] }, "PinBlockPaddingType":{ "type":"string", "enum":[ "NO_PADDING", "ISO_IEC_7816_4" ] }, "PinChangeMacOutputType":{ "type":"string", "max":16, "min":8, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "PinData":{ "type":"structure", "members":{ "PinOffset":{ "shape":"PinOffsetType", "documentation":"The PIN offset value.
" }, "VerificationValue":{ "shape":"VerificationValueType", "documentation":"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.
" } }, "documentation":"Parameters that are required to generate, translate, or verify PIN data.
", "union":true }, "PinGenerationAttributes":{ "type":"structure", "members":{ "VisaPin":{ "shape":"VisaPin", "documentation":"Parameters that are required to generate or verify Visa PIN.
" }, "VisaPinVerificationValue":{ "shape":"VisaPinVerificationValue", "documentation":"Parameters that are required to generate or verify Visa PIN Verification Value (PVV).
" }, "Ibm3624PinOffset":{ "shape":"Ibm3624PinOffset", "documentation":"Parameters that are required to generate or verify Ibm3624 PIN offset PIN.
" }, "Ibm3624NaturalPin":{ "shape":"Ibm3624NaturalPin", "documentation":"Parameters that are required to generate or verify Ibm3624 natural PIN.
" }, "Ibm3624RandomPin":{ "shape":"Ibm3624RandomPin", "documentation":"Parameters that are required to generate or verify Ibm3624 random PIN.
" }, "Ibm3624PinFromOffset":{ "shape":"Ibm3624PinFromOffset", "documentation":"Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
" } }, "documentation":"Parameters that are required for PIN data generation.
", "union":true }, "PinOffsetType":{ "type":"string", "max":12, "min":4, "pattern":"[0-9]+", "sensitive":true }, "PinValidationDataType":{ "type":"string", "max":16, "min":4, "pattern":"[0-9]+", "sensitive":true }, "PinVerificationAttributes":{ "type":"structure", "members":{ "VisaPin":{ "shape":"VisaPinVerification", "documentation":"Parameters that are required to generate or verify Visa PIN.
" }, "Ibm3624Pin":{ "shape":"Ibm3624PinVerification", "documentation":"Parameters that are required to generate or verify Ibm3624 PIN.
" } }, "documentation":"Parameters that are required for PIN data verification.
", "union":true }, "PlainTextOutputType":{ "type":"string", "max":4224, "min":2, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "PlainTextType":{ "type":"string", "max":4096, "min":2, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+", "sensitive":true }, "PrimaryAccountNumberType":{ "type":"string", "max":19, "min":12, "pattern":"[0-9]+", "sensitive":true }, "ProprietaryAuthenticationDataType":{ "type":"string", "max":16, "min":1, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "RandomKeySendVariantMask":{ "type":"string", "enum":[ "VARIANT_MASK_82C0", "VARIANT_MASK_82" ] }, "ReEncryptDataInput":{ "type":"structure", "required":[ "IncomingKeyIdentifier", "OutgoingKeyIdentifier", "CipherText", "IncomingEncryptionAttributes", "OutgoingEncryptionAttributes" ], "members":{ "IncomingKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the encryption key of incoming ciphertext data.
When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key. Otherwise, it is the key identifier used to perform the operation.
", "location":"uri", "locationName":"IncomingKeyIdentifier" }, "OutgoingKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.
" }, "IncomingEncryptionAttributes":{ "shape":"ReEncryptionAttributes", "documentation":"The attributes and values for incoming ciphertext.
" }, "OutgoingEncryptionAttributes":{ "shape":"ReEncryptionAttributes", "documentation":"The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
" }, "IncomingWrappedKey":{ "shape":"WrappedKey", "documentation":"The WrappedKeyBlock containing the encryption key of incoming ciphertext data.
" }, "OutgoingWrappedKey":{ "shape":"WrappedKey", "documentation":"The WrappedKeyBlock containing the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
" } } }, "ReEncryptDataOutput":{ "type":"structure", "required":[ "KeyArn", "KeyCheckValue", "CipherText" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN (Amazon Resource Name) of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
" }, "KeyCheckValue":{ "shape":"KeyCheckValue", "documentation":"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 computes the KCV according to the CMAC specification.
" }, "CipherText":{ "shape":"CipherTextType", "documentation":"The encrypted ciphertext.
" } } }, "ReEncryptionAttributes":{ "type":"structure", "members":{ "Symmetric":{ "shape":"SymmetricEncryptionAttributes", "documentation":"Parameters that are required to encrypt data using symmetric keys.
" }, "Dukpt":{"shape":"DukptEncryptionAttributes"} }, "documentation":"Parameters that are required to perform reencryption operation.
", "union":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "ResourceId":{ "shape":"String", "documentation":"The resource that is missing.
" } }, "documentation":"The request was denied due to an invalid resource error.
", "error":{ "httpStatusCode":404, "senderFault":true }, "exception":true }, "ServiceCodeType":{ "type":"string", "max":3, "min":3, "pattern":"[0-9]+", "sensitive":true }, "SessionDerivationDataType":{ "type":"string", "max":16, "min":16, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "SessionKeyAmex":{ "type":"structure", "required":[ "PrimaryAccountNumber", "PanSequenceNumber" ], "members":{ "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"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.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" } }, "documentation":"Parameters to derive session key for an Amex payment card.
" }, "SessionKeyDerivation":{ "type":"structure", "members":{ "EmvCommon":{ "shape":"SessionKeyEmvCommon", "documentation":"Parameters to derive session key for an Emv common payment card for ARQC verification.
" }, "Mastercard":{ "shape":"SessionKeyMastercard", "documentation":"Parameters to derive session key for a Mastercard payment card for ARQC verification.
" }, "Emv2000":{ "shape":"SessionKeyEmv2000", "documentation":"Parameters to derive session key for an Emv2000 payment card for ARQC verification.
" }, "Amex":{ "shape":"SessionKeyAmex", "documentation":"Parameters to derive session key for an Amex payment card for ARQC verification.
" }, "Visa":{ "shape":"SessionKeyVisa", "documentation":"Parameters to derive session key for a Visa payment cardfor ARQC verification.
" } }, "documentation":"Parameters to derive a session key for Authorization Response Cryptogram (ARQC) verification.
", "union":true }, "SessionKeyDerivationMode":{ "type":"string", "enum":[ "EMV_COMMON_SESSION_KEY", "EMV2000", "AMEX", "MASTERCARD_SESSION_KEY", "VISA" ] }, "SessionKeyDerivationValue":{ "type":"structure", "members":{ "ApplicationCryptogram":{ "shape":"ApplicationCryptogramType", "documentation":"The cryptogram provided by the terminal during transaction processing.
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthEquals4", "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" } }, "documentation":"Parameters to derive session key value using a MAC EMV algorithm.
", "union":true }, "SessionKeyEmv2000":{ "type":"structure", "required":[ "PrimaryAccountNumber", "PanSequenceNumber", "ApplicationTransactionCounter" ], "members":{ "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"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.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthEquals4", "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" } }, "documentation":"Parameters to derive session key for an Emv2000 payment card for ARQC verification.
" }, "SessionKeyEmvCommon":{ "type":"structure", "required":[ "PrimaryAccountNumber", "PanSequenceNumber", "ApplicationTransactionCounter" ], "members":{ "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"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.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthEquals4", "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" } }, "documentation":"Parameters to derive session key for an Emv common payment card for ARQC verification.
" }, "SessionKeyMastercard":{ "type":"structure", "required":[ "PrimaryAccountNumber", "PanSequenceNumber", "ApplicationTransactionCounter", "UnpredictableNumber" ], "members":{ "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"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.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthEquals4", "documentation":"The transaction counter that is provided by the terminal during transaction processing.
" }, "UnpredictableNumber":{ "shape":"HexLengthBetween2And8", "documentation":"A random number generated by the issuer.
" } }, "documentation":"Parameters to derive session key for Mastercard payment card for ARQC verification.
" }, "SessionKeyVisa":{ "type":"structure", "required":[ "PrimaryAccountNumber", "PanSequenceNumber" ], "members":{ "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"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.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
" } }, "documentation":"Parameters to derive session key for Visa payment card for ARQC verification.
" }, "SharedInformation":{ "type":"string", "max":2048, "min":2, "pattern":"(?:[0-9a-fA-F][0-9a-fA-F])+" }, "String":{"type":"string"}, "SymmetricEncryptionAttributes":{ "type":"structure", "required":["Mode"], "members":{ "Mode":{ "shape":"EncryptionMode", "documentation":"The block cipher method to use for encryption.
" }, "InitializationVector":{ "shape":"InitializationVectorType", "documentation":"An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.
" }, "PaddingType":{ "shape":"PaddingType", "documentation":"The padding to be included with the data.
" } }, "documentation":"Parameters requried to encrypt plaintext data using symmetric keys.
" }, "SymmetricKeyAlgorithm":{ "type":"string", "enum":[ "TDES_2KEY", "TDES_3KEY", "AES_128", "AES_192", "AES_256", "HMAC_SHA256", "HMAC_SHA384", "HMAC_SHA512", "HMAC_SHA224" ] }, "SystemTraceAuditNumberType":{ "type":"string", "max":6, "min":6, "pattern":"[0-9]+" }, "ThrottlingException":{ "type":"structure", "members":{ "Message":{"shape":"String"} }, "documentation":"The request was denied due to request throttling.
", "error":{ "httpStatusCode":429, "senderFault":true }, "exception":true }, "Tr31WrappedKeyBlock":{ "type":"string", "max":9984, "min":56, "pattern":"[0-9a-zA-Z]+", "sensitive":true }, "TrackDataType":{ "type":"string", "max":160, "min":2, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "TransactionAmountType":{ "type":"string", "max":12, "min":12, "pattern":"[0-9]+" }, "TransactionDataType":{ "type":"string", "max":1024, "min":2, "pattern":"[0-9a-fA-F]+", "sensitive":true }, "TranslateKeyMaterialInput":{ "type":"structure", "required":[ "IncomingKeyMaterial", "OutgoingKeyMaterial" ], "members":{ "IncomingKeyMaterial":{ "shape":"IncomingKeyMaterial", "documentation":"Parameter information of the TR31WrappedKeyBlock containing the transaction key.
" }, "OutgoingKeyMaterial":{ "shape":"OutgoingKeyMaterial", "documentation":"Parameter information of the wrapping key used to wrap the transaction key in the outgoing TR31WrappedKeyBlock.
" }, "KeyCheckValueAlgorithm":{ "shape":"KeyCheckValueAlgorithm", "documentation":"The key check value (KCV) algorithm used for calculating the KCV of the derived key.
" } } }, "TranslateKeyMaterialOutput":{ "type":"structure", "required":["WrappedKey"], "members":{ "WrappedKey":{ "shape":"WrappedWorkingKey", "documentation":"The outgoing KEK wrapped TR31WrappedKeyBlock.
" } } }, "TranslatePinDataInput":{ "type":"structure", "required":[ "IncomingKeyIdentifier", "OutgoingKeyIdentifier", "IncomingTranslationAttributes", "OutgoingTranslationAttributes", "EncryptedPinBlock" ], "members":{ "IncomingKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the encryption key under which incoming PIN block data is encrypted. This key type can be PEK or BDK.
For dynamic keys, it is the keyARN of KEK of the TR-31 wrapped PEK. For ECDH, it is the keyARN of the asymmetric ECC key.
The keyARN of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.
For ECDH, it is the keyARN of the asymmetric ECC key.
The format of the incoming PIN block data for translation within Amazon Web Services Payment Cryptography.
" }, "OutgoingTranslationAttributes":{ "shape":"TranslationIsoFormats", "documentation":"The format of the outgoing PIN block data after translation by Amazon Web Services Payment Cryptography.
" }, "EncryptedPinBlock":{ "shape":"HexEvenLengthBetween16And32", "documentation":"The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.
" }, "IncomingDukptAttributes":{ "shape":"DukptDerivationAttributes", "documentation":"The attributes and values to use for incoming DUKPT encryption key for PIN block translation.
" }, "OutgoingDukptAttributes":{ "shape":"DukptDerivationAttributes", "documentation":"The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.
" }, "IncomingWrappedKey":{ "shape":"WrappedKey", "documentation":"The WrappedKeyBlock containing the encryption key under which incoming PIN block data is encrypted.
" }, "OutgoingWrappedKey":{ "shape":"WrappedKey", "documentation":"The WrappedKeyBlock containing the encryption key for encrypting outgoing PIN block data.
" }, "IncomingAs2805Attributes":{ "shape":"As2805PekDerivationAttributes", "documentation":"The attributes and values to use for incoming AS2805 encryption key for PIN block translation.
" } } }, "TranslatePinDataOutput":{ "type":"structure", "required":[ "PinBlock", "KeyArn", "KeyCheckValue" ], "members":{ "PinBlock":{ "shape":"EncryptedPinBlockType", "documentation":"The outgoing encrypted PIN block data after translation.
" }, "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to encrypt outgoing PIN block data after translation.
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 computes the KCV according to the CMAC specification.
" } } }, "TranslationIsoFormats":{ "type":"structure", "members":{ "IsoFormat0":{ "shape":"TranslationPinDataIsoFormat034", "documentation":"Parameters that are required for ISO9564 PIN format 0 translation.
" }, "IsoFormat1":{ "shape":"TranslationPinDataIsoFormat1", "documentation":"Parameters that are required for ISO9564 PIN format 1 translation.
" }, "IsoFormat3":{ "shape":"TranslationPinDataIsoFormat034", "documentation":"Parameters that are required for ISO9564 PIN format 3 translation.
" }, "IsoFormat4":{ "shape":"TranslationPinDataIsoFormat034", "documentation":"Parameters that are required for ISO9564 PIN format 4 translation.
" }, "As2805Format0":{ "shape":"TranslationPinDataAs2805Format0", "documentation":"Parameters that are required for AS2805 PIN format 0 translation.
" } }, "documentation":"Parameters that are required for translation between ISO9564 PIN block formats 0,1,3,4.
", "union":true }, "TranslationPinDataAs2805Format0":{ "type":"structure", "required":["PrimaryAccountNumber"], "members":{ "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"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.
" } }, "documentation":"Parameters that are required for translation between AS2805 PIN format 0 translation.
" }, "TranslationPinDataIsoFormat034":{ "type":"structure", "required":["PrimaryAccountNumber"], "members":{ "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"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.
" } }, "documentation":"Parameters that are required for translation between ISO9564 PIN format 0,3,4 translation.
" }, "TranslationPinDataIsoFormat1":{ "type":"structure", "members":{}, "documentation":"Parameters that are required for ISO9564 PIN format 1 translation.
" }, "ValidationDataType":{ "type":"string", "max":5, "min":3, "pattern":"[0-9]+", "sensitive":true }, "ValidationException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"String"}, "fieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"The request was denied due to an invalid request error.
" } }, "documentation":"The request was denied due to an invalid request error.
", "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "path", "message" ], "members":{ "path":{ "shape":"String", "documentation":"The request was denied due to an invalid request error.
" }, "message":{ "shape":"String", "documentation":"The request was denied due to an invalid request error.
" } }, "documentation":"The request was denied due to an invalid request error.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "VerificationFailedException":{ "type":"structure", "required":[ "Reason", "Message" ], "members":{ "Reason":{ "shape":"VerificationFailedReason", "documentation":"The reason for the exception.
" }, "Message":{"shape":"String"} }, "documentation":"This request failed verification.
", "error":{ "httpStatusCode":400, "senderFault":true }, "exception":true }, "VerificationFailedReason":{ "type":"string", "enum":[ "INVALID_MAC", "INVALID_PIN", "INVALID_VALIDATION_DATA", "INVALID_AUTH_REQUEST_CRYPTOGRAM" ] }, "VerificationValueType":{ "type":"string", "max":12, "min":4, "pattern":"[0-9]+", "sensitive":true }, "VerifyAuthRequestCryptogramInput":{ "type":"structure", "required":[ "KeyIdentifier", "TransactionData", "AuthRequestCryptogram", "MajorKeyDerivationMode", "SessionKeyDerivationAttributes" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
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.
" }, "AuthRequestCryptogram":{ "shape":"AuthRequestCryptogramType", "documentation":"The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.
" }, "MajorKeyDerivationMode":{ "shape":"MajorKeyDerivationMode", "documentation":"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.
" }, "SessionKeyDerivationAttributes":{ "shape":"SessionKeyDerivation", "documentation":"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.
" }, "AuthResponseAttributes":{ "shape":"CryptogramAuthResponse", "documentation":"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.
" } } }, "VerifyAuthRequestCryptogramOutput":{ "type":"structure", "required":[ "KeyArn", "KeyCheckValue" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
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 computes the KCV according to the CMAC specification.
" }, "AuthResponseValue":{ "shape":"AuthResponseValueType", "documentation":"The result for ARQC verification or ARPC generation within Amazon Web Services Payment Cryptography.
" } } }, "VerifyCardValidationDataInput":{ "type":"structure", "required":[ "KeyIdentifier", "PrimaryAccountNumber", "VerificationAttributes", "ValidationData" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify card data.
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" }, "VerificationAttributes":{ "shape":"CardVerificationAttributes", "documentation":"The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography.
" }, "ValidationData":{ "shape":"ValidationDataType", "documentation":"The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.
" } } }, "VerifyCardValidationDataOutput":{ "type":"structure", "required":[ "KeyArn", "KeyCheckValue" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify CVV or CSC.
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 computes the KCV according to the CMAC specification.
" } } }, "VerifyMacInput":{ "type":"structure", "required":[ "KeyIdentifier", "MessageData", "Mac", "VerificationAttributes" ], "members":{ "KeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.
The data on for which MAC is under verification. This value must be hexBinary.
" }, "Mac":{ "shape":"MacType", "documentation":"The MAC being verified.
" }, "VerificationAttributes":{ "shape":"MacAttributes", "documentation":"The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.
" }, "MacLength":{ "shape":"IntegerRangeBetween4And16", "documentation":"The length of the MAC.
" } } }, "VerifyMacOutput":{ "type":"structure", "required":[ "KeyArn", "KeyCheckValue" ], "members":{ "KeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC verification.
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 computes the KCV according to the CMAC specification.
" } } }, "VerifyPinDataInput":{ "type":"structure", "required":[ "VerificationKeyIdentifier", "EncryptionKeyIdentifier", "VerificationAttributes", "EncryptedPinBlock", "PinBlockFormat" ], "members":{ "VerificationKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyARN of the PIN verification key.
The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.
The attributes and values for PIN data verification.
" }, "EncryptedPinBlock":{ "shape":"EncryptedPinBlockType", "documentation":"The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.
" }, "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
" }, "PinBlockFormat":{ "shape":"PinBlockFormatForPinData", "documentation":"The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.
The ISO_Format_0 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.
The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.
The length of PIN being verified.
" }, "DukptAttributes":{ "shape":"DukptAttributes", "documentation":"The attributes and values for the DUKPT encrypted PIN block data.
" }, "EncryptionWrappedKey":{"shape":"WrappedKey"} } }, "VerifyPinDataOutput":{ "type":"structure", "required":[ "VerificationKeyArn", "VerificationKeyCheckValue", "EncryptionKeyArn", "EncryptionKeyCheckValue" ], "members":{ "VerificationKeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.
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 computes the KCV according to the CMAC specification.
" }, "EncryptionKeyArn":{ "shape":"KeyArn", "documentation":"The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
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 computes the KCV according to the CMAC specification.
" } } }, "VisaAmexDerivationOutputs":{ "type":"structure", "required":[ "AuthorizationRequestKeyArn", "AuthorizationRequestKeyCheckValue" ], "members":{ "AuthorizationRequestKeyArn":{ "shape":"KeyArn", "documentation":"The keyArn of the issuer master key for cryptogram (IMK-AC) used by the operation.
The key check value (KCV) of the issuer master key for cryptogram (IMK-AC) used by the operation.
" }, "CurrentPinPekArn":{ "shape":"KeyArn", "documentation":"The keyArn of the current PIN PEK.
The key check value (KCV) of the current PIN PEK.
" } }, "documentation":"The attributes values used for Amex and Visa derivation methods.
" }, "VisaAttributes":{ "type":"structure", "required":[ "MajorKeyDerivationMode", "PrimaryAccountNumber", "PanSequenceNumber", "ApplicationTransactionCounter", "AuthorizationRequestKeyIdentifier" ], "members":{ "MajorKeyDerivationMode":{ "shape":"MajorKeyDerivationMode", "documentation":"The method to use when deriving the master key for the payment card.
" }, "PrimaryAccountNumber":{ "shape":"PrimaryAccountNumberType", "documentation":"The Primary Account Number (PAN) of the cardholder.
" }, "PanSequenceNumber":{ "shape":"NumberLengthEquals2", "documentation":"A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). Typically 00 is used, if no value is provided by the terminal.
" }, "ApplicationTransactionCounter":{ "shape":"HexLengthEquals4", "documentation":"The transaction counter of the current transaction that is provided by the terminal during transaction processing.
" }, "AuthorizationRequestKeyIdentifier":{ "shape":"KeyArnOrKeyAliasType", "documentation":"The keyArn of the issuer master key for cryptogram (IMK-AC) for the payment card.
The encrypted pinblock of the old pin stored on the chip card.
" } }, "documentation":"Parameters to derive the confidentiality and integrity keys for a Visa payment card.
" }, "VisaPin":{ "type":"structure", "required":["PinVerificationKeyIndex"], "members":{ "PinVerificationKeyIndex":{ "shape":"IntegerRangeBetween0And6", "documentation":"The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
" } }, "documentation":"Parameters that are required to generate or verify Visa PIN.
" }, "VisaPinVerification":{ "type":"structure", "required":[ "PinVerificationKeyIndex", "VerificationValue" ], "members":{ "PinVerificationKeyIndex":{ "shape":"IntegerRangeBetween0And6", "documentation":"The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
" }, "VerificationValue":{ "shape":"VerificationValueType", "documentation":"Parameters that are required to generate or verify Visa PVV (PIN Verification Value).
" } }, "documentation":"Parameters that are required to generate or verify Visa PIN.
" }, "VisaPinVerificationValue":{ "type":"structure", "required":[ "EncryptedPinBlock", "PinVerificationKeyIndex" ], "members":{ "EncryptedPinBlock":{ "shape":"EncryptedPinBlockType", "documentation":"The encrypted PIN block data to verify.
" }, "PinVerificationKeyIndex":{ "shape":"IntegerRangeBetween0And6", "documentation":"The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
" } }, "documentation":"Parameters that are required to generate or verify Visa PVV (PIN Verification Value).
" }, "WrappedKey":{ "type":"structure", "required":["WrappedKeyMaterial"], "members":{ "WrappedKeyMaterial":{ "shape":"WrappedKeyMaterial", "documentation":"Parameter information of a WrappedKeyBlock for encryption key exchange.
" }, "KeyCheckValueAlgorithm":{ "shape":"KeyCheckValueAlgorithm", "documentation":"The algorithm that Amazon Web Services Payment Cryptography uses to calculate the key check value (KCV). It is used to validate the key integrity.
For TDES keys, the KCV is computed by encrypting 8 bytes, each with value of zero, with the key to be checked and retaining the 3 highest order bytes of the encrypted result. For AES keys, the KCV is computed using a CMAC algorithm where the input data is 16 bytes of zero and retaining the 3 highest order bytes of the encrypted result.
" } }, "documentation":"Parameter information of a WrappedKeyBlock for encryption key exchange.
" }, "WrappedKeyMaterial":{ "type":"structure", "members":{ "Tr31KeyBlock":{ "shape":"Tr31WrappedKeyBlock", "documentation":"The TR-31 wrapped key block.
" }, "DiffieHellmanSymmetricKey":{ "shape":"EcdhDerivationAttributes", "documentation":"The parameter information for deriving a ECDH shared key.
" } }, "documentation":"Parameter information of a WrappedKeyBlock for encryption key exchange.
", "union":true }, "WrappedKeyMaterialFormat":{ "type":"string", "enum":[ "KEY_CRYPTOGRAM", "TR31_KEY_BLOCK", "TR34_KEY_BLOCK" ] }, "WrappedWorkingKey":{ "type":"structure", "required":[ "WrappedKeyMaterial", "KeyCheckValue", "WrappedKeyMaterialFormat" ], "members":{ "WrappedKeyMaterial":{ "shape":"KeyMaterial", "documentation":"The wrapped key block of the outgoing transaction key.
" }, "KeyCheckValue":{ "shape":"KeyCheckValue", "documentation":"The key check value (KCV) of the key contained within the outgoing TR31WrappedKeyBlock.
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. For more information on KCV, see KCV in the Amazon Web Services Payment Cryptography User Guide.
" }, "WrappedKeyMaterialFormat":{ "shape":"WrappedKeyMaterialFormat", "documentation":"The key block format of the wrapped key.
" } }, "documentation":"The parameter information of the outgoing wrapped key block.
" } }, "documentation":"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 Data operations in the Amazon Web Services Payment Cryptography User Guide.
To manage your encryption keys, you use the Amazon Web Services Payment Cryptography Control Plane. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys.
" }