PaymentCryptographyDataPlane / Client / generate_pin_data

generate_pin_data#

PaymentCryptographyDataPlane.Client.generate_pin_data(**kwargs)#

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

Request Syntax

response = 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'
)

Parameters:

EncryptionKeyIdentifier (string) –
[REQUIRED]

The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.
GenerationAttributes (dict) –
[REQUIRED]

The attributes and values to use for PIN, PVV, or PIN Offset generation.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: Ibm3624NaturalPin, Ibm3624PinFromOffset, Ibm3624PinOffset, Ibm3624RandomPin, VisaPin, VisaPinVerificationValue.
- 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).
GenerationKeyIdentifier (string) –
[REQUIRED]

The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.
PinBlockFormat (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.
PinDataLength (integer) – The length of PIN under generation.
PrimaryAccountNumber (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.

Return type:

dict

Returns:

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.
  Note
  This is a Tagged Union structure. Only one of the following top level keys will be set: PinOffset, VerificationValue. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
  'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
  - 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.

Exceptions

PaymentCryptographyDataPlane.Client.exceptions.ValidationException
PaymentCryptographyDataPlane.Client.exceptions.AccessDeniedException
PaymentCryptographyDataPlane.Client.exceptions.ResourceNotFoundException
PaymentCryptographyDataPlane.Client.exceptions.ThrottlingException
PaymentCryptographyDataPlane.Client.exceptions.InternalServerException