AWS CLI Command Reference

[ 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 | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options

--key-identifier (string) [required]

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

Constraints:

  • min: 7
  • max: 322
  • pattern: arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:(key/[0-9a-zA-Z]{16,64}|alias/[a-zA-Z0-9/_-]+)$|^alias/[a-zA-Z0-9/_-]+

--transaction-data (string) [required]

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 .

Constraints:

  • min: 2
  • max: 1024
  • pattern: [0-9a-fA-F]+

--major-key-derivation-mode (string) [required]

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) [required]

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.

EmvCommon -> (structure)

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

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.

Constraints:

  • min: 12
  • max: 19
  • pattern: [0-9]+

PanSequenceNumber -> (string) [required]

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

Constraints:

  • min: 2
  • max: 2
  • pattern: [0-9]+

ApplicationTransactionCounter -> (string) [required]

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

Constraints:

  • min: 4
  • max: 4
  • pattern: [0-9a-fA-F]+

Mastercard -> (structure)

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

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.

Constraints:

  • min: 12
  • max: 19
  • pattern: [0-9]+

PanSequenceNumber -> (string) [required]

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

Constraints:

  • min: 2
  • max: 2
  • pattern: [0-9]+

ApplicationTransactionCounter -> (string) [required]

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

Constraints:

  • min: 4
  • max: 4
  • pattern: [0-9a-fA-F]+

UnpredictableNumber -> (string) [required]

A random number generated by the issuer.

Constraints:

  • min: 8
  • max: 8
  • pattern: [0-9a-fA-F]+

Emv2000 -> (structure)

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

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.

Constraints:

  • min: 12
  • max: 19
  • pattern: [0-9]+

PanSequenceNumber -> (string) [required]

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

Constraints:

  • min: 2
  • max: 2
  • pattern: [0-9]+

ApplicationTransactionCounter -> (string) [required]

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

Constraints:

  • min: 4
  • max: 4
  • pattern: [0-9a-fA-F]+

Amex -> (structure)

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

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.

Constraints:

  • min: 12
  • max: 19
  • pattern: [0-9]+

PanSequenceNumber -> (string) [required]

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

Constraints:

  • min: 2
  • max: 2
  • pattern: [0-9]+

Visa -> (structure)

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

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.

Constraints:

  • min: 12
  • max: 19
  • pattern: [0-9]+

PanSequenceNumber -> (string) [required]

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

Constraints:

  • min: 2
  • max: 2
  • pattern: [0-9]+

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}

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

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
  • yaml
  • yaml-stream
  • off

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

Output

KeyArn -> (string)

The keyARN of the IMK-AC that Amazon Web Services Payment Cryptography uses for ARQC generation.

Constraints:

  • min: 70
  • max: 150
  • pattern: arn:aws:payment-cryptography:[a-z]{2}-[a-z]{1,16}-[0-9]+:[0-9]{12}:key/[0-9a-zA-Z]{16,64}

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.

Constraints:

  • min: 4
  • max: 16
  • pattern: [0-9a-fA-F]+

AuthRequestCryptogram -> (string)

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

Constraints:

  • min: 16
  • max: 16
  • pattern: [0-9a-fA-F]+
© Copyright 2026, Amazon Web Services. Created using Sphinx.