2023/06/08 - Payment Cryptography Data Plane - 11 new api methods
Changes Initial release of AWS Payment Cryptography DataPlane Plane service for performing cryptographic operations typically used during card payment processing.
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:
VerifyCardValidationData
See also: AWS API Documentation
Request Syntax
client.generate_card_validation_data(
GenerationAttributes={
'AmexCardSecurityCodeVersion1': {
'CardExpiryDate': 'string'
},
'AmexCardSecurityCodeVersion2': {
'CardExpiryDate': 'string',
'ServiceCode': 'string'
},
'CardHolderVerificationValue': {
'ApplicationTransactionCounter': 'string',
'PanSequenceNumber': 'string',
'UnpredictableNumber': 'string'
},
'CardVerificationValue1': {
'CardExpiryDate': 'string',
'ServiceCode': 'string'
},
'CardVerificationValue2': {
'CardExpiryDate': 'string'
},
'DynamicCardVerificationCode': {
'ApplicationTransactionCounter': 'string',
'PanSequenceNumber': 'string',
'TrackData': 'string',
'UnpredictableNumber': 'string'
},
'DynamicCardVerificationValue': {
'ApplicationTransactionCounter': 'string',
'CardExpiryDate': 'string',
'PanSequenceNumber': 'string',
'ServiceCode': 'string'
}
},
KeyIdentifier='string',
PrimaryAccountNumber='string',
ValidationDataLength=123
)
dict
[REQUIRED]
The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.
AmexCardSecurityCodeVersion1 (dict) --
Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
AmexCardSecurityCodeVersion2 (dict) --
Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
ServiceCode (string) -- [REQUIRED]
The service code of the AMEX payment card. This is different from the Card Security Code (CSC).
CardHolderVerificationValue (dict) --
Card data parameters that are required to generate a cardholder verification value for the payment card.
ApplicationTransactionCounter (string) -- [REQUIRED]
The transaction counter value that comes from a point of sale terminal.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
UnpredictableNumber (string) -- [REQUIRED]
A random number generated by the issuer.
CardVerificationValue1 (dict) --
Card data parameters that are required to generate Card Verification Value (CVV) for the payment card.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
ServiceCode (string) -- [REQUIRED]
The service code of the payment card. This is different from Card Security Code (CSC).
CardVerificationValue2 (dict) --
Card data parameters that are required to generate Card Verification Value (CVV2) for the payment card.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
DynamicCardVerificationCode (dict) --
Card data parameters that are required to generate CDynamic Card Verification Code (dCVC) for the payment card.
ApplicationTransactionCounter (string) -- [REQUIRED]
The transaction counter value that comes from the terminal.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
TrackData (string) -- [REQUIRED]
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.
UnpredictableNumber (string) -- [REQUIRED]
A random number generated by the issuer.
DynamicCardVerificationValue (dict) --
Card data parameters that are required to generate CDynamic Card Verification Value (dCVV) for the payment card.
ApplicationTransactionCounter (string) -- [REQUIRED]
The transaction counter value that comes from the terminal.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
ServiceCode (string) -- [REQUIRED]
The service code of the payment card. This is different from Card Security Code (CSC).
string
[REQUIRED]
The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.
string
[REQUIRED]
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
integer
The length of the CVV or CSC to be generated. The default value is 3.
dict
Response Syntax
{
'KeyArn': 'string',
'KeyCheckValue': 'string',
'ValidationData': 'string'
}
Response Structure
(dict) --
KeyArn (string) --
The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate CVV or CSC.
KeyCheckValue (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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
ValidationData (string) --
The CVV or CSC value that Amazon Web Services Payment Cryptography generates for the card.
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(
DukptAttributes={
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'KeySerialNumber': 'string'
},
EncryptedPinBlock='string',
EncryptionKeyIdentifier='string',
PinBlockFormat='ISO_FORMAT_0'|'ISO_FORMAT_3',
PinDataLength=123,
PrimaryAccountNumber='string',
VerificationAttributes={
'Ibm3624Pin': {
'DecimalizationTable': 'string',
'PinOffset': 'string',
'PinValidationData': 'string',
'PinValidationDataPadCharacter': 'string'
},
'VisaPin': {
'PinVerificationKeyIndex': 123,
'VerificationValue': 'string'
}
},
VerificationKeyIdentifier='string'
)
dict
The attributes and values for the DUKPT encrypted PIN block data.
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 .
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.
string
[REQUIRED]
The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.
string
[REQUIRED]
The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.
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.
string
[REQUIRED]
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
dict
[REQUIRED]
The attributes and values for PIN data verification.
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.
PinOffset (string) -- [REQUIRED]
The PIN offset value.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
PinValidationDataPadCharacter (string) -- [REQUIRED]
The padding character for validation data.
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).
string
[REQUIRED]
The keyARN of the PIN verification key.
dict
Response Syntax
{
'EncryptionKeyArn': 'string',
'EncryptionKeyCheckValue': 'string',
'VerificationKeyArn': 'string',
'VerificationKeyCheckValue': 'string'
}
Response Structure
(dict) --
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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
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 the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation type for DUKPT tranlations. You can use this operation for P2PE (Point to Point Encryption) use cases where the encryption keys should change but the processing system either does not need to, or is not permitted to, decrypt the data.
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 .
Note
At this time, Amazon Web Services Payment Cryptography does not support translations to PIN format 4.
Cross-account use : This operation can't be used across different Amazon Web Services accounts.
Related operations:
GeneratePinData
VerifyPinData
See also: AWS API Documentation
Request Syntax
client.translate_pin_data(
EncryptedPinBlock='string',
IncomingDukptAttributes={
'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'KeySerialNumber': 'string'
},
IncomingKeyIdentifier='string',
IncomingTranslationAttributes={
'IsoFormat0': {
'PrimaryAccountNumber': 'string'
},
'IsoFormat1': {}
,
'IsoFormat3': {
'PrimaryAccountNumber': 'string'
},
'IsoFormat4': {
'PrimaryAccountNumber': 'string'
}
},
OutgoingDukptAttributes={
'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'KeySerialNumber': 'string'
},
OutgoingKeyIdentifier='string',
OutgoingTranslationAttributes={
'IsoFormat0': {
'PrimaryAccountNumber': 'string'
},
'IsoFormat1': {}
,
'IsoFormat3': {
'PrimaryAccountNumber': 'string'
},
'IsoFormat4': {
'PrimaryAccountNumber': 'string'
}
}
)
string
[REQUIRED]
The encrypted PIN block data that Amazon Web Services Payment Cryptography translates.
dict
The attributes and values to use for incoming DUKPT encryption key for PIN block tranlation.
DukptKeyDerivationType (string) --
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
DukptKeyVariant (string) --
The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.
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.
string
[REQUIRED]
The keyARN of the encryption key under which incoming PIN block data is encrypted. This key type can be PEK or BDK.
dict
[REQUIRED]
The format of the incoming PIN block data for tranlation within Amazon Web Services Payment Cryptography.
IsoFormat0 (dict) --
Parameters that are required for ISO9564 PIN format 0 tranlation.
PrimaryAccountNumber (string) -- [REQUIRED]
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.
IsoFormat1 (dict) --
Parameters that are required for ISO9564 PIN format 1 tranlation.
IsoFormat3 (dict) --
Parameters that are required for ISO9564 PIN format 3 tranlation.
PrimaryAccountNumber (string) -- [REQUIRED]
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.
IsoFormat4 (dict) --
Parameters that are required for ISO9564 PIN format 4 tranlation.
PrimaryAccountNumber (string) -- [REQUIRED]
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.
dict
The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.
DukptKeyDerivationType (string) --
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
DukptKeyVariant (string) --
The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.
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.
string
[REQUIRED]
The keyARN of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.
dict
[REQUIRED]
The format of the outgoing PIN block data after tranlation by Amazon Web Services Payment Cryptography.
IsoFormat0 (dict) --
Parameters that are required for ISO9564 PIN format 0 tranlation.
PrimaryAccountNumber (string) -- [REQUIRED]
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.
IsoFormat1 (dict) --
Parameters that are required for ISO9564 PIN format 1 tranlation.
IsoFormat3 (dict) --
Parameters that are required for ISO9564 PIN format 3 tranlation.
PrimaryAccountNumber (string) -- [REQUIRED]
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.
IsoFormat4 (dict) --
Parameters that are required for ISO9564 PIN format 4 tranlation.
PrimaryAccountNumber (string) -- [REQUIRED]
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.
dict
Response Syntax
{
'KeyArn': 'string',
'KeyCheckValue': 'string',
'PinBlock': 'string'
}
Response Structure
(dict) --
KeyArn (string) --
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to encrypt outgoing PIN block data after translation.
KeyCheckValue (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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
PinBlock (string) --
The ougoing encrypted PIN block data after tranlation.
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.
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(
EncryptionKeyIdentifier='string',
GenerationAttributes={
'Ibm3624NaturalPin': {
'DecimalizationTable': 'string',
'PinValidationData': 'string',
'PinValidationDataPadCharacter': 'string'
},
'Ibm3624PinFromOffset': {
'DecimalizationTable': 'string',
'PinOffset': 'string',
'PinValidationData': 'string',
'PinValidationDataPadCharacter': 'string'
},
'Ibm3624PinOffset': {
'DecimalizationTable': 'string',
'EncryptedPinBlock': 'string',
'PinValidationData': 'string',
'PinValidationDataPadCharacter': 'string'
},
'Ibm3624RandomPin': {
'DecimalizationTable': 'string',
'PinValidationData': 'string',
'PinValidationDataPadCharacter': 'string'
},
'VisaPin': {
'PinVerificationKeyIndex': 123
},
'VisaPinVerificationValue': {
'EncryptedPinBlock': 'string',
'PinVerificationKeyIndex': 123
}
},
GenerationKeyIdentifier='string',
PinBlockFormat='ISO_FORMAT_0'|'ISO_FORMAT_3',
PinDataLength=123,
PrimaryAccountNumber='string'
)
string
[REQUIRED]
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.
dict
[REQUIRED]
The attributes and values to use for PIN, PVV, or PIN Offset generation.
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.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
PinValidationDataPadCharacter (string) -- [REQUIRED]
The padding character for validation data.
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.
PinOffset (string) -- [REQUIRED]
The PIN offset value.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
PinValidationDataPadCharacter (string) -- [REQUIRED]
The padding character for validation data.
Ibm3624PinOffset (dict) --
Parameters that are required to generate or verify Ibm3624 PIN 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.
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).
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
PinValidationDataPadCharacter (string) -- [REQUIRED]
The padding character for validation data.
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.
PinValidationData (string) -- [REQUIRED]
The unique data for cardholder identification.
PinValidationDataPadCharacter (string) -- [REQUIRED]
The padding character for validation data.
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).
string
[REQUIRED]
The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
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 under generation.
string
[REQUIRED]
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
dict
Response Syntax
{
'EncryptedPinBlock': 'string',
'EncryptionKeyArn': 'string',
'EncryptionKeyCheckValue': 'string',
'GenerationKeyArn': 'string',
'GenerationKeyCheckValue': 'string',
'PinData': {
'PinOffset': 'string',
'VerificationValue': 'string'
}
}
Response Structure
(dict) --
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.
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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
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.
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:
GenerateCardValidationData
VerifyAuthRequestCryptogram
VerifyPinData
See also: AWS API Documentation
Request Syntax
client.verify_card_validation_data(
KeyIdentifier='string',
PrimaryAccountNumber='string',
ValidationData='string',
VerificationAttributes={
'AmexCardSecurityCodeVersion1': {
'CardExpiryDate': 'string'
},
'AmexCardSecurityCodeVersion2': {
'CardExpiryDate': 'string',
'ServiceCode': 'string'
},
'CardHolderVerificationValue': {
'ApplicationTransactionCounter': 'string',
'PanSequenceNumber': 'string',
'UnpredictableNumber': 'string'
},
'CardVerificationValue1': {
'CardExpiryDate': 'string',
'ServiceCode': 'string'
},
'CardVerificationValue2': {
'CardExpiryDate': 'string'
},
'DiscoverDynamicCardVerificationCode': {
'ApplicationTransactionCounter': 'string',
'CardExpiryDate': 'string',
'UnpredictableNumber': 'string'
},
'DynamicCardVerificationCode': {
'ApplicationTransactionCounter': 'string',
'PanSequenceNumber': 'string',
'TrackData': 'string',
'UnpredictableNumber': 'string'
},
'DynamicCardVerificationValue': {
'ApplicationTransactionCounter': 'string',
'CardExpiryDate': 'string',
'PanSequenceNumber': 'string',
'ServiceCode': 'string'
}
}
)
string
[REQUIRED]
The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify card data.
string
[REQUIRED]
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 CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.
dict
[REQUIRED]
The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography.
AmexCardSecurityCodeVersion1 (dict) --
Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
AmexCardSecurityCodeVersion2 (dict) --
Card data parameters that are required to verify a Card Security Code (CSC2) for an AMEX payment card.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
ServiceCode (string) -- [REQUIRED]
The service code of the AMEX payment card. This is different from the Card Security Code (CSC).
CardHolderVerificationValue (dict) --
Card data parameters that are required to verify a cardholder verification value for the payment card.
ApplicationTransactionCounter (string) -- [REQUIRED]
The transaction counter value that comes from a point of sale terminal.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
UnpredictableNumber (string) -- [REQUIRED]
A random number generated by the issuer.
CardVerificationValue1 (dict) --
Card data parameters that are required to verify Card Verification Value (CVV) for the payment card.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
ServiceCode (string) -- [REQUIRED]
The service code of the payment card. This is different from Card Security Code (CSC).
CardVerificationValue2 (dict) --
Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
DiscoverDynamicCardVerificationCode (dict) --
Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.
ApplicationTransactionCounter (string) -- [REQUIRED]
The transaction counter value that comes from the terminal.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
UnpredictableNumber (string) -- [REQUIRED]
A random number that is generated by the issuer.
DynamicCardVerificationCode (dict) --
Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.
ApplicationTransactionCounter (string) -- [REQUIRED]
The transaction counter value that comes from the terminal.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
TrackData (string) -- [REQUIRED]
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.
UnpredictableNumber (string) -- [REQUIRED]
A random number generated by the issuer.
DynamicCardVerificationValue (dict) --
Card data parameters that are required to verify CDynamic Card Verification Value (dCVV) for the payment card.
ApplicationTransactionCounter (string) -- [REQUIRED]
The transaction counter value that comes from the terminal.
CardExpiryDate (string) -- [REQUIRED]
The expiry date of a payment card.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
ServiceCode (string) -- [REQUIRED]
The service code of the payment card. This is different from Card Security Code (CSC).
dict
Response Syntax
{
'KeyArn': 'string',
'KeyCheckValue': 'string'
}
Response Structure
(dict) --
KeyArn (string) --
The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify CVV or CSC.
KeyCheckValue (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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
Verifies a Message Authentication Code (MAC).
You can use this operation when keys won't be shared but mutual data is present on both ends for validation. In this case, known data values are used to generate a MAC on both ends for verification without sending or receiving data in ciphertext or plaintext. You can use this operation to verify a DUPKT, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. Use the same encryption key for MAC verification as you use for GenerateMac .
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
See also: AWS API Documentation
Request Syntax
client.verify_mac(
KeyIdentifier='string',
Mac='string',
MacLength=123,
MessageData='string',
VerificationAttributes={
'Algorithm': 'ISO9797_ALGORITHM1'|'ISO9797_ALGORITHM3'|'CMAC'|'HMAC_SHA224'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512',
'DukptCmac': {
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'KeySerialNumber': 'string'
},
'DukptIso9797Algorithm1': {
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'KeySerialNumber': 'string'
},
'DukptIso9797Algorithm3': {
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'KeySerialNumber': 'string'
},
'EmvMac': {
'MajorKeyDerivationMode': 'EMV_OPTION_A'|'EMV_OPTION_B',
'PanSequenceNumber': 'string',
'PrimaryAccountNumber': 'string',
'SessionKeyDerivationMode': 'EMV_COMMON_SESSION_KEY'|'EMV2000'|'AMEX'|'MASTERCARD_SESSION_KEY'|'VISA',
'SessionKeyDerivationValue': {
'ApplicationCryptogram': 'string',
'ApplicationTransactionCounter': 'string'
}
}
}
)
string
[REQUIRED]
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.
string
[REQUIRED]
The MAC being verified.
integer
The length of the MAC.
string
[REQUIRED]
The data on for which MAC is under verification.
dict
[REQUIRED]
The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.
Algorithm (string) --
The encryption algorithm for MAC generation or verification.
DukptCmac (dict) --
Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
DukptDerivationType (string) --
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 .
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
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.
DukptIso9797Algorithm1 (dict) --
Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
DukptDerivationType (string) --
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 .
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
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.
DukptIso9797Algorithm3 (dict) --
Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.
DukptDerivationType (string) --
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 .
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
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.
EmvMac (dict) --
Parameters that are required for MAC generation or verification using EMV MAC algorithm.
MajorKeyDerivationMode (string) -- [REQUIRED]
The method to use when deriving the master key for EMV MAC generation or verification.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
PrimaryAccountNumber (string) -- [REQUIRED]
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
SessionKeyDerivationMode (string) -- [REQUIRED]
The method of deriving a session key for EMV MAC generation or verification.
SessionKeyDerivationValue (dict) -- [REQUIRED]
Parameters that are required to generate session key for EMV generation and verification.
ApplicationCryptogram (string) --
The cryptogram provided by the terminal during transaction processing.
ApplicationTransactionCounter (string) --
The transaction counter that is provided by the terminal during transaction processing.
dict
Response Syntax
{
'KeyArn': 'string',
'KeyCheckValue': 'string'
}
Response Structure
(dict) --
KeyArn (string) --
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC verification.
KeyCheckValue (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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
Re-encrypt ciphertext using DUKPT, Symmetric and Asymmetric 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 . In asymmetric encryption, ciphertext is encrypted using public component (imported by calling ImportKey ) of the asymmetric key pair created outside of Amazon Web Services Payment Cryptography.
For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA . 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:
DecryptData
EncryptData
See also: AWS API Documentation
Request Syntax
client.re_encrypt_data(
CipherText='string',
IncomingEncryptionAttributes={
'Dukpt': {
'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'InitializationVector': 'string',
'KeySerialNumber': 'string',
'Mode': 'ECB'|'CBC'
},
'Symmetric': {
'InitializationVector': 'string',
'Mode': 'ECB'|'CBC'|'CFB'|'CFB1'|'CFB8'|'CFB64'|'CFB128'|'OFB',
'PaddingType': 'PKCS1'|'OAEP_SHA1'|'OAEP_SHA256'|'OAEP_SHA512'
}
},
IncomingKeyIdentifier='string',
OutgoingEncryptionAttributes={
'Dukpt': {
'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'InitializationVector': 'string',
'KeySerialNumber': 'string',
'Mode': 'ECB'|'CBC'
},
'Symmetric': {
'InitializationVector': 'string',
'Mode': 'ECB'|'CBC'|'CFB'|'CFB1'|'CFB8'|'CFB64'|'CFB128'|'OFB',
'PaddingType': 'PKCS1'|'OAEP_SHA1'|'OAEP_SHA256'|'OAEP_SHA512'
}
},
OutgoingKeyIdentifier='string'
)
string
[REQUIRED]
Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.
dict
[REQUIRED]
The attributes and values for incoming ciphertext.
Dukpt (dict) --
Parameters that are required to encrypt plaintext data using DUKPT.
DukptKeyDerivationType (string) --
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
DukptKeyVariant (string) --
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
InitializationVector (string) --
An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
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.
Mode (string) --
The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
The default is CBC.
Symmetric (dict) --
Parameters that are required to encrypt data using symmetric keys.
InitializationVector (string) --
An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.
Mode (string) -- [REQUIRED]
The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
PaddingType (string) --
The padding to be included with the data.
string
[REQUIRED]
The keyARN of the encryption key of incoming ciphertext data.
dict
[REQUIRED]
The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
Dukpt (dict) --
Parameters that are required to encrypt plaintext data using DUKPT.
DukptKeyDerivationType (string) --
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
DukptKeyVariant (string) --
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
InitializationVector (string) --
An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
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.
Mode (string) --
The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
The default is CBC.
Symmetric (dict) --
Parameters that are required to encrypt data using symmetric keys.
InitializationVector (string) --
An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.
Mode (string) -- [REQUIRED]
The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
PaddingType (string) --
The padding to be included with the data.
string
[REQUIRED]
The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.
dict
Response Syntax
{
'CipherText': 'string',
'KeyArn': 'string',
'KeyCheckValue': 'string'
}
Response Structure
(dict) --
CipherText (string) --
The encrypted ciphertext.
KeyArn (string) --
The keyARN (Amazon Resource Name) of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
KeyCheckValue (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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
Decrypts ciphertext data to plaintext using symmetric, asymmetric, or DUKPT data encryption key. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide .
You can use an encryption key generated within Amazon Web Services Payment Cryptography, or you can import your own encryption 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 .
For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA . When you use DUKPT, for TDES algorithm, the ciphertext data length must be a multiple of 16 bytes. For AES algorithm, the ciphertext data length must be a multiple of 32 bytes.
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
See also: AWS API Documentation
Request Syntax
client.decrypt_data(
CipherText='string',
DecryptionAttributes={
'Asymmetric': {
'PaddingType': 'PKCS1'|'OAEP_SHA1'|'OAEP_SHA256'|'OAEP_SHA512'
},
'Dukpt': {
'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'InitializationVector': 'string',
'KeySerialNumber': 'string',
'Mode': 'ECB'|'CBC'
},
'Symmetric': {
'InitializationVector': 'string',
'Mode': 'ECB'|'CBC'|'CFB'|'CFB1'|'CFB8'|'CFB64'|'CFB128'|'OFB',
'PaddingType': 'PKCS1'|'OAEP_SHA1'|'OAEP_SHA256'|'OAEP_SHA512'
}
},
KeyIdentifier='string'
)
string
[REQUIRED]
The ciphertext to decrypt.
dict
[REQUIRED]
The encryption key type and attributes for ciphertext decryption.
Asymmetric (dict) --
Parameters for plaintext encryption using asymmetric keys.
PaddingType (string) --
The padding to be included with the data.
Dukpt (dict) --
Parameters that are required to encrypt plaintext data using DUKPT.
DukptKeyDerivationType (string) --
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
DukptKeyVariant (string) --
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
InitializationVector (string) --
An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
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.
Mode (string) --
The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
The default is CBC.
Symmetric (dict) --
Parameters that are required to perform encryption and decryption using symmetric keys.
InitializationVector (string) --
An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.
Mode (string) -- [REQUIRED]
The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
PaddingType (string) --
The padding to be included with the data.
string
[REQUIRED]
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.
dict
Response Syntax
{
'KeyArn': 'string',
'KeyCheckValue': 'string',
'PlainText': 'string'
}
Response Structure
(dict) --
KeyArn (string) --
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for ciphertext decryption.
KeyCheckValue (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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
PlainText (string) --
The decrypted plaintext data.
Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.
You can use this operation when keys won't be shared but mutual data is present on both ends for validation. In this case, known data values are used to generate a MAC on both ends for comparision without sending or receiving data in ciphertext or plaintext. You can use this operation to generate a DUPKT, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC generation, and they key must have KeyModesOfUse set to Generate and Verify .
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
See also: AWS API Documentation
Request Syntax
client.generate_mac(
GenerationAttributes={
'Algorithm': 'ISO9797_ALGORITHM1'|'ISO9797_ALGORITHM3'|'CMAC'|'HMAC_SHA224'|'HMAC_SHA256'|'HMAC_SHA384'|'HMAC_SHA512',
'DukptCmac': {
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'KeySerialNumber': 'string'
},
'DukptIso9797Algorithm1': {
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'KeySerialNumber': 'string'
},
'DukptIso9797Algorithm3': {
'DukptDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'KeySerialNumber': 'string'
},
'EmvMac': {
'MajorKeyDerivationMode': 'EMV_OPTION_A'|'EMV_OPTION_B',
'PanSequenceNumber': 'string',
'PrimaryAccountNumber': 'string',
'SessionKeyDerivationMode': 'EMV_COMMON_SESSION_KEY'|'EMV2000'|'AMEX'|'MASTERCARD_SESSION_KEY'|'VISA',
'SessionKeyDerivationValue': {
'ApplicationCryptogram': 'string',
'ApplicationTransactionCounter': 'string'
}
}
},
KeyIdentifier='string',
MacLength=123,
MessageData='string'
)
dict
[REQUIRED]
The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.
Algorithm (string) --
The encryption algorithm for MAC generation or verification.
DukptCmac (dict) --
Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.
DukptDerivationType (string) --
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 .
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
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.
DukptIso9797Algorithm1 (dict) --
Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.
DukptDerivationType (string) --
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 .
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
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.
DukptIso9797Algorithm3 (dict) --
Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm2.
DukptDerivationType (string) --
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 .
DukptKeyVariant (string) -- [REQUIRED]
The type of use of DUKPT, which can be MAC generation, MAC verification, or both.
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.
EmvMac (dict) --
Parameters that are required for MAC generation or verification using EMV MAC algorithm.
MajorKeyDerivationMode (string) -- [REQUIRED]
The method to use when deriving the master key for EMV MAC generation or verification.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
PrimaryAccountNumber (string) -- [REQUIRED]
The Primary Account Number (PAN), a unique identifier for a payment credit or debit card and associates the card to a specific account holder.
SessionKeyDerivationMode (string) -- [REQUIRED]
The method of deriving a session key for EMV MAC generation or verification.
SessionKeyDerivationValue (dict) -- [REQUIRED]
Parameters that are required to generate session key for EMV generation and verification.
ApplicationCryptogram (string) --
The cryptogram provided by the terminal during transaction processing.
ApplicationTransactionCounter (string) --
The transaction counter that is provided by the terminal during transaction processing.
string
[REQUIRED]
The keyARN of the MAC generation encryption key.
integer
The length of a MAC under generation.
string
[REQUIRED]
The data for which a MAC is under generation.
dict
Response Syntax
{
'KeyArn': 'string',
'KeyCheckValue': 'string',
'Mac': 'string'
}
Response Structure
(dict) --
KeyArn (string) --
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.
KeyCheckValue (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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
Mac (string) --
The MAC cryptogram generated within Amazon Web Services Payment Cryptography.
Encrypts plaintext data to ciphertext using symmetric, asymmetric, or DUKPT data encryption key. 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 ).
for symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA . To encrypt using DUKPT, you must already have a DUKPT key in your account with KeyModesOfUse set to DeriveKey , or you can generate a new DUKPT key 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:
DecryptData
ReEncryptData
See also: AWS API Documentation
Request Syntax
client.encrypt_data(
EncryptionAttributes={
'Asymmetric': {
'PaddingType': 'PKCS1'|'OAEP_SHA1'|'OAEP_SHA256'|'OAEP_SHA512'
},
'Dukpt': {
'DukptKeyDerivationType': 'TDES_2KEY'|'TDES_3KEY'|'AES_128'|'AES_192'|'AES_256',
'DukptKeyVariant': 'BIDIRECTIONAL'|'REQUEST'|'RESPONSE',
'InitializationVector': 'string',
'KeySerialNumber': 'string',
'Mode': 'ECB'|'CBC'
},
'Symmetric': {
'InitializationVector': 'string',
'Mode': 'ECB'|'CBC'|'CFB'|'CFB1'|'CFB8'|'CFB64'|'CFB128'|'OFB',
'PaddingType': 'PKCS1'|'OAEP_SHA1'|'OAEP_SHA256'|'OAEP_SHA512'
}
},
KeyIdentifier='string',
PlainText='string'
)
dict
[REQUIRED]
The encryption key type and attributes for plaintext encryption.
Asymmetric (dict) --
Parameters for plaintext encryption using asymmetric keys.
PaddingType (string) --
The padding to be included with the data.
Dukpt (dict) --
Parameters that are required to encrypt plaintext data using DUKPT.
DukptKeyDerivationType (string) --
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
DukptKeyVariant (string) --
The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.
InitializationVector (string) --
An input to cryptographic primitive used to provide the intial state. Typically the InitializationVector must have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If you don't provide a value, Amazon Web Services Payment Cryptography generates a random value.
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.
Mode (string) --
The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size, for example, 128 bits. The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
The default is CBC.
Symmetric (dict) --
Parameters that are required to perform encryption and decryption using symmetric keys.
InitializationVector (string) --
An input to cryptographic primitive used to provide the intial state. The InitializationVector is typically required have a random or psuedo-random value, but sometimes it only needs to be unpredictable or unique. If a value is not provided, Amazon Web Services Payment Cryptography generates a random value.
Mode (string) -- [REQUIRED]
The block cipher mode of operation. Block ciphers are designed to encrypt a block of data of fixed size (for example, 128 bits). The size of the input block is usually same as the size of the encrypted output block, while the key length can be different. A mode of operation describes how to repeatedly apply a cipher's single-block operation to securely transform amounts of data larger than a block.
PaddingType (string) --
The padding to be included with the data.
string
[REQUIRED]
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
string
[REQUIRED]
The plaintext to be encrypted.
dict
Response Syntax
{
'CipherText': 'string',
'KeyArn': 'string',
'KeyCheckValue': 'string'
}
Response Structure
(dict) --
CipherText (string) --
The encrypted ciphertext.
KeyArn (string) --
The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.
KeyCheckValue (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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.
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
VerifyPinData
See also: AWS API Documentation
Request Syntax
client.verify_auth_request_cryptogram(
AuthRequestCryptogram='string',
AuthResponseAttributes={
'ArpcMethod1': {
'AuthResponseCode': 'string'
},
'ArpcMethod2': {
'CardStatusUpdate': 'string',
'ProprietaryAuthenticationData': 'string'
}
},
KeyIdentifier='string',
MajorKeyDerivationMode='EMV_OPTION_A'|'EMV_OPTION_B',
SessionKeyDerivationAttributes={
'Amex': {
'PanSequenceNumber': 'string',
'PrimaryAccountNumber': 'string'
},
'Emv2000': {
'ApplicationTransactionCounter': 'string',
'PanSequenceNumber': 'string',
'PrimaryAccountNumber': 'string'
},
'EmvCommon': {
'ApplicationTransactionCounter': 'string',
'PanSequenceNumber': 'string',
'PrimaryAccountNumber': 'string'
},
'Mastercard': {
'ApplicationTransactionCounter': 'string',
'PanSequenceNumber': 'string',
'PrimaryAccountNumber': 'string',
'UnpredictableNumber': 'string'
},
'Visa': {
'PanSequenceNumber': 'string',
'PrimaryAccountNumber': 'string'
}
},
TransactionData='string'
)
string
[REQUIRED]
The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.
dict
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.
ArpcMethod1 (dict) --
Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.
AuthResponseCode (string) -- [REQUIRED]
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.
ArpcMethod2 (dict) --
Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.
CardStatusUpdate (string) -- [REQUIRED]
The data indicating whether the issuer approves or declines an online transaction using an EMV chip card.
ProprietaryAuthenticationData (string) --
The proprietary authentication data used by issuer for communication during online transaction using an EMV chip card.
string
[REQUIRED]
The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
string
[REQUIRED]
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.
dict
[REQUIRED]
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.
Amex (dict) --
Parameters to derive session key for an Amex payment card for ARQC verification.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
PrimaryAccountNumber (string) -- [REQUIRED]
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.
Emv2000 (dict) --
Parameters to derive session key for an Emv2000 payment card for ARQC verification.
ApplicationTransactionCounter (string) -- [REQUIRED]
The transaction counter that is provided by the terminal during transaction processing.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
PrimaryAccountNumber (string) -- [REQUIRED]
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.
EmvCommon (dict) --
Parameters to derive session key for an Emv common payment card for ARQC verification.
ApplicationTransactionCounter (string) -- [REQUIRED]
The transaction counter that is provided by the terminal during transaction processing.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
PrimaryAccountNumber (string) -- [REQUIRED]
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.
Mastercard (dict) --
Parameters to derive session key for a Mastercard payment card for ARQC verification.
ApplicationTransactionCounter (string) -- [REQUIRED]
The transaction counter that is provided by the terminal during transaction processing.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
PrimaryAccountNumber (string) -- [REQUIRED]
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.
UnpredictableNumber (string) -- [REQUIRED]
A random number generated by the issuer.
Visa (dict) --
Parameters to derive session key for a Visa payment cardfor ARQC verification.
PanSequenceNumber (string) -- [REQUIRED]
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
PrimaryAccountNumber (string) -- [REQUIRED]
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.
string
[REQUIRED]
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.
dict
Response Syntax
{
'AuthResponseValue': 'string',
'KeyArn': 'string',
'KeyCheckValue': 'string'
}
Response Structure
(dict) --
AuthResponseValue (string) --
The result for ARQC verification or ARPC generation within Amazon Web Services Payment Cryptography.
KeyArn (string) --
The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
KeyCheckValue (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 calculates the KCV by using standard algorithms, typically by encrypting 8 or 16 bytes or "00" or "01" and then truncating the result to the first 3 bytes, or 6 hex digits, of the resulting cryptogram.