Package software.amazon.awssdk.services.paymentcryptographydata.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VerifyPinDataRequest.Builder

Method Summary

Modifier and Type	Method	Description
static VerifyPinDataRequest.Builder	builder()
DukptAttributes	dukptAttributes()	The attributes and values for the DUKPT encrypted PIN block data.
String	encryptedPinBlock()	The encrypted PIN block data that Amazon Web Services Payment Cryptography verifies.
String	encryptionKeyIdentifier()	The keyARN of the encryption key under which the PIN block data is encrypted.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PinBlockFormatForPinData	pinBlockFormat()	The PIN encoding format for pin data generation as specified in ISO 9564.
String	pinBlockFormatAsString()	The PIN encoding format for pin data generation as specified in ISO 9564.
Integer	pinDataLength()	The length of PIN being verified.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends VerifyPinDataRequest.Builder>	serializableBuilderClass()
VerifyPinDataRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PinVerificationAttributes	verificationAttributes()	The attributes and values for PIN data verification.
String	verificationKeyIdentifier()	The keyARN of the PIN verification key.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

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.

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.

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:

PinBlockFormatForPinData

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:

PinBlockFormatForPinData

pinDataLength

public final Integer pinDataLength()

The length of PIN being verified.

Returns:

The length of PIN being verified.

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.

verificationAttributes

public final PinVerificationAttributes verificationAttributes()

The attributes and values for PIN data verification.

Returns:

The attributes and values for PIN data verification.

verificationKeyIdentifier

public final String verificationKeyIdentifier()

The keyARN of the PIN verification key.

Returns:

The keyARN of the PIN verification key.

toBuilder

public VerifyPinDataRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VerifyPinDataRequest.Builder,VerifyPinDataRequest>

Specified by:

toBuilder in class PaymentCryptographyDataRequest

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo