com.amazonaws.services.paymentcryptographydata

Class AWSPaymentCryptographyDataClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.paymentcryptographydata.AWSPaymentCryptographyDataClient

All Implemented Interfaces:

AWSPaymentCryptographyData

Direct Known Subclasses:

AWSPaymentCryptographyDataAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSPaymentCryptographyDataClient
extends AmazonWebServiceClient
implements AWSPaymentCryptographyData

Client for accessing Payment Cryptography Data Plane. All service calls made using this client are blocking, and will not return until the service call completes.

You use the Amazon Web Services Payment Cryptography Data Plane to manage how encryption keys are used for payment-related transaction processing and associated cryptographic operations. You can encrypt, decrypt, generate, verify, and translate payment-related cryptographic operations in Amazon Web Services Payment Cryptography. For more information, see Data operations in the Amazon Web Services Payment Cryptography User Guide.

To manage your encryption keys, you use the Amazon Web Services Payment Cryptography Control Plane. You can create, import, export, share, manage, and delete keys. You can also manage Identity and Access Management (IAM) policies for keys.

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.paymentcryptographydata.AWSPaymentCryptographyData

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSPaymentCryptographyDataClientBuilder	builder()
DecryptDataResult	decryptData(DecryptDataRequest request) Decrypts ciphertext data to plaintext using symmetric, asymmetric, or DUKPT data encryption key.
EncryptDataResult	encryptData(EncryptDataRequest request) Encrypts plaintext data to ciphertext using symmetric, asymmetric, or DUKPT data encryption key.
GenerateCardValidationDataResult	generateCardValidationData(GenerateCardValidationDataRequest request) 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).
GenerateMacResult	generateMac(GenerateMacRequest request) Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.
GeneratePinDataResult	generatePinData(GeneratePinDataRequest request) Generates pin-related data such as PIN, PIN Verification Value (PVV), PIN Block, and PIN Offset during new card issuance or reissuance.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
ReEncryptDataResult	reEncryptData(ReEncryptDataRequest request) Re-encrypt ciphertext using DUKPT, Symmetric and Asymmetric Data Encryption Keys.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
TranslatePinDataResult	translatePinData(TranslatePinDataRequest request) Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4.
VerifyAuthRequestCryptogramResult	verifyAuthRequestCryptogram(VerifyAuthRequestCryptogramRequest request) Verifies Authorization Request Cryptogram (ARQC) for a EMV chip payment card authorization.
VerifyCardValidationDataResult	verifyCardValidationData(VerifyCardValidationDataRequest request) Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC).
VerifyMacResult	verifyMac(VerifyMacRequest request) Verifies a Message Authentication Code (MAC).
VerifyPinDataResult	verifyPinData(VerifyPinDataRequest request) Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSPaymentCryptographyDataClientBuilder builder()

decryptData

public DecryptDataResult decryptData(DecryptDataRequest request)

Decrypts ciphertext data to plaintext using symmetric, asymmetric, or DUKPT data encryption key. For more information, see Decrypt data in the Amazon Web Services Payment Cryptography User Guide.

You can use an encryption key generated within Amazon Web Services Payment Cryptography, or you can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Decrypt. In asymmetric decryption, Amazon Web Services Payment Cryptography decrypts the ciphertext using the private component of the asymmetric encryption key pair. For data encryption outside of Amazon Web Services Payment Cryptography, you can export the public component of the asymmetric key pair by calling GetPublicCertificate.

For symmetric and DUKPT decryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA. When you use DUKPT, for TDES algorithm, the ciphertext data length must be a multiple of 16 bytes. For AES algorithm, the ciphertext data length must be a multiple of 32 bytes.

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:

• EncryptData

• GetPublicCertificate

• ImportKey

Specified by:

decryptData in interface AWSPaymentCryptographyData

Parameters:

decryptDataRequest -

Returns:

Result of the DecryptData operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

encryptData

public EncryptDataResult encryptData(EncryptDataRequest request)

Encrypts plaintext data to ciphertext using symmetric, asymmetric, or DUKPT data encryption key. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.

You can generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey. You can import your own encryption key by calling ImportKey. For this operation, the key must have KeyModesOfUse set to Encrypt. In asymmetric encryption, plaintext is encrypted using public component. You can import the public component of an asymmetric key pair created outside Amazon Web Services Payment Cryptography by calling ImportKey).

for symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA. To encrypt using DUKPT, you must already have a DUKPT key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey.

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:

• DecryptData

• GetPublicCertificate

• ImportKey

• ReEncryptData

Specified by:

encryptData in interface AWSPaymentCryptographyData

Parameters:

encryptDataRequest -

Returns:

Result of the EncryptData operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

generateCardValidationData

public GenerateCardValidationDataResult generateCardValidationData(GenerateCardValidationDataRequest request)

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:

• ImportKey

• VerifyCardValidationData

Specified by:

generateCardValidationData in interface AWSPaymentCryptographyData

Parameters:

generateCardValidationDataRequest -

Returns:

Result of the GenerateCardValidationData operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

generateMac

public GenerateMacResult generateMac(GenerateMacRequest request)

Generates a Message Authentication Code (MAC) cryptogram within Amazon Web Services Payment Cryptography.

You can use this operation when keys won't be shared but mutual data is present on both ends for validation. In this case, known data values are used to generate a MAC on both ends for comparision without sending or receiving data in ciphertext or plaintext. You can use this operation to generate a DUPKT, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. The MAC generation encryption key must have valid values for KeyUsage such as TR31_M7_HMAC_KEY for HMAC generation, and they key must have KeyModesOfUse set to Generate and Verify.

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:

• VerifyMac

Specified by:

generateMac in interface AWSPaymentCryptographyData

Parameters:

generateMacRequest -

Returns:

Result of the GenerateMac operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

generatePinData

public GeneratePinDataResult generatePinData(GeneratePinDataRequest request)

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

Specified by:

generatePinData in interface AWSPaymentCryptographyData

Parameters:

generatePinDataRequest -

Returns:

Result of the GeneratePinData operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

reEncryptData

public ReEncryptDataResult reEncryptData(ReEncryptDataRequest request)

Re-encrypt ciphertext using DUKPT, Symmetric and Asymmetric Data Encryption Keys.

You can either generate an encryption key within Amazon Web Services Payment Cryptography by calling CreateKey or import your own encryption key by calling ImportKey. The KeyArn for use with this operation must be in a compatible key state with KeyModesOfUse set to Encrypt. In asymmetric encryption, ciphertext is encrypted using public component (imported by calling ImportKey) of the asymmetric key pair created outside of Amazon Web Services Payment Cryptography.

For symmetric and DUKPT encryption, Amazon Web Services Payment Cryptography supports TDES and AES algorithms. For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA. To encrypt using DUKPT, a DUKPT key must already exist within your account with KeyModesOfUse set to DeriveKey or a new DUKPT can be generated by calling CreateKey.

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:

• DecryptData

• EncryptData

• GetPublicCertificate

• ImportKey

Specified by:

reEncryptData in interface AWSPaymentCryptographyData

Parameters:

reEncryptDataRequest -

Returns:

Result of the ReEncryptData operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

translatePinData

public TranslatePinDataResult translatePinData(TranslatePinDataRequest request)

Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide.

PIN block translation involves changing the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation type for DUKPT tranlations. You can use this operation for P2PE (Point to Point Encryption) use cases where the encryption keys should change but the processing system either does not need to, or is not permitted to, decrypt the data.

The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for 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.

At this time, Amazon Web Services Payment Cryptography does not support translations to PIN format 4.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

• GeneratePinData

• VerifyPinData

Specified by:

translatePinData in interface AWSPaymentCryptographyData

Parameters:

translatePinDataRequest -

Returns:

Result of the TranslatePinData operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

verifyAuthRequestCryptogram

public VerifyAuthRequestCryptogramResult verifyAuthRequestCryptogram(VerifyAuthRequestCryptogramRequest request)

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:

• VerifyCardValidationData

• VerifyPinData

Specified by:

verifyAuthRequestCryptogram in interface AWSPaymentCryptographyData

Parameters:

verifyAuthRequestCryptogramRequest -

Returns:

Result of the VerifyAuthRequestCryptogram operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

VerificationFailedException - This request failed verification.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

verifyCardValidationData

public VerifyCardValidationDataResult verifyCardValidationData(VerifyCardValidationDataRequest request)

Verifies card-related validation data using algorithms such as Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2) and Card Security Codes (CSC). For more information, see Verify card data in the Amazon Web Services Payment Cryptography User Guide.

This operation validates the CVV or CSC codes that is printed on a payment credit or debit card during card payment transaction. The input values are typically provided as part of an inbound transaction to an issuer or supporting platform partner. Amazon Web Services Payment Cryptography uses CVV or CSC, PAN (Primary Account Number) and expiration date of the card to check its validity during transaction processing. In this operation, the CVK (Card Verification Key) encryption key for use with card data verification is same as the one in used for GenerateCardValidationData.

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

• VerifyAuthRequestCryptogram

• VerifyPinData

Specified by:

verifyCardValidationData in interface AWSPaymentCryptographyData

Parameters:

verifyCardValidationDataRequest -

Returns:

Result of the VerifyCardValidationData operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

VerificationFailedException - This request failed verification.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

verifyMac

public VerifyMacResult verifyMac(VerifyMacRequest request)

Verifies a Message Authentication Code (MAC).

You can use this operation when keys won't be shared but mutual data is present on both ends for validation. In this case, known data values are used to generate a MAC on both ends for verification without sending or receiving data in ciphertext or plaintext. You can use this operation to verify a DUPKT, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values. Use the same encryption key for MAC verification as you use for GenerateMac.

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:

• GenerateMac

Specified by:

verifyMac in interface AWSPaymentCryptographyData

Parameters:

verifyMacRequest -

Returns:

Result of the VerifyMac operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

VerificationFailedException - This request failed verification.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

verifyPinData

public VerifyPinDataResult verifyPinData(VerifyPinDataRequest request)

Verifies pin-related data such as PIN and PIN Offset using algorithms including VISA PVV and IBM3624. For more information, see Verify PIN data in the Amazon Web Services Payment Cryptography User Guide.

This operation verifies PIN data for user payment card. A card holder PIN data is never transmitted in clear to or from Amazon Web Services Payment Cryptography. This operation uses PIN Verification Key (PVK) for PIN or PIN Offset generation and then encrypts it using PIN Encryption Key (PEK) to create an EncryptedPinBlock for transmission from Amazon Web Services Payment Cryptography.

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:

• GeneratePinData

• TranslatePinData

Specified by:

verifyPinData in interface AWSPaymentCryptographyData

Parameters:

verifyPinDataRequest -

Returns:

Result of the VerifyPinData operation returned by the service.

Throws:

ValidationException - The request was denied due to an invalid request error.

VerificationFailedException - This request failed verification.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The request was denied due to an invalid resource error.

ThrottlingException - The request was denied due to request throttling.

InternalServerException - The request processing has failed because of an unknown error, exception, or failure.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSPaymentCryptographyData

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSPaymentCryptographyData

Overrides:

shutdown in class AmazonWebServiceClient