AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . payment-cryptography-data ]

generate-auth-request-cryptogram

Description

Generates an Authorization Request Cryptogram (ARQC) for an EMV chip payment card authorization. For more information, see Generate auth request cryptogram in the Amazon Web Services Payment Cryptography User Guide .

ARQC generation uses an Issuer Master Key (IMK) for application cryptograms (TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS) to derive a session key, which is then used to generate the cryptogram from the provided transaction data (when applicable). To use this operation, you must first create or import an IMK-AC key by calling CreateKey or ImportKey . The KeyModesOfUse should be set to DeriveKey for the IMK-AC encryption key.

Warning

This operation is intended for development and testing scenarios only. It is not recommended to use this operation as a substitute for card-based cryptogram generation in production payment flows.

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 supports cross-account use when the key has a resource-based policy that grants access. For more information, see Resource-based policies .

Related operations:

  • VerifyAuthRequestCryptogram

See also: AWS API Documentation

Synopsis

  generate-auth-request-cryptogram
--key-identifier <value>
--transaction-data <value>
--major-key-derivation-mode <value>
--session-key-derivation-attributes <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>]
[--v2-debug]

Options

--key-identifier (string)

The keyARN of the IMK-AC (TR31_E0_EMV_MKEY_APP_CRYPTOGRAMS) that Amazon Web Services Payment Cryptography uses to generate the ARQC.

--transaction-data (string)

The transaction data that Amazon Web Services Payment Cryptography uses for ARQC generation. The same transaction data is used for ARQC verification by the issuer using VerifyAuthRequestCryptogram .

--major-key-derivation-mode (string)

The method to use when deriving the major encryption key for ARQC generation within Amazon Web Services Payment Cryptography.

Possible values:

  • EMV_OPTION_A
  • EMV_OPTION_B

--session-key-derivation-attributes (tagged union structure)

The attributes and values to use for deriving a session key for ARQC generation within Amazon Web Services Payment Cryptography.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: EmvCommon, Mastercard, Emv2000, Amex, Visa, UnionPay.

EmvCommon -> (structure)

Parameters to derive session key for an Emv common payment card for ARQC verification.

PrimaryAccountNumber -> (string)

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.

PanSequenceNumber -> (string)

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

ApplicationTransactionCounter -> (string)

The transaction counter that is provided by the terminal during transaction processing.

Mastercard -> (structure)

Parameters to derive session key for a Mastercard payment card for ARQC verification.

PrimaryAccountNumber -> (string)

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.

PanSequenceNumber -> (string)

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

ApplicationTransactionCounter -> (string)

The transaction counter that is provided by the terminal during transaction processing.

UnpredictableNumber -> (string)

A random number generated by the issuer.

Emv2000 -> (structure)

Parameters to derive session key for an Emv2000 payment card for ARQC verification.

PrimaryAccountNumber -> (string)

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.

PanSequenceNumber -> (string)

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

ApplicationTransactionCounter -> (string)

The transaction counter that is provided by the terminal during transaction processing.

Amex -> (structure)

Parameters to derive session key for an Amex payment card for ARQC verification.

PrimaryAccountNumber -> (string)

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.

PanSequenceNumber -> (string)

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

Visa -> (structure)

Parameters to derive session key for a Visa payment cardfor ARQC verification.

PrimaryAccountNumber -> (string)

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.

PanSequenceNumber -> (string)

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

UnionPay -> (structure)

Parameters to derive session key for a UnionPay payment card for Authorization Request Cryptogram (ARQC) generation and verification.

PrimaryAccountNumber -> (string)

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.

PanSequenceNumber -> (string)

A number that identifies and differentiates payment cards with the same Primary Account Number (PAN). If not used, enter 00 .

ApplicationTransactionCounter -> (string)

The transaction counter that the terminal provides during transaction processing. This value is in hexadecimal format. For example, enter a decimal counter of 109 as 006D .

Shorthand Syntax:

EmvCommon={PrimaryAccountNumber=string,PanSequenceNumber=string,ApplicationTransactionCounter=string},Mastercard={PrimaryAccountNumber=string,PanSequenceNumber=string,ApplicationTransactionCounter=string,UnpredictableNumber=string},Emv2000={PrimaryAccountNumber=string,PanSequenceNumber=string,ApplicationTransactionCounter=string},Amex={PrimaryAccountNumber=string,PanSequenceNumber=string},Visa={PrimaryAccountNumber=string,PanSequenceNumber=string},UnionPay={PrimaryAccountNumber=string,PanSequenceNumber=string,ApplicationTransactionCounter=string}

JSON Syntax:

{
  "EmvCommon": {
    "PrimaryAccountNumber": "string",
    "PanSequenceNumber": "string",
    "ApplicationTransactionCounter": "string"
  },
  "Mastercard": {
    "PrimaryAccountNumber": "string",
    "PanSequenceNumber": "string",
    "ApplicationTransactionCounter": "string",
    "UnpredictableNumber": "string"
  },
  "Emv2000": {
    "PrimaryAccountNumber": "string",
    "PanSequenceNumber": "string",
    "ApplicationTransactionCounter": "string"
  },
  "Amex": {
    "PrimaryAccountNumber": "string",
    "PanSequenceNumber": "string"
  },
  "Visa": {
    "PrimaryAccountNumber": "string",
    "PanSequenceNumber": "string"
  },
  "UnionPay": {
    "PrimaryAccountNumber": "string",
    "PanSequenceNumber": "string",
    "ApplicationTransactionCounter": "string"
  }
}

--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

KeyArn -> (string)

The keyARN of the IMK-AC that Amazon Web Services Payment Cryptography uses for ARQC 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 computes the KCV according to the CMAC specification.

AuthRequestCryptogram -> (string)

The Authorization Request Cryptogram (ARQC) generated by Amazon Web Services Payment Cryptography using the specified key and transaction data.