Interface VerifyPinDataRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<VerifyPinDataRequest.Builder,VerifyPinDataRequest>, PaymentCryptographyDataRequest.Builder, SdkBuilder<VerifyPinDataRequest.Builder,VerifyPinDataRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
VerifyPinDataRequest
@Mutable @NotThreadSafe public static interface VerifyPinDataRequest.Builder extends PaymentCryptographyDataRequest.Builder, SdkPojo, CopyableBuilder<VerifyPinDataRequest.Builder,VerifyPinDataRequest>

  • Method Details

    • verificationKeyIdentifier

      VerifyPinDataRequest.Builder verificationKeyIdentifier(String verificationKeyIdentifier)

      The keyARN of the PIN verification key.

      Parameters:
      verificationKeyIdentifier - The keyARN of the PIN verification key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionKeyIdentifier

      VerifyPinDataRequest.Builder encryptionKeyIdentifier(String encryptionKeyIdentifier)

      The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.

      Parameters:
      encryptionKeyIdentifier - The keyARN of the encryption key under which the PIN block data is encrypted. This key type can be PEK or BDK.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • verificationAttributes

      VerifyPinDataRequest.Builder verificationAttributes(PinVerificationAttributes verificationAttributes)

      The attributes and values for PIN data verification.

      Parameters:
      verificationAttributes - The attributes and values for PIN data verification.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • verificationAttributes

      default VerifyPinDataRequest.Builder verificationAttributes(Consumer<PinVerificationAttributes.Builder> verificationAttributes)

      The attributes and values for PIN data verification.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to verificationAttributes(PinVerificationAttributes).

      Parameters:
      verificationAttributes - a consumer that will call methods on PinVerificationAttributes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryptedPinBlock

      VerifyPinDataRequest.Builder encryptedPinBlock(String encryptedPinBlock)

      The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.

      Parameters:
      encryptedPinBlock - The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • primaryAccountNumber

      VerifyPinDataRequest.Builder primaryAccountNumber(String primaryAccountNumber)

      The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.

      Parameters:
      primaryAccountNumber - The Primary Account Number (PAN), a unique identifier for a payment credit or debit card that associates the card with a specific account holder.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • pinBlockFormat

      VerifyPinDataRequest.Builder pinBlockFormat(String pinBlockFormat)

      The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.

      The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.

      The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.

      Parameters:
      pinBlockFormat - The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.

      The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.

      The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pinBlockFormat

      VerifyPinDataRequest.Builder pinBlockFormat(PinBlockFormatForPinData pinBlockFormat)

      The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.

      The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.

      The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.

      Parameters:
      pinBlockFormat - The PIN encoding format for pin data generation as specified in ISO 9564. Amazon Web Services Payment Cryptography supports ISO_Format_0 and ISO_Format_3.

      The ISO_Format_0 PIN block format is equivalent to the ANSI X9.8, VISA-1, and ECI-1 PIN block formats. It is similar to a VISA-4 PIN block format. It supports a PIN from 4 to 12 digits in length.

      The ISO_Format_3 PIN block format is the same as ISO_Format_0 except that the fill digits are random values from 10 to 15.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pinDataLength

      VerifyPinDataRequest.Builder pinDataLength(Integer pinDataLength)

      The length of PIN being verified.

      Parameters:
      pinDataLength - The length of PIN being verified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dukptAttributes

      VerifyPinDataRequest.Builder dukptAttributes(DukptAttributes dukptAttributes)

      The attributes and values for the DUKPT encrypted PIN block data.

      Parameters:
      dukptAttributes - The attributes and values for the DUKPT encrypted PIN block data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dukptAttributes

      default VerifyPinDataRequest.Builder dukptAttributes(Consumer<DukptAttributes.Builder> dukptAttributes)

      The attributes and values for the DUKPT encrypted PIN block data.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dukptAttributes(DukptAttributes).

      Parameters:
      dukptAttributes - a consumer that will call methods on DukptAttributes.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • encryptionWrappedKey

      VerifyPinDataRequest.Builder encryptionWrappedKey(WrappedKey encryptionWrappedKey)
      Sets the value of the EncryptionWrappedKey property for this object.
      Parameters:
      encryptionWrappedKey - The new value for the EncryptionWrappedKey property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionWrappedKey

      default VerifyPinDataRequest.Builder encryptionWrappedKey(Consumer<WrappedKey.Builder> encryptionWrappedKey)
      Sets the value of the EncryptionWrappedKey property for this object. This is a convenience method that creates an instance of the WrappedKey.Builder avoiding the need to create one manually via WrappedKey.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to encryptionWrappedKey(WrappedKey).

      Parameters:
      encryptionWrappedKey - a consumer that will call methods on WrappedKey.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      VerifyPinDataRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      VerifyPinDataRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.