2025/10/03 - Payment Cryptography Data Plane - 1 new2 updated api methods
Changes Added a new API - translateKeyMaterial; allows keys wrapped by ECDH derived keys to be rewrapped under a static AES keyblock without first importing the key into the service.
Translates an encryption 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 Pin Encryption Key (PEK) generated for each transaction and wrapped with an ECDH (Elliptic Curve Diffie-Hellman) derived wrapping key to another KEK (Key Encryption Key) 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 more information on establishing ECDH derived keys, see the Creating 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:
See also: AWS API Documentation
Request Syntax
client.translate_key_material(
IncomingKeyMaterial={
'DiffieHellmanTr31KeyBlock': {
'PrivateKeyIdentifier': 'string',
'CertificateAuthorityPublicKeyIdentifier': 'string',
'PublicKeyCertificate': 'string',
'DeriveKeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224',
'KeyDerivationFunction': 'NIST_SP800'|'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256'|'SHA_384'|'SHA_512',
'DerivationData': {
'SharedInformation': 'string'
},
'WrappedKeyBlock': 'string'
}
},
OutgoingKeyMaterial={
'Tr31KeyBlock': {
'WrappingKeyIdentifier': 'string'
}
},
KeyCheckValueAlgorithm='CMAC'|'ANSI_X9_24'|'HMAC'|'SHA_1'
)
dict
[REQUIRED]
Parameter information of the TR31WrappedKeyBlock containing the transaction key.
DiffieHellmanTr31KeyBlock (dict) --
Parameter information of the TR31WrappedKeyBlock containing the transaction key wrapped using an ECDH dervied key.
PrivateKeyIdentifier (string) -- [REQUIRED]
The keyARN of the asymmetric ECC key pair.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
DeriveKeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
DerivationData (dict) -- [REQUIRED]
The shared information used when deriving a key using ECDH.
SharedInformation (string) --
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.
WrappedKeyBlock (string) -- [REQUIRED]
The WrappedKeyBlock containing the transaction key wrapped using an ECDH dervied key.
dict
[REQUIRED]
Parameter information of the wrapping key used to wrap the transaction key in the outgoing TR31WrappedKeyBlock.
Tr31KeyBlock (dict) --
Parameter information of the TR31WrappedKeyBlock containing the transaction key wrapped using a KEK.
WrappingKeyIdentifier (string) -- [REQUIRED]
The keyARN of the KEK used to wrap the transaction key.
string
The key check value (KCV) algorithm used for calculating the KCV.
dict
Response Syntax
{
'WrappedKey': {
'WrappedKeyMaterial': 'string',
'KeyCheckValue': 'string',
'WrappedKeyMaterialFormat': 'KEY_CRYPTOGRAM'|'TR31_KEY_BLOCK'|'TR34_KEY_BLOCK'
}
}
Response Structure
(dict) --
WrappedKey (dict) --
The outgoing KEK wrapped TR31WrappedKeyBlock.
WrappedKeyMaterial (string) --
The wrapped key block of the outgoing transaction key.
KeyCheckValue (string) --
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 (string) --
The key block format of the wrapped key.
{'PinBlockFormat': {'ISO_FORMAT_1'}}
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:
GenerateCardValidationData
TranslatePinData
VerifyPinData
See also: AWS API Documentation
Request Syntax
client.generate_pin_data(
GenerationKeyIdentifier='string',
EncryptionKeyIdentifier='string',
GenerationAttributes={
'VisaPin': {
'PinVerificationKeyIndex': 123
},
'VisaPinVerificationValue': {
'EncryptedPinBlock': 'string',
'PinVerificationKeyIndex': 123
},
'Ibm3624PinOffset': {
'EncryptedPinBlock': 'string',
'DecimalizationTable': 'string',
'PinValidationDataPadCharacter': 'string',
'PinValidationData': 'string'
},
'Ibm3624NaturalPin': {
'DecimalizationTable': 'string',
'PinValidationDataPadCharacter': 'string',
'PinValidationData': 'string'
},
'Ibm3624RandomPin': {
'DecimalizationTable': 'string',
'PinValidationDataPadCharacter': 'string',
'PinValidationData': 'string'
},
'Ibm3624PinFromOffset': {
'DecimalizationTable': 'string',
'PinValidationDataPadCharacter': 'string',
'PinValidationData': 'string',
'PinOffset': 'string'
}
},
PinDataLength=123,
PrimaryAccountNumber='string',
PinBlockFormat='ISO_FORMAT_0'|'ISO_FORMAT_1'|'ISO_FORMAT_3'|'ISO_FORMAT_4',
EncryptionWrappedKey={
'WrappedKeyMaterial': {
'Tr31KeyBlock': 'string',
'DiffieHellmanSymmetricKey': {
'CertificateAuthorityPublicKeyIdentifier': 'string',
'PublicKeyCertificate': 'string',
'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224',
'KeyDerivationFunction': 'NIST_SP800'|'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256'|'SHA_384'|'SHA_512',
'SharedInformation': 'string'
}
},
'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'|'HMAC'|'SHA_1'
}
)
string
[REQUIRED]
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
string
[REQUIRED]
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.
dict
[REQUIRED]
The attributes and values to use for PIN, PVV, or PIN Offset generation.
VisaPin (dict) --
Parameters that are required to generate or verify Visa PIN.
PinVerificationKeyIndex (integer) -- [REQUIRED]
The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
VisaPinVerificationValue (dict) --
Parameters that are required to generate or verify Visa PIN Verification Value (PVV).
EncryptedPinBlock (string) -- [REQUIRED]
The encrypted PIN block data to verify.
PinVerificationKeyIndex (integer) -- [REQUIRED]
The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
Ibm3624PinOffset (dict) --
Parameters that are required to generate or verify Ibm3624 PIN offset PIN.
EncryptedPinBlock (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
The padding character for validation data.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
Ibm3624NaturalPin (dict) --
Parameters that are required to generate or verify Ibm3624 natural PIN.
DecimalizationTable (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
The padding character for validation data.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
Ibm3624RandomPin (dict) --
Parameters that are required to generate or verify Ibm3624 random PIN.
DecimalizationTable (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
The padding character for validation data.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
Ibm3624PinFromOffset (dict) --
Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.
DecimalizationTable (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
The padding character for validation data.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
PinOffset (string) -- [REQUIRED]
The PIN offset value.
integer
The length of PIN under generation.
string
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
string
[REQUIRED]
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. It is similar to ISO_Format_3 but doubles the pin block length by padding with fill digit A and random values from 10 to 15.
dict
Parameter information of a WrappedKeyBlock for encryption key exchange.
WrappedKeyMaterial (dict) -- [REQUIRED]
Parameter information of a WrappedKeyBlock for encryption key exchange.
Tr31KeyBlock (string) --
The TR-31 wrapped key block.
DiffieHellmanSymmetricKey (dict) --
The parameter information for deriving a ECDH shared key.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
KeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
SharedInformation (string) -- [REQUIRED]
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.
KeyCheckValueAlgorithm (string) --
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.
dict
Response Syntax
{
'GenerationKeyArn': 'string',
'GenerationKeyCheckValue': 'string',
'EncryptionKeyArn': 'string',
'EncryptionKeyCheckValue': 'string',
'EncryptedPinBlock': 'string',
'PinData': {
'PinOffset': 'string',
'VerificationValue': 'string'
}
}
Response Structure
(dict) --
GenerationKeyArn (string) --
The keyARN of the pin data generation key that Amazon Web Services Payment Cryptography uses for PIN, PVV or PIN Offset generation.
GenerationKeyCheckValue (string) --
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 (string) --
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.
EncryptionKeyCheckValue (string) --
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 (string) --
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 (dict) --
The attributes and values Amazon Web Services Payment Cryptography uses for pin data generation.
PinOffset (string) --
The PIN offset value.
VerificationValue (string) --
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.
{'PinBlockFormat': {'ISO_FORMAT_1'}}
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:
GeneratePinData
TranslatePinData
See also: AWS API Documentation
Request Syntax
client.verify_pin_data(
VerificationKeyIdentifier='string',
EncryptionKeyIdentifier='string',
VerificationAttributes={
'VisaPin': {
'PinVerificationKeyIndex': 123,
'VerificationValue': 'string'
},
'Ibm3624Pin': {
'DecimalizationTable': 'string',
'PinValidationDataPadCharacter': 'string',
'PinValidationData': 'string',
'PinOffset': 'string'
}
},
EncryptedPinBlock='string',
PrimaryAccountNumber='string',
PinBlockFormat='ISO_FORMAT_0'|'ISO_FORMAT_1'|'ISO_FORMAT_3'|'ISO_FORMAT_4',
PinDataLength=123,
DukptAttributes={
'KeySerialNumber': 'string',
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'
},
EncryptionWrappedKey={
'WrappedKeyMaterial': {
'Tr31KeyBlock': 'string',
'DiffieHellmanSymmetricKey': {
'CertificateAuthorityPublicKeyIdentifier': 'string',
'PublicKeyCertificate': 'string',
'KeyAlgorithm': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512'|'HMAC_SHA224',
'KeyDerivationFunction': 'NIST_SP800'|'ANSI_X963',
'KeyDerivationHashAlgorithm': 'SHA_256'|'SHA_384'|'SHA_512',
'SharedInformation': 'string'
}
},
'KeyCheckValueAlgorithm': 'CMAC'|'ANSI_X9_24'|'HMAC'|'SHA_1'
}
)
string
[REQUIRED]
The keyARN of the PIN verification key.
string
[REQUIRED]
The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.
dict
[REQUIRED]
The attributes and values for PIN data verification.
VisaPin (dict) --
Parameters that are required to generate or verify Visa PIN.
PinVerificationKeyIndex (integer) -- [REQUIRED]
The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).
VerificationValue (string) -- [REQUIRED]
Parameters that are required to generate or verify Visa PVV (PIN Verification Value).
Ibm3624Pin (dict) --
Parameters that are required to generate or verify Ibm3624 PIN.
DecimalizationTable (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
The padding character for validation data.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
PinOffset (string) -- [REQUIRED]
The PIN offset value.
string
[REQUIRED]
The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.
string
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
string
[REQUIRED]
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.
integer
The length of PIN being verified.
dict
The attributes and values for the DUKPT encrypted PIN block data.
KeySerialNumber (string) -- [REQUIRED]
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 (string) -- [REQUIRED]
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.
dict
Parameter information of a WrappedKeyBlock for encryption key exchange.
WrappedKeyMaterial (dict) -- [REQUIRED]
Parameter information of a WrappedKeyBlock for encryption key exchange.
Tr31KeyBlock (string) --
The TR-31 wrapped key block.
DiffieHellmanSymmetricKey (dict) --
The parameter information for deriving a ECDH shared key.
CertificateAuthorityPublicKeyIdentifier (string) -- [REQUIRED]
The keyArn of the certificate that signed the client's PublicKeyCertificate.
PublicKeyCertificate (string) -- [REQUIRED]
The client's public key certificate in PEM format (base64 encoded) to use for ECDH key derivation.
KeyAlgorithm (string) -- [REQUIRED]
The key algorithm of the derived ECDH key.
KeyDerivationFunction (string) -- [REQUIRED]
The key derivation function to use for deriving a key using ECDH.
KeyDerivationHashAlgorithm (string) -- [REQUIRED]
The hash type to use for deriving a key using ECDH.
SharedInformation (string) -- [REQUIRED]
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.
KeyCheckValueAlgorithm (string) --
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.
dict
Response Syntax
{
'VerificationKeyArn': 'string',
'VerificationKeyCheckValue': 'string',
'EncryptionKeyArn': 'string',
'EncryptionKeyCheckValue': 'string'
}
Response Structure
(dict) --
VerificationKeyArn (string) --
The keyARN of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.
VerificationKeyCheckValue (string) --
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 (string) --
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.
EncryptionKeyCheckValue (string) --
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.