Package software.amazon.awssdk.services.paymentcryptographydata

Interface PaymentCryptographyDataAsyncClient

All Superinterfaces:
AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface PaymentCryptographyDataAsyncClient extends AwsClient
Service client for accessing Payment Cryptography Data Plane asynchronously. This can be created using the static builder() method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API call.

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 Details

  • Method Details

    • decryptData

      default CompletableFuture<DecryptDataResponse> decryptData(DecryptDataRequest decryptDataRequest)

      Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. 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 EMV decryption, Amazon Web Services Payment Cryptography supports TDES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA.

      When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

      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:
      decryptDataRequest -
      Returns:
      A Java Future containing the result of the DecryptData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • decryptData

      default CompletableFuture<DecryptDataResponse> decryptData(Consumer<DecryptDataRequest.Builder> decryptDataRequest)

      Decrypts ciphertext data to plaintext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. 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 EMV decryption, Amazon Web Services Payment Cryptography supports TDES algorithms. For asymmetric decryption, Amazon Web Services Payment Cryptography supports RSA.

      When you use TDES or TDES DUKPT, the ciphertext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the ciphertext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

      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:


      This is a convenience which creates an instance of the DecryptDataRequest.Builder avoiding the need to create one manually via DecryptDataRequest.builder()

      Parameters:
      decryptDataRequest - A Consumer that will call methods on DecryptDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the DecryptData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • encryptData

      default CompletableFuture<EncryptDataResponse> encryptData(EncryptDataRequest encryptDataRequest)

      Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. 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 EMV encryption, Amazon Web Services Payment Cryptography supports TDES algorithms.For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA.

      When you use TDES or TDES DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

      To encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey. To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey.

      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:
      encryptDataRequest -
      Returns:
      A Java Future containing the result of the EncryptData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • encryptData

      default CompletableFuture<EncryptDataResponse> encryptData(Consumer<EncryptDataRequest.Builder> encryptDataRequest)

      Encrypts plaintext data to ciphertext using a symmetric (TDES, AES), asymmetric (RSA), or derived (DUKPT or EMV) encryption key scheme. 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 EMV encryption, Amazon Web Services Payment Cryptography supports TDES algorithms.For asymmetric encryption, Amazon Web Services Payment Cryptography supports RSA.

      When you use TDES or TDES DUKPT, the plaintext data length must be a multiple of 8 bytes. For AES or AES DUKPT, the plaintext data length must be a multiple of 16 bytes. For RSA, it sould be equal to the key size unless padding is enabled.

      To encrypt using DUKPT, you must already have a BDK (Base Derivation Key) key in your account with KeyModesOfUse set to DeriveKey, or you can generate a new DUKPT key by calling CreateKey. To encrypt using EMV, you must already have an IMK (Issuer Master Key) key in your account with KeyModesOfUse set to DeriveKey.

      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:


      This is a convenience which creates an instance of the EncryptDataRequest.Builder avoiding the need to create one manually via EncryptDataRequest.builder()

      Parameters:
      encryptDataRequest - A Consumer that will call methods on EncryptDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the EncryptData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generateCardValidationData

      default CompletableFuture<GenerateCardValidationDataResponse> generateCardValidationData(GenerateCardValidationDataRequest generateCardValidationDataRequest)

      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:

      Parameters:
      generateCardValidationDataRequest -
      Returns:
      A Java Future containing the result of the GenerateCardValidationData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generateCardValidationData

      default CompletableFuture<GenerateCardValidationDataResponse> generateCardValidationData(Consumer<GenerateCardValidationDataRequest.Builder> generateCardValidationDataRequest)

      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:


      This is a convenience which creates an instance of the GenerateCardValidationDataRequest.Builder avoiding the need to create one manually via GenerateCardValidationDataRequest.builder()

      Parameters:
      generateCardValidationDataRequest - A Consumer that will call methods on GenerateCardValidationDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GenerateCardValidationData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generateMac

      default CompletableFuture<GenerateMacResponse> generateMac(GenerateMacRequest generateMacRequest)

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

      You can use this operation to authenticate card-related data by using known data values to generate MAC for data validation between the sending and receiving parties. This operation uses message data, a secret encryption key and MAC algorithm to generate a unique MAC value for transmission. The receiving party of the MAC must use the same message data, secret encryption key and MAC algorithm to reproduce another MAC value for comparision.

      You can use this operation to generate a DUPKT, CMAC, 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:

      Parameters:
      generateMacRequest -
      Returns:
      A Java Future containing the result of the GenerateMac operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generateMac

      default CompletableFuture<GenerateMacResponse> generateMac(Consumer<GenerateMacRequest.Builder> generateMacRequest)

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

      You can use this operation to authenticate card-related data by using known data values to generate MAC for data validation between the sending and receiving parties. This operation uses message data, a secret encryption key and MAC algorithm to generate a unique MAC value for transmission. The receiving party of the MAC must use the same message data, secret encryption key and MAC algorithm to reproduce another MAC value for comparision.

      You can use this operation to generate a DUPKT, CMAC, 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:


      This is a convenience which creates an instance of the GenerateMacRequest.Builder avoiding the need to create one manually via GenerateMacRequest.builder()

      Parameters:
      generateMacRequest - A Consumer that will call methods on GenerateMacRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GenerateMac operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generatePinData

      default CompletableFuture<GeneratePinDataResponse> generatePinData(GeneratePinDataRequest generatePinDataRequest)

      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:

      Parameters:
      generatePinDataRequest -
      Returns:
      A Java Future containing the result of the GeneratePinData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • generatePinData

      default CompletableFuture<GeneratePinDataResponse> generatePinData(Consumer<GeneratePinDataRequest.Builder> generatePinDataRequest)

      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:


      This is a convenience which creates an instance of the GeneratePinDataRequest.Builder avoiding the need to create one manually via GeneratePinDataRequest.builder()

      Parameters:
      generatePinDataRequest - A Consumer that will call methods on GeneratePinDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the GeneratePinData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • reEncryptData

      default CompletableFuture<ReEncryptDataResponse> reEncryptData(ReEncryptDataRequest reEncryptDataRequest)

      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:

      Parameters:
      reEncryptDataRequest -
      Returns:
      A Java Future containing the result of the ReEncryptData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • reEncryptData

      default CompletableFuture<ReEncryptDataResponse> reEncryptData(Consumer<ReEncryptDataRequest.Builder> reEncryptDataRequest)

      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:


      This is a convenience which creates an instance of the ReEncryptDataRequest.Builder avoiding the need to create one manually via ReEncryptDataRequest.builder()

      Parameters:
      reEncryptDataRequest - A Consumer that will call methods on ReEncryptDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the ReEncryptData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • translatePinData

      default CompletableFuture<TranslatePinDataResponse> translatePinData(TranslatePinDataRequest translatePinDataRequest)

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

      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.

      Amazon Web Services Payment Cryptography currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length. That is, PAN is the right most 12 digits excluding the check digits.

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

      Related operations:

      Parameters:
      translatePinDataRequest -
      Returns:
      A Java Future containing the result of the TranslatePinData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • translatePinData

      default CompletableFuture<TranslatePinDataResponse> translatePinData(Consumer<TranslatePinDataRequest.Builder> translatePinDataRequest)

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

      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.

      Amazon Web Services Payment Cryptography currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length. That is, PAN is the right most 12 digits excluding the check digits.

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

      Related operations:


      This is a convenience which creates an instance of the TranslatePinDataRequest.Builder avoiding the need to create one manually via TranslatePinDataRequest.builder()

      Parameters:
      translatePinDataRequest - A Consumer that will call methods on TranslatePinDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the TranslatePinData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • verifyAuthRequestCryptogram

      default CompletableFuture<VerifyAuthRequestCryptogramResponse> verifyAuthRequestCryptogram(VerifyAuthRequestCryptogramRequest verifyAuthRequestCryptogramRequest)

      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:
      verifyAuthRequestCryptogramRequest -
      Returns:
      A Java Future containing the result of the VerifyAuthRequestCryptogram operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • verifyAuthRequestCryptogram

      default CompletableFuture<VerifyAuthRequestCryptogramResponse> verifyAuthRequestCryptogram(Consumer<VerifyAuthRequestCryptogramRequest.Builder> verifyAuthRequestCryptogramRequest)

      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:


      This is a convenience which creates an instance of the VerifyAuthRequestCryptogramRequest.Builder avoiding the need to create one manually via VerifyAuthRequestCryptogramRequest.builder()

      Parameters:
      verifyAuthRequestCryptogramRequest - A Consumer that will call methods on VerifyAuthRequestCryptogramRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the VerifyAuthRequestCryptogram operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • verifyCardValidationData

      default CompletableFuture<VerifyCardValidationDataResponse> verifyCardValidationData(VerifyCardValidationDataRequest verifyCardValidationDataRequest)

      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:

      Parameters:
      verifyCardValidationDataRequest -
      Returns:
      A Java Future containing the result of the VerifyCardValidationData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • verifyCardValidationData

      default CompletableFuture<VerifyCardValidationDataResponse> verifyCardValidationData(Consumer<VerifyCardValidationDataRequest.Builder> verifyCardValidationDataRequest)

      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:


      This is a convenience which creates an instance of the VerifyCardValidationDataRequest.Builder avoiding the need to create one manually via VerifyCardValidationDataRequest.builder()

      Parameters:
      verifyCardValidationDataRequest - A Consumer that will call methods on VerifyCardValidationDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the VerifyCardValidationData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • verifyMac

      default CompletableFuture<VerifyMacResponse> verifyMac(VerifyMacRequest verifyMacRequest)

      Verifies a Message Authentication Code (MAC).

      You can use this operation to verify MAC for message data authentication such as . In this operation, you must use the same message data, secret encryption key and MAC algorithm that was used to generate MAC. You can use this operation to verify a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values.

      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:
      verifyMacRequest -
      Returns:
      A Java Future containing the result of the VerifyMac operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • verifyMac

      default CompletableFuture<VerifyMacResponse> verifyMac(Consumer<VerifyMacRequest.Builder> verifyMacRequest)

      Verifies a Message Authentication Code (MAC).

      You can use this operation to verify MAC for message data authentication such as . In this operation, you must use the same message data, secret encryption key and MAC algorithm that was used to generate MAC. You can use this operation to verify a DUPKT, CMAC, HMAC or EMV MAC by setting generation attributes and algorithm to the associated values.

      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:


      This is a convenience which creates an instance of the VerifyMacRequest.Builder avoiding the need to create one manually via VerifyMacRequest.builder()

      Parameters:
      verifyMacRequest - A Consumer that will call methods on VerifyMacRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the VerifyMac operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • verifyPinData

      default CompletableFuture<VerifyPinDataResponse> verifyPinData(VerifyPinDataRequest verifyPinDataRequest)

      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:

      Parameters:
      verifyPinDataRequest -
      Returns:
      A Java Future containing the result of the VerifyPinData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • verifyPinData

      default CompletableFuture<VerifyPinDataResponse> verifyPinData(Consumer<VerifyPinDataRequest.Builder> verifyPinDataRequest)

      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:


      This is a convenience which creates an instance of the VerifyPinDataRequest.Builder avoiding the need to create one manually via VerifyPinDataRequest.builder()

      Parameters:
      verifyPinDataRequest - A Consumer that will call methods on VerifyPinDataRequest.Builder to create a request.
      Returns:
      A Java Future containing the result of the VerifyPinData operation returned by the service.
      The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invoke Throwable.getCause() to retrieve the underlying exception.
      • 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.
      • SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
      • SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
      • PaymentCryptographyDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
      See Also:

    • serviceClientConfiguration

      default PaymentCryptographyDataServiceClientConfiguration serviceClientConfiguration()
      Description copied from interface: SdkClient
      The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
      Specified by:
      serviceClientConfiguration in interface AwsClient
      Specified by:
      serviceClientConfiguration in interface SdkClient
      Returns:
      SdkServiceClientConfiguration

    • create

      static PaymentCryptographyDataAsyncClient create()
      Create a PaymentCryptographyDataAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

    • builder

      static PaymentCryptographyDataAsyncClientBuilder builder()
      Create a builder that can be used to configure and create a PaymentCryptographyDataAsyncClient.