Class VerifyPinDataRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.paymentcryptographydata.model.PaymentCryptographyDataRequest
software.amazon.awssdk.services.paymentcryptographydata.model.VerifyPinDataRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<VerifyPinDataRequest.Builder,VerifyPinDataRequest>
@Generated("software.amazon.awssdk:codegen") public final class VerifyPinDataRequest extends PaymentCryptographyDataRequest implements ToCopyableBuilder<VerifyPinDataRequest.Builder,VerifyPinDataRequest>

  • Method Details

    • verificationKeyIdentifier

      public final String verificationKeyIdentifier()

      The keyARN of the PIN verification key.

      Returns:
      The keyARN of the PIN verification key.

    • encryptionKeyIdentifier

      public final String encryptionKeyIdentifier()

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

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

    • verificationAttributes

      public final PinVerificationAttributes verificationAttributes()

      The attributes and values for PIN data verification.

      Returns:
      The attributes and values for PIN data verification.

    • encryptedPinBlock

      public final String encryptedPinBlock()

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

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

    • primaryAccountNumber

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

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

    • pinBlockFormat

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

      If the service returns an enum value that is not available in the current SDK version, pinBlockFormat will return PinBlockFormatForPinData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pinBlockFormatAsString().

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

      See Also:

    • pinBlockFormatAsString

      public final String pinBlockFormatAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, pinBlockFormat will return PinBlockFormatForPinData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pinBlockFormatAsString().

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

      See Also:

    • pinDataLength

      public final Integer pinDataLength()

      The length of PIN being verified.

      Returns:
      The length of PIN being verified.

    • dukptAttributes

      public final DukptAttributes dukptAttributes()

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

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

    • encryptionWrappedKey

      public final WrappedKey encryptionWrappedKey()
      Returns the value of the EncryptionWrappedKey property for this object.
      Returns:
      The value of the EncryptionWrappedKey property for this object.

    • toBuilder

      public VerifyPinDataRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<VerifyPinDataRequest.Builder,VerifyPinDataRequest>
      Specified by:
      toBuilder in class PaymentCryptographyDataRequest
      Returns:
      a builder for type T

    • builder

      public static VerifyPinDataRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends VerifyPinDataRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.