AWS CLI Command Reference

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-card-validation-data

Description

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:

See also: AWS API Documentation

Synopsis

  generate-card-validation-data
--generation-attributes <value>
--key-identifier <value>
--primary-account-number <value>
[--validation-data-length <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

--generation-attributes (tagged union structure)

The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: AmexCardSecurityCodeVersion1, AmexCardSecurityCodeVersion2, CardHolderVerificationValue, CardVerificationValue1, CardVerificationValue2, DynamicCardVerificationCode, DynamicCardVerificationValue.

AmexCardSecurityCodeVersion1 -> (structure)

Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.

CardExpiryDate -> (string)

The expiry date of a payment card.

AmexCardSecurityCodeVersion2 -> (structure)

Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.

CardExpiryDate -> (string)

The expiry date of a payment card.

ServiceCode -> (string)

The service code of the AMEX payment card. This is different from the Card Security Code (CSC).

CardHolderVerificationValue -> (structure)

Card data parameters that are required to generate a cardholder verification value for the payment card.

ApplicationTransactionCounter -> (string)

The transaction counter value that comes from a point of sale terminal.

PanSequenceNumber -> (string)

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

UnpredictableNumber -> (string)

A random number generated by the issuer.

CardVerificationValue1 -> (structure)

Card data parameters that are required to generate Card Verification Value (CVV) for the payment card.

CardExpiryDate -> (string)

The expiry date of a payment card.

ServiceCode -> (string)

The service code of the payment card. This is different from Card Security Code (CSC).

CardVerificationValue2 -> (structure)

Card data parameters that are required to generate Card Verification Value (CVV2) for the payment card.

CardExpiryDate -> (string)

The expiry date of a payment card.

DynamicCardVerificationCode -> (structure)

Card data parameters that are required to generate CDynamic Card Verification Code (dCVC) for the payment card.

ApplicationTransactionCounter -> (string)

The transaction counter value that comes from the terminal.

PanSequenceNumber -> (string)

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

TrackData -> (string)

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)

A random number generated by the issuer.

DynamicCardVerificationValue -> (structure)

Card data parameters that are required to generate CDynamic Card Verification Value (dCVV) for the payment card.

ApplicationTransactionCounter -> (string)

The transaction counter value that comes from the terminal.

CardExpiryDate -> (string)

The expiry date of a payment card.

PanSequenceNumber -> (string)

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

ServiceCode -> (string)

The service code of the payment card. This is different from Card Security Code (CSC).

Shorthand Syntax:

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}

JSON Syntax:

{
  "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"
  }
}

--key-identifier (string)

The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.

--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.

--validation-data-length (integer)

The length of the CVV or CSC to be generated. The default value is 3.

--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 CVV

The following generate-card-validation-data example generates a CVV/CVV2.

aws payment-cryptography-data generate-card-validation-data \
    --key-identifier arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h \
    --primary-account-number=171234567890123 \
    --generation-attributes CardVerificationValue2={CardExpiryDate=0123}

Output:

{
    "KeyArn": "arn:aws:payment-cryptography:us-east-2:123456789012:key/kwapwa6qaifllw2h",
    "KeyCheckValue": "CADDA1",
    "ValidationData": "801"
}

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

Output

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

ValidationData -> (string)

The CVV or CSC value that Amazon Web Services Payment Cryptography generates for the card.