Module types

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that Payment Cryptography Data Plane can respond with.

Structs§

AmexAttributes

Parameters to derive the confidentiality and integrity keys for a payment card using Amex derivation method.

AmexCardSecurityCodeVersion1

Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.

AmexCardSecurityCodeVersion2

Card data parameters that are required to generate a Card Security Code (CSC2) for an AMEX payment card.

AsymmetricEncryptionAttributes

Parameters for plaintext encryption using asymmetric keys.

CardHolderVerificationValue

Card data parameters that are required to generate a cardholder verification value for the payment card.

CardVerificationValue1

Card data parameters that are required to verify CVV (Card Verification Value) for the payment card.

CardVerificationValue2

Card data parameters that are required to verify Card Verification Value (CVV2) for the payment card.

CryptogramVerificationArpcMethod1

Parameters that are required for ARPC response generation using method1 after ARQC verification is successful.

CryptogramVerificationArpcMethod2

Parameters that are required for ARPC response generation using method2 after ARQC verification is successful.

CurrentPinAttributes

The parameter values of the current PIN to be changed on the EMV chip card.

DiscoverDynamicCardVerificationCode

Parameters that are required to generate or verify dCVC (Dynamic Card Verification Code).

DukptAttributes

Parameters that are used for Derived Unique Key Per Transaction (DUKPT) derivation algorithm.

DukptDerivationAttributes

Parameters required for encryption or decryption of data using DUKPT.

DukptEncryptionAttributes

Parameters that are required to encrypt plaintext data using DUKPT.

DynamicCardVerificationCode

Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).

DynamicCardVerificationValue

Parameters that are required to generate or verify Dynamic Card Verification Value (dCVV).

EcdhDerivationAttributes

Parameters required to establish ECDH based key exchange.

Emv2000Attributes

Parameters to derive the confidentiality and integrity keys for a payment card using EMV2000 deruv.

EmvCommonAttributes

Parameters to derive the confidentiality and integrity keys for an Emv common payment card.

EmvEncryptionAttributes

Parameters for plaintext encryption using EMV keys.

Ibm3624NaturalPin

Parameters that are required to generate or verify Ibm3624 natural PIN.

Ibm3624PinFromOffset

Parameters that are required to generate or verify Ibm3624 PIN from offset PIN.

Ibm3624PinOffset

Pparameters that are required to generate or verify Ibm3624 PIN offset PIN.

Ibm3624PinVerification

Parameters that are required to generate or verify Ibm3624 PIN verification PIN.

Ibm3624RandomPin

Parameters that are required to generate or verify Ibm3624 random PIN.

MacAlgorithmDukpt

Parameters required for DUKPT MAC generation and verification.

MacAlgorithmEmv

Parameters that are required for EMV MAC generation and verification.

MasterCardAttributes

Parameters to derive the confidentiality and integrity keys for a Mastercard payment card.

SessionKeyAmex

Parameters to derive session key for an Amex payment card.

SessionKeyEmv2000

Parameters to derive session key for an Emv2000 payment card for ARQC verification.

SessionKeyEmvCommon

Parameters to derive session key for an Emv common payment card for ARQC verification.

SessionKeyMastercard

Parameters to derive session key for Mastercard payment card for ARQC verification.

SessionKeyVisa

Parameters to derive session key for Visa payment card for ARQC verification.

SymmetricEncryptionAttributes

Parameters requried to encrypt plaintext data using symmetric keys.

TranslationPinDataIsoFormat034

Parameters that are required for tranlation between ISO9564 PIN format 0,3,4 tranlation.

TranslationPinDataIsoFormat1

Parameters that are required for ISO9564 PIN format 1 tranlation.

ValidationExceptionField

The request was denied due to an invalid request error.

VisaAmexDerivationOutputs

The attributes values used for Amex and Visa derivation methods.

VisaAttributes

Parameters to derive the confidentiality and integrity keys for a Visa payment card.

VisaPin

Parameters that are required to generate or verify Visa PIN.

VisaPinVerification

Parameters that are required to generate or verify Visa PIN.

VisaPinVerificationValue

Parameters that are required to generate or verify Visa PVV (PIN Verification Value).

WrappedKey

Parameter information of a WrappedKeyBlock for encryption key exchange.

Enums§

CardGenerationAttributes

Card data parameters that are required to generate Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).

CardVerificationAttributes

Card data parameters that are requried to verify Card Verification Values (CVV/CVV2), Dynamic Card Verification Values (dCVV/dCVV2), or Card Security Codes (CSC).

CryptogramAuthResponse

Parameters that are required for Authorization Response Cryptogram (ARPC) generation after Authorization Request Cryptogram (ARQC) verification is successful.

DerivationMethodAttributes

Parameters to derive the payment card specific confidentiality and integrity keys.

DukptDerivationType
When writing a match expression against DukptDerivationType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DukptEncryptionMode
When writing a match expression against DukptEncryptionMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DukptKeyVariant
When writing a match expression against DukptKeyVariant, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EmvEncryptionMode
When writing a match expression against EmvEncryptionMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EmvMajorKeyDerivationMode
When writing a match expression against EmvMajorKeyDerivationMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
EncryptionDecryptionAttributes

Parameters that are required to perform encryption and decryption operations.

EncryptionMode
When writing a match expression against EncryptionMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
KeyCheckValueAlgorithm
When writing a match expression against KeyCheckValueAlgorithm, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
KeyDerivationFunction
When writing a match expression against KeyDerivationFunction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
KeyDerivationHashAlgorithm
When writing a match expression against KeyDerivationHashAlgorithm, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MacAlgorithm
When writing a match expression against MacAlgorithm, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
MacAttributes

Parameters that are required for DUKPT, HMAC, or EMV MAC generation or verification.

MajorKeyDerivationMode
When writing a match expression against MajorKeyDerivationMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PaddingType
When writing a match expression against PaddingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PinBlockFormatForEmvPinChange
When writing a match expression against PinBlockFormatForEmvPinChange, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PinBlockFormatForPinData
When writing a match expression against PinBlockFormatForPinData, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PinBlockLengthPosition
When writing a match expression against PinBlockLengthPosition, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PinBlockPaddingType
When writing a match expression against PinBlockPaddingType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
PinData

Parameters that are required to generate, translate, or verify PIN data.

PinGenerationAttributes

Parameters that are required for PIN data generation.

PinVerificationAttributes

Parameters that are required for PIN data verification.

ReEncryptionAttributes

Parameters that are required to perform reencryption operation.

SessionKeyDerivation

Parameters to derive a session key for Authorization Response Cryptogram (ARQC) verification.

SessionKeyDerivationMode
When writing a match expression against SessionKeyDerivationMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SessionKeyDerivationValue

Parameters to derive session key value using a MAC EMV algorithm.

SymmetricKeyAlgorithm
When writing a match expression against SymmetricKeyAlgorithm, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
TranslationIsoFormats

Parameters that are required for translation between ISO9564 PIN block formats 0,1,3,4.

VerificationFailedReason
When writing a match expression against VerificationFailedReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
WrappedKeyMaterial

Parameter information of a WrappedKeyBlock for encryption key exchange.