Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . payment-cryptography-data ]

generate-pin-data¶

Description¶

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

Synopsis¶

  generate-pin-data
--encryption-key-identifier <value>
--generation-attributes <value>
--generation-key-identifier <value>
--pin-block-format <value>
[--pin-data-length <value>]
--primary-account-number <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--encryption-key-identifier (string)

The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.

--generation-attributes (tagged union structure)

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 -> (structure)

Parameters that are required to generate or verify Ibm3624 natural PIN.

DecimalizationTable -> (string)

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)

The unique data for cardholder identification.

PinValidationDataPadCharacter -> (string)

The padding character for validation data.

Ibm3624PinFromOffset -> (structure)

Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.

DecimalizationTable -> (string)

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)

The PIN offset value.

PinValidationData -> (string)

The unique data for cardholder identification.

PinValidationDataPadCharacter -> (string)

The padding character for validation data.

Ibm3624PinOffset -> (structure)

Parameters that are required to generate or verify Ibm3624 PIN offset PIN.

DecimalizationTable -> (string)

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)

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)

The unique data for cardholder identification.

PinValidationDataPadCharacter -> (string)

The padding character for validation data.

Ibm3624RandomPin -> (structure)

Parameters that are required to generate or verify Ibm3624 random PIN.

DecimalizationTable -> (string)

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)

The unique data for cardholder identification.

PinValidationDataPadCharacter -> (string)

The padding character for validation data.

VisaPin -> (structure)

Parameters that are required to generate or verify Visa PIN.

PinVerificationKeyIndex -> (integer)

The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).

VisaPinVerificationValue -> (structure)

Parameters that are required to generate or verify Visa PIN Verification Value (PVV).

EncryptedPinBlock -> (string)

The encrypted PIN block data to verify.

PinVerificationKeyIndex -> (integer)

The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).

Shorthand Syntax:

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=integer},VisaPinVerificationValue={EncryptedPinBlock=string,PinVerificationKeyIndex=integer}

JSON Syntax:

{
  "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": integer
  },
  "VisaPinVerificationValue": {
    "EncryptedPinBlock": "string",
    "PinVerificationKeyIndex": integer
  }
}

--generation-key-identifier (string)

The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.

--pin-block-format (string)

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.

Possible values:

ISO_FORMAT_0

ISO_FORMAT_3

--pin-data-length (integer)

The length of PIN under generation.

--primary-account-number (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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To generate a PIN

The following generate-card-validation-data example generate a new random PIN using the Visa PIN scheme.

aws payment-cryptography-data generate-pin-data \
    --generation-key-identifier arn:aws:payment-cryptography:us-east-2:111122223333:key/37y2tsl45p5zjbh2 \
    --encryption-key-identifier arn:aws:payment-cryptography:us-east-2:111122223333:key/ivi5ksfsuplneuyt \
    --primary-account-number 171234567890123 \
    --pin-block-format ISO_FORMAT_0 \
    --generation-attributes VisaPin={PinVerificationKeyIndex=1}

Output:

{
    "GenerationKeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/37y2tsl45p5zjbh2",
    "GenerationKeyCheckValue": "7F2363",
    "EncryptionKeyArn": "arn:aws:payment-cryptography:us-east-2:111122223333:key/ivi5ksfsuplneuyt",
    "EncryptionKeyCheckValue": "7CC9E2",
    "EncryptedPinBlock": "AC17DC148BDA645E",
    "PinData": {
        "VerificationValue": "5507"
    }
}

For more information, see Generate PIN data in the AWS Payment Cryptography User Guide.

Output¶

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 computes the KCV according to the CMAC specification.

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.

PinData -> (tagged union structure)

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 can be set: PinOffset, VerificationValue.

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.

Table Of Contents

Feedback

User Guide

Note:

generate-pin-data¶

Description¶

Synopsis¶

Options¶

Note

Global Options¶

Examples¶

Note

Output¶

Note