AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Payment Cryptography Data VerifyAuthRequestCryptogram API operation.

Syntax

Test-PAYCDAuthRequestCryptogram
-KeyIdentifier <String>
-Emv2000_ApplicationTransactionCounter <String>
-EmvCommon_ApplicationTransactionCounter <String>
-Mastercard_ApplicationTransactionCounter <String>
-AuthRequestCryptogram <String>
-ArpcMethod1_AuthResponseCode <String>
-ArpcMethod2_CardStatusUpdate <String>
-MajorKeyDerivationMode <MajorKeyDerivationMode>
-Amex_PanSequenceNumber <String>
-Emv2000_PanSequenceNumber <String>
-EmvCommon_PanSequenceNumber <String>
-Mastercard_PanSequenceNumber <String>
-Visa_PanSequenceNumber <String>
-Amex_PrimaryAccountNumber <String>
-Emv2000_PrimaryAccountNumber <String>
-EmvCommon_PrimaryAccountNumber <String>
-Mastercard_PrimaryAccountNumber <String>
-Visa_PrimaryAccountNumber <String>
-ArpcMethod2_ProprietaryAuthenticationData <String>
-TransactionData <String>
-Mastercard_UnpredictableNumber <String>
-Select <String>
-PassThru <SwitchParameter>
-ClientConfig <AmazonPaymentCryptographyDataConfig>

Description

Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization. For more information, see Verify auth request cryptogram in the Amazon Web Services Payment Cryptography User Guide. ARQC generation is done outside of Amazon Web Services Payment Cryptography and is typically generated on a point of sale terminal for an EMV chip card to obtain payment authorization during transaction time. For ARQC verification, you must first import the ARQC generated outside of Amazon Web Services Payment Cryptography by calling ImportKey. This operation uses the imported ARQC and an major encryption key (DUKPT) created by calling CreateKey to either provide a boolean ARQC verification result or provide an APRC (Authorization Response Cryptogram) response using Method 1 or Method 2. The ARPC_METHOD_1 uses AuthResponseCode to generate ARPC and ARPC_METHOD_2 uses CardStatusUpdate to generate ARPC. 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:

Parameters

-Amex_PanSequenceNumber <String>
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Amex_PanSequenceNumber
-Amex_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Amex_PrimaryAccountNumber
-ArpcMethod1_AuthResponseCode <String>
The auth code used to calculate APRC after ARQC verification is successful. This is the same auth code used for ARQC generation outside of Amazon Web Services Payment Cryptography.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthResponseAttributes_ArpcMethod1_AuthResponseCode
-ArpcMethod2_CardStatusUpdate <String>
The data indicating whether the issuer approves or declines an online transaction using an EMV chip card.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthResponseAttributes_ArpcMethod2_CardStatusUpdate
-ArpcMethod2_ProprietaryAuthenticationData <String>
The proprietary authentication data used by issuer for communication during online transaction using an EMV chip card.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAuthResponseAttributes_ArpcMethod2_ProprietaryAuthenticationData
-AuthRequestCryptogram <String>
The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonPaymentCryptographyDataConfig>
Amazon.PowerShell.Cmdlets.PAYCD.AmazonPaymentCryptographyDataClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Emv2000_ApplicationTransactionCounter <String>
The transaction counter that is provided by the terminal during transaction processing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Emv2000_ApplicationTransactionCounter
-Emv2000_PanSequenceNumber <String>
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Emv2000_PanSequenceNumber
-Emv2000_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Emv2000_PrimaryAccountNumber
-EmvCommon_ApplicationTransactionCounter <String>
The transaction counter that is provided by the terminal during transaction processing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_EmvCommon_ApplicationTransactionCounter
-EmvCommon_PanSequenceNumber <String>
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_EmvCommon_PanSequenceNumber
-EmvCommon_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_EmvCommon_PrimaryAccountNumber
-KeyIdentifier <String>
The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-MajorKeyDerivationMode <MajorKeyDerivationMode>
The method to use when deriving the major encryption key for ARQC verification within Amazon Web Services Payment Cryptography. The same key derivation mode was used for ARQC generation outside of Amazon Web Services Payment Cryptography.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Mastercard_ApplicationTransactionCounter <String>
The transaction counter that is provided by the terminal during transaction processing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Mastercard_ApplicationTransactionCounter
-Mastercard_PanSequenceNumber <String>
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Mastercard_PanSequenceNumber
-Mastercard_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Mastercard_PrimaryAccountNumber
-Mastercard_UnpredictableNumber <String>
A random number generated by the issuer.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Mastercard_UnpredictableNumber
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the KeyIdentifier parameter. The -PassThru parameter is deprecated, use -Select '^KeyIdentifier' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.PaymentCryptographyData.Model.VerifyAuthRequestCryptogramResponse). Specifying the name of a property of type Amazon.PaymentCryptographyData.Model.VerifyAuthRequestCryptogramResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TransactionData <String>
The transaction data that Amazon Web Services Payment Cryptography uses for ARQC verification. The same transaction is used for ARQC generation outside of Amazon Web Services Payment Cryptography.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Visa_PanSequenceNumber <String>
A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Visa_PanSequenceNumber
-Visa_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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSessionKeyDerivationAttributes_Visa_PrimaryAccountNumber

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.PaymentCryptographyData.Model.VerifyAuthRequestCryptogramResponse
This cmdlet returns an Amazon.PaymentCryptographyData.Model.VerifyAuthRequestCryptogramResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z