Class: AWS.PaymentCryptographyData

var params = {
  EncryptionAttributes: { /* required */
    Asymmetric: {
      PaddingType: PKCS1 | OAEP_SHA1 | OAEP_SHA256 | OAEP_SHA512
    },
    Dukpt: {
      KeySerialNumber: 'STRING_VALUE', /* required */
      DukptKeyDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256,
      DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE,
      InitializationVector: 'STRING_VALUE',
      Mode: ECB | CBC
    },
    Emv: {
      MajorKeyDerivationMode: EMV_OPTION_A | EMV_OPTION_B, /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      PrimaryAccountNumber: 'STRING_VALUE', /* required */
      SessionDerivationData: 'STRING_VALUE', /* required */
      InitializationVector: 'STRING_VALUE',
      Mode: ECB | CBC
    },
    Symmetric: {
      Mode: ECB | CBC | CFB | CFB1 | CFB8 | CFB64 | CFB128 | OFB, /* required */
      InitializationVector: 'STRING_VALUE',
      PaddingType: PKCS1 | OAEP_SHA1 | OAEP_SHA256 | OAEP_SHA512
    }
  },
  KeyIdentifier: 'STRING_VALUE', /* required */
  PlainText: 'STRING_VALUE' /* required */
};
paymentcryptographydata.encryptData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • EncryptionAttributes — (map)

    The encryption key type and attributes for plaintext encryption.

    • Asymmetric — (map)

      Parameters for plaintext encryption using asymmetric keys.

      • PaddingType — (String)

        The padding to be included with the data.

        Possible values include:
        • "PKCS1"
        • "OAEP_SHA1"
        • "OAEP_SHA256"
        • "OAEP_SHA512"
    • Dukpt — (map)

      Parameters that are required to encrypt plaintext data using DUKPT.

      • DukptKeyDerivationType — (String)

        The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

        Possible values include:
        • "TDES_2KEY"
        • "TDES_3KEY"
        • "AES_128"
        • "AES_192"
        • "AES_256"
      • DukptKeyVariant — (String)

        The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.

        Possible values include:
        • "BIDIRECTIONAL"
        • "REQUEST"
        • "RESPONSE"
      • InitializationVector — (String)

        An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

      • KeySerialNumber — required — (String)

        The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

      • Mode — (String)

        The block cipher method to use for encryption.

        The default is CBC.

        Possible values include:
        • "ECB"
        • "CBC"
    • Emv — (map)

      Parameters for plaintext encryption using EMV keys.

      • InitializationVector — (String)

        An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

      • MajorKeyDerivationMode — required — (String)

        The EMV derivation mode to use for ICC master key derivation as per EMV version 4.3 book 2.

        Possible values include:
        • "EMV_OPTION_A"
        • "EMV_OPTION_B"
      • Mode — (String)

        The block cipher method to use for encryption.

        Possible values include:
        • "ECB"
        • "CBC"
      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • PrimaryAccountNumber — required — (String)

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

      • SessionDerivationData — required — (String)

        The derivation value used to derive the ICC session key. It is typically the application transaction counter value padded with zeros or previous ARQC value padded with zeros as per EMV version 4.3 book 2.

    • Symmetric — (map)

      Parameters that are required to perform encryption and decryption using symmetric keys.

      • InitializationVector — (String)

        An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

      • Mode — required — (String)

        The block cipher method to use for encryption.

        Possible values include:
        • "ECB"
        • "CBC"
        • "CFB"
        • "CFB1"
        • "CFB8"
        • "CFB64"
        • "CFB128"
        • "OFB"
      • PaddingType — (String)

        The padding to be included with the data.

        Possible values include:
        • "PKCS1"
        • "OAEP_SHA1"
        • "OAEP_SHA256"
        • "OAEP_SHA512"
  • KeyIdentifier — (String)

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

  • PlainText — (String)

    The plaintext to be encrypted.

    Note: For encryption using asymmetric keys, plaintext data length is constrained by encryption key strength that you define in KeyAlgorithm and padding type that you define in AsymmetricEncryptionAttributes. For more information, see Encrypt data in the Amazon Web Services Payment Cryptography User Guide.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CipherText — (String)

      The encrypted ciphertext.

    • KeyArn — (String)

      The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

    • KeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GenerationAttributes: { /* required */
    AmexCardSecurityCodeVersion1: {
      CardExpiryDate: 'STRING_VALUE' /* required */
    },
    AmexCardSecurityCodeVersion2: {
      CardExpiryDate: 'STRING_VALUE', /* required */
      ServiceCode: 'STRING_VALUE' /* required */
    },
    CardHolderVerificationValue: {
      ApplicationTransactionCounter: 'STRING_VALUE', /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      UnpredictableNumber: 'STRING_VALUE' /* required */
    },
    CardVerificationValue1: {
      CardExpiryDate: 'STRING_VALUE', /* required */
      ServiceCode: 'STRING_VALUE' /* required */
    },
    CardVerificationValue2: {
      CardExpiryDate: 'STRING_VALUE' /* required */
    },
    DynamicCardVerificationCode: {
      ApplicationTransactionCounter: 'STRING_VALUE', /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      TrackData: 'STRING_VALUE', /* required */
      UnpredictableNumber: 'STRING_VALUE' /* required */
    },
    DynamicCardVerificationValue: {
      ApplicationTransactionCounter: 'STRING_VALUE', /* required */
      CardExpiryDate: 'STRING_VALUE', /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      ServiceCode: 'STRING_VALUE' /* required */
    }
  },
  KeyIdentifier: 'STRING_VALUE', /* required */
  PrimaryAccountNumber: 'STRING_VALUE', /* required */
  ValidationDataLength: 'NUMBER_VALUE'
};
paymentcryptographydata.generateCardValidationData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GenerationAttributes — (map)

    The algorithm for generating CVV or CSC values for the card within Amazon Web Services Payment Cryptography.

    • AmexCardSecurityCodeVersion1 — (map)

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

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

    • AmexCardSecurityCodeVersion2 — (map)

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

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

      • ServiceCode — required — (String)

        The service code of the AMEX payment card. This is different from the Card Security Code (CSC).

    • CardHolderVerificationValue — (map)

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

      • ApplicationTransactionCounter — required — (String)

        The transaction counter value that comes from a point of sale terminal.

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • UnpredictableNumber — required — (String)

        A random number generated by the issuer.

    • CardVerificationValue1 — (map)

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

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

      • ServiceCode — required — (String)

        The service code of the payment card. This is different from Card Security Code (CSC).

    • CardVerificationValue2 — (map)

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

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

    • DynamicCardVerificationCode — (map)

      Card data parameters that are required to generate CDynamic Card Verification Code (dCVC) for the payment card.

      • ApplicationTransactionCounter — required — (String)

        The transaction counter value that comes from the terminal.

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • TrackData — required — (String)

        The data on the two tracks of magnetic cards used for financial transactions. This includes the cardholder name, PAN, expiration date, bank ID (BIN) and several other numbers the issuing bank uses to validate the data received.

      • UnpredictableNumber — required — (String)

        A random number generated by the issuer.

    • DynamicCardVerificationValue — (map)

      Card data parameters that are required to generate CDynamic Card Verification Value (dCVV) for the payment card.

      • ApplicationTransactionCounter — required — (String)

        The transaction counter value that comes from the terminal.

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • ServiceCode — required — (String)

        The service code of the payment card. This is different from Card Security Code (CSC).

  • KeyIdentifier — (String)

    The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate card data.

  • PrimaryAccountNumber — (String)

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

  • ValidationDataLength — (Integer)

    The length of the CVV or CSC to be generated. The default value is 3.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • KeyArn — (String)

      The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to generate CVV or CSC.

    • KeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

    • ValidationData — (String)

      The CVV or CSC value that Amazon Web Services Payment Cryptography generates for the card.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  GenerationAttributes: { /* required */
    Algorithm: ISO9797_ALGORITHM1 | ISO9797_ALGORITHM3 | CMAC | HMAC_SHA224 | HMAC_SHA256 | HMAC_SHA384 | HMAC_SHA512,
    DukptCmac: {
      DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE, /* required */
      KeySerialNumber: 'STRING_VALUE', /* required */
      DukptDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256
    },
    DukptIso9797Algorithm1: {
      DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE, /* required */
      KeySerialNumber: 'STRING_VALUE', /* required */
      DukptDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256
    },
    DukptIso9797Algorithm3: {
      DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE, /* required */
      KeySerialNumber: 'STRING_VALUE', /* required */
      DukptDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256
    },
    EmvMac: {
      MajorKeyDerivationMode: EMV_OPTION_A | EMV_OPTION_B, /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      PrimaryAccountNumber: 'STRING_VALUE', /* required */
      SessionKeyDerivationMode: EMV_COMMON_SESSION_KEY | EMV2000 | AMEX | MASTERCARD_SESSION_KEY | VISA, /* required */
      SessionKeyDerivationValue: { /* required */
        ApplicationCryptogram: 'STRING_VALUE',
        ApplicationTransactionCounter: 'STRING_VALUE'
      }
    }
  },
  KeyIdentifier: 'STRING_VALUE', /* required */
  MessageData: 'STRING_VALUE', /* required */
  MacLength: 'NUMBER_VALUE'
};
paymentcryptographydata.generateMac(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • GenerationAttributes — (map)

    The attributes and data values to use for MAC generation within Amazon Web Services Payment Cryptography.

    • Algorithm — (String)

      The encryption algorithm for MAC generation or verification.

      Possible values include:
      • "ISO9797_ALGORITHM1"
      • "ISO9797_ALGORITHM3"
      • "CMAC"
      • "HMAC_SHA224"
      • "HMAC_SHA256"
      • "HMAC_SHA384"
      • "HMAC_SHA512"
    • DukptCmac — (map)

      Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.

      • DukptDerivationType — (String)

        The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.

        Possible values include:
        • "TDES_2KEY"
        • "TDES_3KEY"
        • "AES_128"
        • "AES_192"
        • "AES_256"
      • DukptKeyVariant — required — (String)

        The type of use of DUKPT, which can be MAC generation, MAC verification, or both.

        Possible values include:
        • "BIDIRECTIONAL"
        • "REQUEST"
        • "RESPONSE"
      • KeySerialNumber — required — (String)

        The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • DukptIso9797Algorithm1 — (map)

      Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.

      • DukptDerivationType — (String)

        The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.

        Possible values include:
        • "TDES_2KEY"
        • "TDES_3KEY"
        • "AES_128"
        • "AES_192"
        • "AES_256"
      • DukptKeyVariant — required — (String)

        The type of use of DUKPT, which can be MAC generation, MAC verification, or both.

        Possible values include:
        • "BIDIRECTIONAL"
        • "REQUEST"
        • "RESPONSE"
      • KeySerialNumber — required — (String)

        The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • DukptIso9797Algorithm3 — (map)

      Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.

      • DukptDerivationType — (String)

        The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.

        Possible values include:
        • "TDES_2KEY"
        • "TDES_3KEY"
        • "AES_128"
        • "AES_192"
        • "AES_256"
      • DukptKeyVariant — required — (String)

        The type of use of DUKPT, which can be MAC generation, MAC verification, or both.

        Possible values include:
        • "BIDIRECTIONAL"
        • "REQUEST"
        • "RESPONSE"
      • KeySerialNumber — required — (String)

        The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • EmvMac — (map)

      Parameters that are required for MAC generation or verification using EMV MAC algorithm.

      • MajorKeyDerivationMode — required — (String)

        The method to use when deriving the master key for EMV MAC generation or verification.

        Possible values include:
        • "EMV_OPTION_A"
        • "EMV_OPTION_B"
      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • PrimaryAccountNumber — required — (String)

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

      • SessionKeyDerivationMode — required — (String)

        The method of deriving a session key for EMV MAC generation or verification.

        Possible values include:
        • "EMV_COMMON_SESSION_KEY"
        • "EMV2000"
        • "AMEX"
        • "MASTERCARD_SESSION_KEY"
        • "VISA"
      • SessionKeyDerivationValue — required — (map)

        Parameters that are required to generate session key for EMV generation and verification.

        • ApplicationCryptogram — (String)

          The cryptogram provided by the terminal during transaction processing.

        • ApplicationTransactionCounter — (String)

          The transaction counter that is provided by the terminal during transaction processing.

  • KeyIdentifier — (String)

    The keyARN of the MAC generation encryption key.

  • MacLength — (Integer)

    The length of a MAC under generation.

  • MessageData — (String)

    The data for which a MAC is under generation. This value must be hexBinary.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • KeyArn — (String)

      The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC generation.

    • KeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

    • Mac — (String)

      The MAC cryptogram generated within Amazon Web Services Payment Cryptography.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EncryptionKeyIdentifier: 'STRING_VALUE', /* required */
  GenerationAttributes: { /* required */
    Ibm3624NaturalPin: {
      DecimalizationTable: 'STRING_VALUE', /* required */
      PinValidationData: 'STRING_VALUE', /* required */
      PinValidationDataPadCharacter: 'STRING_VALUE' /* required */
    },
    Ibm3624PinFromOffset: {
      DecimalizationTable: 'STRING_VALUE', /* required */
      PinOffset: 'STRING_VALUE', /* required */
      PinValidationData: 'STRING_VALUE', /* required */
      PinValidationDataPadCharacter: 'STRING_VALUE' /* required */
    },
    Ibm3624PinOffset: {
      DecimalizationTable: 'STRING_VALUE', /* required */
      EncryptedPinBlock: 'STRING_VALUE', /* required */
      PinValidationData: 'STRING_VALUE', /* required */
      PinValidationDataPadCharacter: 'STRING_VALUE' /* required */
    },
    Ibm3624RandomPin: {
      DecimalizationTable: 'STRING_VALUE', /* required */
      PinValidationData: 'STRING_VALUE', /* required */
      PinValidationDataPadCharacter: 'STRING_VALUE' /* required */
    },
    VisaPin: {
      PinVerificationKeyIndex: 'NUMBER_VALUE' /* required */
    },
    VisaPinVerificationValue: {
      EncryptedPinBlock: 'STRING_VALUE', /* required */
      PinVerificationKeyIndex: 'NUMBER_VALUE' /* required */
    }
  },
  GenerationKeyIdentifier: 'STRING_VALUE', /* required */
  PinBlockFormat: ISO_FORMAT_0 | ISO_FORMAT_3, /* required */
  PrimaryAccountNumber: 'STRING_VALUE', /* required */
  PinDataLength: 'NUMBER_VALUE'
};
paymentcryptographydata.generatePinData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • EncryptionKeyIdentifier — (String)

    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses to encrypt the PIN Block.

  • GenerationAttributes — (map)

    The attributes and values to use for PIN, PVV, or PIN Offset generation.

    • Ibm3624NaturalPin — (map)

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

      • DecimalizationTable — required — (String)

        The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.

      • PinValidationData — required — (String)

        The unique data for cardholder identification.

      • PinValidationDataPadCharacter — required — (String)

        The padding character for validation data.

    • Ibm3624PinFromOffset — (map)

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

      • DecimalizationTable — required — (String)

        The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.

      • PinOffset — required — (String)

        The PIN offset value.

      • PinValidationData — required — (String)

        The unique data for cardholder identification.

      • PinValidationDataPadCharacter — required — (String)

        The padding character for validation data.

    • Ibm3624PinOffset — (map)

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

      • DecimalizationTable — required — (String)

        The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.

      • EncryptedPinBlock — required — (String)

        The encrypted PIN block data. According to ISO 9564 standard, a PIN Block is an encoded representation of a payment card Personal Account Number (PAN) and the cardholder Personal Identification Number (PIN).

      • PinValidationData — required — (String)

        The unique data for cardholder identification.

      • PinValidationDataPadCharacter — required — (String)

        The padding character for validation data.

    • Ibm3624RandomPin — (map)

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

      • DecimalizationTable — required — (String)

        The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.

      • PinValidationData — required — (String)

        The unique data for cardholder identification.

      • PinValidationDataPadCharacter — required — (String)

        The padding character for validation data.

    • VisaPin — (map)

      Parameters that are required to generate or verify Visa PIN.

      • PinVerificationKeyIndex — required — (Integer)

        The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).

    • VisaPinVerificationValue — (map)

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

      • EncryptedPinBlock — required — (String)

        The encrypted PIN block data to verify.

      • PinVerificationKeyIndex — required — (Integer)

        The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).

  • GenerationKeyIdentifier — (String)

    The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for pin data generation.

  • PinBlockFormat — (String)

    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.

    Possible values include:
    • "ISO_FORMAT_0"
    • "ISO_FORMAT_3"
  • PinDataLength — (Integer)

    The length of PIN under generation.

  • PrimaryAccountNumber — (String)

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

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EncryptedPinBlock — (String)

      The PIN block encrypted under PEK from Amazon Web Services Payment Cryptography. The encrypted PIN block is a composite of PAN (Primary Account Number) and PIN (Personal Identification Number), generated in accordance with ISO 9564 standard.

    • EncryptionKeyArn — (String)

      The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.

    • EncryptionKeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

    • GenerationKeyArn — (String)

      The keyARN of the pin data generation key that Amazon Web Services Payment Cryptography uses for PIN, PVV or PIN Offset generation.

    • GenerationKeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

    • PinData — (map)

      The attributes and values Amazon Web Services Payment Cryptography uses for pin data generation.

      • PinOffset — (String)

        The PIN offset value.

      • VerificationValue — (String)

        The unique data to identify a cardholder. In most cases, this is the same as cardholder's Primary Account Number (PAN). If a value is not provided, it defaults to PAN.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  CipherText: 'STRING_VALUE', /* required */
  IncomingEncryptionAttributes: { /* required */
    Dukpt: {
      KeySerialNumber: 'STRING_VALUE', /* required */
      DukptKeyDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256,
      DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE,
      InitializationVector: 'STRING_VALUE',
      Mode: ECB | CBC
    },
    Symmetric: {
      Mode: ECB | CBC | CFB | CFB1 | CFB8 | CFB64 | CFB128 | OFB, /* required */
      InitializationVector: 'STRING_VALUE',
      PaddingType: PKCS1 | OAEP_SHA1 | OAEP_SHA256 | OAEP_SHA512
    }
  },
  IncomingKeyIdentifier: 'STRING_VALUE', /* required */
  OutgoingEncryptionAttributes: { /* required */
    Dukpt: {
      KeySerialNumber: 'STRING_VALUE', /* required */
      DukptKeyDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256,
      DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE,
      InitializationVector: 'STRING_VALUE',
      Mode: ECB | CBC
    },
    Symmetric: {
      Mode: ECB | CBC | CFB | CFB1 | CFB8 | CFB64 | CFB128 | OFB, /* required */
      InitializationVector: 'STRING_VALUE',
      PaddingType: PKCS1 | OAEP_SHA1 | OAEP_SHA256 | OAEP_SHA512
    }
  },
  OutgoingKeyIdentifier: 'STRING_VALUE' /* required */
};
paymentcryptographydata.reEncryptData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • CipherText — (String)

    Ciphertext to be encrypted. The minimum allowed length is 16 bytes and maximum allowed length is 4096 bytes.

  • IncomingEncryptionAttributes — (map)

    The attributes and values for incoming ciphertext.

    • Dukpt — (map)

      Parameters that are required to encrypt plaintext data using DUKPT.

      • DukptKeyDerivationType — (String)

        The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

        Possible values include:
        • "TDES_2KEY"
        • "TDES_3KEY"
        • "AES_128"
        • "AES_192"
        • "AES_256"
      • DukptKeyVariant — (String)

        The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.

        Possible values include:
        • "BIDIRECTIONAL"
        • "REQUEST"
        • "RESPONSE"
      • InitializationVector — (String)

        An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

      • KeySerialNumber — required — (String)

        The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

      • Mode — (String)

        The block cipher method to use for encryption.

        The default is CBC.

        Possible values include:
        • "ECB"
        • "CBC"
    • Symmetric — (map)

      Parameters that are required to encrypt data using symmetric keys.

      • InitializationVector — (String)

        An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

      • Mode — required — (String)

        The block cipher method to use for encryption.

        Possible values include:
        • "ECB"
        • "CBC"
        • "CFB"
        • "CFB1"
        • "CFB8"
        • "CFB64"
        • "CFB128"
        • "OFB"
      • PaddingType — (String)

        The padding to be included with the data.

        Possible values include:
        • "PKCS1"
        • "OAEP_SHA1"
        • "OAEP_SHA256"
        • "OAEP_SHA512"
  • IncomingKeyIdentifier — (String)

    The keyARN of the encryption key of incoming ciphertext data.

  • OutgoingEncryptionAttributes — (map)

    The attributes and values for outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.

    • Dukpt — (map)

      Parameters that are required to encrypt plaintext data using DUKPT.

      • DukptKeyDerivationType — (String)

        The key type encrypted using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

        Possible values include:
        • "TDES_2KEY"
        • "TDES_3KEY"
        • "AES_128"
        • "AES_192"
        • "AES_256"
      • DukptKeyVariant — (String)

        The type of use of DUKPT, which can be incoming data decryption, outgoing data encryption, or both.

        Possible values include:
        • "BIDIRECTIONAL"
        • "REQUEST"
        • "RESPONSE"
      • InitializationVector — (String)

        An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

      • KeySerialNumber — required — (String)

        The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

      • Mode — (String)

        The block cipher method to use for encryption.

        The default is CBC.

        Possible values include:
        • "ECB"
        • "CBC"
    • Symmetric — (map)

      Parameters that are required to encrypt data using symmetric keys.

      • InitializationVector — (String)

        An input used to provide the intial state. If no value is provided, Amazon Web Services Payment Cryptography defaults it to zero.

      • Mode — required — (String)

        The block cipher method to use for encryption.

        Possible values include:
        • "ECB"
        • "CBC"
        • "CFB"
        • "CFB1"
        • "CFB8"
        • "CFB64"
        • "CFB128"
        • "OFB"
      • PaddingType — (String)

        The padding to be included with the data.

        Possible values include:
        • "PKCS1"
        • "OAEP_SHA1"
        • "OAEP_SHA256"
        • "OAEP_SHA512"
  • OutgoingKeyIdentifier — (String)

    The keyARN of the encryption key of outgoing ciphertext data after encryption by Amazon Web Services Payment Cryptography.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • CipherText — (String)

      The encrypted ciphertext.

    • KeyArn — (String)

      The keyARN (Amazon Resource Name) of the encryption key that Amazon Web Services Payment Cryptography uses for plaintext encryption.

    • KeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EncryptedPinBlock: 'STRING_VALUE', /* required */
  IncomingKeyIdentifier: 'STRING_VALUE', /* required */
  IncomingTranslationAttributes: { /* required */
    IsoFormat0: {
      PrimaryAccountNumber: 'STRING_VALUE' /* required */
    },
    IsoFormat1: {
    },
    IsoFormat3: {
      PrimaryAccountNumber: 'STRING_VALUE' /* required */
    },
    IsoFormat4: {
      PrimaryAccountNumber: 'STRING_VALUE' /* required */
    }
  },
  OutgoingKeyIdentifier: 'STRING_VALUE', /* required */
  OutgoingTranslationAttributes: { /* required */
    IsoFormat0: {
      PrimaryAccountNumber: 'STRING_VALUE' /* required */
    },
    IsoFormat1: {
    },
    IsoFormat3: {
      PrimaryAccountNumber: 'STRING_VALUE' /* required */
    },
    IsoFormat4: {
      PrimaryAccountNumber: 'STRING_VALUE' /* required */
    }
  },
  IncomingDukptAttributes: {
    KeySerialNumber: 'STRING_VALUE', /* required */
    DukptKeyDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256,
    DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE
  },
  OutgoingDukptAttributes: {
    KeySerialNumber: 'STRING_VALUE', /* required */
    DukptKeyDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256,
    DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE
  }
};
paymentcryptographydata.translatePinData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • EncryptedPinBlock — (String)

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

  • IncomingDukptAttributes — (map)

    The attributes and values to use for incoming DUKPT encryption key for PIN block translation.

    • DukptKeyDerivationType — (String)

      The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

      Possible values include:
      • "TDES_2KEY"
      • "TDES_3KEY"
      • "AES_128"
      • "AES_192"
      • "AES_256"
    • DukptKeyVariant — (String)

      The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.

      Possible values include:
      • "BIDIRECTIONAL"
      • "REQUEST"
      • "RESPONSE"
    • KeySerialNumber — required — (String)

      The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

  • IncomingKeyIdentifier — (String)

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

  • IncomingTranslationAttributes — (map)

    The format of the incoming PIN block data for translation within Amazon Web Services Payment Cryptography.

    • IsoFormat0 — (map)

      Parameters that are required for ISO9564 PIN format 0 tranlation.

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

    • IsoFormat1 — (map)

      Parameters that are required for ISO9564 PIN format 1 tranlation.

    • IsoFormat3 — (map)

      Parameters that are required for ISO9564 PIN format 3 tranlation.

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

    • IsoFormat4 — (map)

      Parameters that are required for ISO9564 PIN format 4 tranlation.

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

  • OutgoingDukptAttributes — (map)

    The attributes and values to use for outgoing DUKPT encryption key after PIN block translation.

    • DukptKeyDerivationType — (String)

      The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY

      Possible values include:
      • "TDES_2KEY"
      • "TDES_3KEY"
      • "AES_128"
      • "AES_192"
      • "AES_256"
    • DukptKeyVariant — (String)

      The type of use of DUKPT, which can be for incoming data decryption, outgoing data encryption, or both.

      Possible values include:
      • "BIDIRECTIONAL"
      • "REQUEST"
      • "RESPONSE"
    • KeySerialNumber — required — (String)

      The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

  • OutgoingKeyIdentifier — (String)

    The keyARN of the encryption key for encrypting outgoing PIN block data. This key type can be PEK or BDK.

  • OutgoingTranslationAttributes — (map)

    The format of the outgoing PIN block data after translation by Amazon Web Services Payment Cryptography.

    • IsoFormat0 — (map)

      Parameters that are required for ISO9564 PIN format 0 tranlation.

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

    • IsoFormat1 — (map)

      Parameters that are required for ISO9564 PIN format 1 tranlation.

    • IsoFormat3 — (map)

      Parameters that are required for ISO9564 PIN format 3 tranlation.

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

    • IsoFormat4 — (map)

      Parameters that are required for ISO9564 PIN format 4 tranlation.

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • KeyArn — (String)

      The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to encrypt outgoing PIN block data after translation.

    • KeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

    • PinBlock — (String)

      The outgoing encrypted PIN block data after translation.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  AuthRequestCryptogram: 'STRING_VALUE', /* required */
  KeyIdentifier: 'STRING_VALUE', /* required */
  MajorKeyDerivationMode: EMV_OPTION_A | EMV_OPTION_B, /* required */
  SessionKeyDerivationAttributes: { /* required */
    Amex: {
      PanSequenceNumber: 'STRING_VALUE', /* required */
      PrimaryAccountNumber: 'STRING_VALUE' /* required */
    },
    Emv2000: {
      ApplicationTransactionCounter: 'STRING_VALUE', /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      PrimaryAccountNumber: 'STRING_VALUE' /* required */
    },
    EmvCommon: {
      ApplicationTransactionCounter: 'STRING_VALUE', /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      PrimaryAccountNumber: 'STRING_VALUE' /* required */
    },
    Mastercard: {
      ApplicationTransactionCounter: 'STRING_VALUE', /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      PrimaryAccountNumber: 'STRING_VALUE', /* required */
      UnpredictableNumber: 'STRING_VALUE' /* required */
    },
    Visa: {
      PanSequenceNumber: 'STRING_VALUE', /* required */
      PrimaryAccountNumber: 'STRING_VALUE' /* required */
    }
  },
  TransactionData: 'STRING_VALUE', /* required */
  AuthResponseAttributes: {
    ArpcMethod1: {
      AuthResponseCode: 'STRING_VALUE' /* required */
    },
    ArpcMethod2: {
      CardStatusUpdate: 'STRING_VALUE', /* required */
      ProprietaryAuthenticationData: 'STRING_VALUE'
    }
  }
};
paymentcryptographydata.verifyAuthRequestCryptogram(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • AuthRequestCryptogram — (String)

    The auth request cryptogram imported into Amazon Web Services Payment Cryptography for ARQC verification using a major encryption key and transaction data.

  • AuthResponseAttributes — (map)

    The attributes and values for auth request cryptogram verification. These parameters are required in case using ARPC Method 1 or Method 2 for ARQC verification.

    • ArpcMethod1 — (map)

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

      • AuthResponseCode — required — (String)

        The auth code used to calculate APRC after ARQC verification is successful. This is the same auth code used for ARQC generation outside of Amazon Web Services Payment Cryptography.

    • ArpcMethod2 — (map)

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

      • CardStatusUpdate — required — (String)

        The data indicating whether the issuer approves or declines an online transaction using an EMV chip card.

      • ProprietaryAuthenticationData — (String)

        The proprietary authentication data used by issuer for communication during online transaction using an EMV chip card.

  • KeyIdentifier — (String)

    The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.

  • MajorKeyDerivationMode — (String)

    The method to use when deriving the major encryption key for ARQC verification within Amazon Web Services Payment Cryptography. The same key derivation mode was used for ARQC generation outside of Amazon Web Services Payment Cryptography.

    Possible values include:
    • "EMV_OPTION_A"
    • "EMV_OPTION_B"
  • SessionKeyDerivationAttributes — (map)

    The attributes and values to use for deriving a session key for ARQC verification within Amazon Web Services Payment Cryptography. The same attributes were used for ARQC generation outside of Amazon Web Services Payment Cryptography.

    • Amex — (map)

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

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

    • Emv2000 — (map)

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

      • ApplicationTransactionCounter — required — (String)

        The transaction counter that is provided by the terminal during transaction processing.

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

    • EmvCommon — (map)

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

      • ApplicationTransactionCounter — required — (String)

        The transaction counter that is provided by the terminal during transaction processing.

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

    • Mastercard — (map)

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

      • ApplicationTransactionCounter — required — (String)

        The transaction counter that is provided by the terminal during transaction processing.

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

      • UnpredictableNumber — required — (String)

        A random number generated by the issuer.

    • Visa — (map)

      Parameters to derive session key for a Visa payment cardfor ARQC verification.

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • PrimaryAccountNumber — required — (String)

        The Primary Account Number (PAN) of the cardholder. A PAN is a unique identifier for a payment credit or debit card and associates the card to a specific account holder.

  • TransactionData — (String)

    The transaction data that Amazon Web Services Payment Cryptography uses for ARQC verification. The same transaction is used for ARQC generation outside of Amazon Web Services Payment Cryptography.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • AuthResponseValue — (String)

      The result for ARQC verification or ARPC generation within Amazon Web Services Payment Cryptography.

    • KeyArn — (String)

      The keyARN of the major encryption key that Amazon Web Services Payment Cryptography uses for ARQC verification.

    • KeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  KeyIdentifier: 'STRING_VALUE', /* required */
  PrimaryAccountNumber: 'STRING_VALUE', /* required */
  ValidationData: 'STRING_VALUE', /* required */
  VerificationAttributes: { /* required */
    AmexCardSecurityCodeVersion1: {
      CardExpiryDate: 'STRING_VALUE' /* required */
    },
    AmexCardSecurityCodeVersion2: {
      CardExpiryDate: 'STRING_VALUE', /* required */
      ServiceCode: 'STRING_VALUE' /* required */
    },
    CardHolderVerificationValue: {
      ApplicationTransactionCounter: 'STRING_VALUE', /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      UnpredictableNumber: 'STRING_VALUE' /* required */
    },
    CardVerificationValue1: {
      CardExpiryDate: 'STRING_VALUE', /* required */
      ServiceCode: 'STRING_VALUE' /* required */
    },
    CardVerificationValue2: {
      CardExpiryDate: 'STRING_VALUE' /* required */
    },
    DiscoverDynamicCardVerificationCode: {
      ApplicationTransactionCounter: 'STRING_VALUE', /* required */
      CardExpiryDate: 'STRING_VALUE', /* required */
      UnpredictableNumber: 'STRING_VALUE' /* required */
    },
    DynamicCardVerificationCode: {
      ApplicationTransactionCounter: 'STRING_VALUE', /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      TrackData: 'STRING_VALUE', /* required */
      UnpredictableNumber: 'STRING_VALUE' /* required */
    },
    DynamicCardVerificationValue: {
      ApplicationTransactionCounter: 'STRING_VALUE', /* required */
      CardExpiryDate: 'STRING_VALUE', /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      ServiceCode: 'STRING_VALUE' /* required */
    }
  }
};
paymentcryptographydata.verifyCardValidationData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • KeyIdentifier — (String)

    The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify card data.

  • PrimaryAccountNumber — (String)

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

  • ValidationData — (String)

    The CVV or CSC value for use for card data verification within Amazon Web Services Payment Cryptography.

  • VerificationAttributes — (map)

    The algorithm to use for verification of card data within Amazon Web Services Payment Cryptography.

    • AmexCardSecurityCodeVersion1 — (map)

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

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

    • AmexCardSecurityCodeVersion2 — (map)

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

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

      • ServiceCode — required — (String)

        The service code of the AMEX payment card. This is different from the Card Security Code (CSC).

    • CardHolderVerificationValue — (map)

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

      • ApplicationTransactionCounter — required — (String)

        The transaction counter value that comes from a point of sale terminal.

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • UnpredictableNumber — required — (String)

        A random number generated by the issuer.

    • CardVerificationValue1 — (map)

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

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

      • ServiceCode — required — (String)

        The service code of the payment card. This is different from Card Security Code (CSC).

    • CardVerificationValue2 — (map)

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

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

    • DiscoverDynamicCardVerificationCode — (map)

      Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.

      • ApplicationTransactionCounter — required — (String)

        The transaction counter value that comes from the terminal.

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

      • UnpredictableNumber — required — (String)

        A random number that is generated by the issuer.

    • DynamicCardVerificationCode — (map)

      Card data parameters that are required to verify CDynamic Card Verification Code (dCVC) for the payment card.

      • ApplicationTransactionCounter — required — (String)

        The transaction counter value that comes from the terminal.

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • TrackData — required — (String)

        The data on the two tracks of magnetic cards used for financial transactions. This includes the cardholder name, PAN, expiration date, bank ID (BIN) and several other numbers the issuing bank uses to validate the data received.

      • UnpredictableNumber — required — (String)

        A random number generated by the issuer.

    • DynamicCardVerificationValue — (map)

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

      • ApplicationTransactionCounter — required — (String)

        The transaction counter value that comes from the terminal.

      • CardExpiryDate — required — (String)

        The expiry date of a payment card.

      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • ServiceCode — required — (String)

        The service code of the payment card. This is different from Card Security Code (CSC).

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • KeyArn — (String)

      The keyARN of the CVK encryption key that Amazon Web Services Payment Cryptography uses to verify CVV or CSC.

    • KeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  KeyIdentifier: 'STRING_VALUE', /* required */
  Mac: 'STRING_VALUE', /* required */
  MessageData: 'STRING_VALUE', /* required */
  VerificationAttributes: { /* required */
    Algorithm: ISO9797_ALGORITHM1 | ISO9797_ALGORITHM3 | CMAC | HMAC_SHA224 | HMAC_SHA256 | HMAC_SHA384 | HMAC_SHA512,
    DukptCmac: {
      DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE, /* required */
      KeySerialNumber: 'STRING_VALUE', /* required */
      DukptDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256
    },
    DukptIso9797Algorithm1: {
      DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE, /* required */
      KeySerialNumber: 'STRING_VALUE', /* required */
      DukptDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256
    },
    DukptIso9797Algorithm3: {
      DukptKeyVariant: BIDIRECTIONAL | REQUEST | RESPONSE, /* required */
      KeySerialNumber: 'STRING_VALUE', /* required */
      DukptDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256
    },
    EmvMac: {
      MajorKeyDerivationMode: EMV_OPTION_A | EMV_OPTION_B, /* required */
      PanSequenceNumber: 'STRING_VALUE', /* required */
      PrimaryAccountNumber: 'STRING_VALUE', /* required */
      SessionKeyDerivationMode: EMV_COMMON_SESSION_KEY | EMV2000 | AMEX | MASTERCARD_SESSION_KEY | VISA, /* required */
      SessionKeyDerivationValue: { /* required */
        ApplicationCryptogram: 'STRING_VALUE',
        ApplicationTransactionCounter: 'STRING_VALUE'
      }
    }
  },
  MacLength: 'NUMBER_VALUE'
};
paymentcryptographydata.verifyMac(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • KeyIdentifier — (String)

    The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses to verify MAC data.

  • Mac — (String)

    The MAC being verified.

  • MacLength — (Integer)

    The length of the MAC.

  • MessageData — (String)

    The data on for which MAC is under verification. This value must be hexBinary.

  • VerificationAttributes — (map)

    The attributes and data values to use for MAC verification within Amazon Web Services Payment Cryptography.

    • Algorithm — (String)

      The encryption algorithm for MAC generation or verification.

      Possible values include:
      • "ISO9797_ALGORITHM1"
      • "ISO9797_ALGORITHM3"
      • "CMAC"
      • "HMAC_SHA224"
      • "HMAC_SHA256"
      • "HMAC_SHA384"
      • "HMAC_SHA512"
    • DukptCmac — (map)

      Parameters that are required for MAC generation or verification using DUKPT CMAC algorithm.

      • DukptDerivationType — (String)

        The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.

        Possible values include:
        • "TDES_2KEY"
        • "TDES_3KEY"
        • "AES_128"
        • "AES_192"
        • "AES_256"
      • DukptKeyVariant — required — (String)

        The type of use of DUKPT, which can be MAC generation, MAC verification, or both.

        Possible values include:
        • "BIDIRECTIONAL"
        • "REQUEST"
        • "RESPONSE"
      • KeySerialNumber — required — (String)

        The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • DukptIso9797Algorithm1 — (map)

      Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm1.

      • DukptDerivationType — (String)

        The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.

        Possible values include:
        • "TDES_2KEY"
        • "TDES_3KEY"
        • "AES_128"
        • "AES_192"
        • "AES_256"
      • DukptKeyVariant — required — (String)

        The type of use of DUKPT, which can be MAC generation, MAC verification, or both.

        Possible values include:
        • "BIDIRECTIONAL"
        • "REQUEST"
        • "RESPONSE"
      • KeySerialNumber — required — (String)

        The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • DukptIso9797Algorithm3 — (map)

      Parameters that are required for MAC generation or verification using DUKPT ISO 9797 algorithm3.

      • DukptDerivationType — (String)

        The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.

        Possible values include:
        • "TDES_2KEY"
        • "TDES_3KEY"
        • "AES_128"
        • "AES_192"
        • "AES_256"
      • DukptKeyVariant — required — (String)

        The type of use of DUKPT, which can be MAC generation, MAC verification, or both.

        Possible values include:
        • "BIDIRECTIONAL"
        • "REQUEST"
        • "RESPONSE"
      • KeySerialNumber — required — (String)

        The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

    • EmvMac — (map)

      Parameters that are required for MAC generation or verification using EMV MAC algorithm.

      • MajorKeyDerivationMode — required — (String)

        The method to use when deriving the master key for EMV MAC generation or verification.

        Possible values include:
        • "EMV_OPTION_A"
        • "EMV_OPTION_B"
      • PanSequenceNumber — required — (String)

        A number that identifies and differentiates payment cards with the same Primary Account Number (PAN).

      • PrimaryAccountNumber — required — (String)

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

      • SessionKeyDerivationMode — required — (String)

        The method of deriving a session key for EMV MAC generation or verification.

        Possible values include:
        • "EMV_COMMON_SESSION_KEY"
        • "EMV2000"
        • "AMEX"
        • "MASTERCARD_SESSION_KEY"
        • "VISA"
      • SessionKeyDerivationValue — required — (map)

        Parameters that are required to generate session key for EMV generation and verification.

        • ApplicationCryptogram — (String)

          The cryptogram provided by the terminal during transaction processing.

        • ApplicationTransactionCounter — (String)

          The transaction counter that is provided by the terminal during transaction processing.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • KeyArn — (String)

      The keyARN of the encryption key that Amazon Web Services Payment Cryptography uses for MAC verification.

    • KeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.

var params = {
  EncryptedPinBlock: 'STRING_VALUE', /* required */
  EncryptionKeyIdentifier: 'STRING_VALUE', /* required */
  PinBlockFormat: ISO_FORMAT_0 | ISO_FORMAT_3, /* required */
  PrimaryAccountNumber: 'STRING_VALUE', /* required */
  VerificationAttributes: { /* required */
    Ibm3624Pin: {
      DecimalizationTable: 'STRING_VALUE', /* required */
      PinOffset: 'STRING_VALUE', /* required */
      PinValidationData: 'STRING_VALUE', /* required */
      PinValidationDataPadCharacter: 'STRING_VALUE' /* required */
    },
    VisaPin: {
      PinVerificationKeyIndex: 'NUMBER_VALUE', /* required */
      VerificationValue: 'STRING_VALUE' /* required */
    }
  },
  VerificationKeyIdentifier: 'STRING_VALUE', /* required */
  DukptAttributes: {
    DukptDerivationType: TDES_2KEY | TDES_3KEY | AES_128 | AES_192 | AES_256, /* required */
    KeySerialNumber: 'STRING_VALUE' /* required */
  },
  PinDataLength: 'NUMBER_VALUE'
};
paymentcryptographydata.verifyPinData(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

• params (Object) (defaults to: {}) —
  • DukptAttributes — (map)

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

    • DukptDerivationType — required — (String)

      The key type derived using DUKPT from a Base Derivation Key (BDK) and Key Serial Number (KSN). This must be less than or equal to the strength of the BDK. For example, you can't use AES_128 as a derivation type for a BDK of AES_128 or TDES_2KEY.

      Possible values include:
      • "TDES_2KEY"
      • "TDES_3KEY"
      • "AES_128"
      • "AES_192"
      • "AES_256"
    • KeySerialNumber — required — (String)

      The unique identifier known as Key Serial Number (KSN) that comes from an encrypting device using DUKPT encryption method. The KSN is derived from the encrypting device unique identifier and an internal transaction counter.

  • EncryptedPinBlock — (String)

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

  • EncryptionKeyIdentifier — (String)

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

  • PinBlockFormat — (String)

    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.

    Possible values include:
    • "ISO_FORMAT_0"
    • "ISO_FORMAT_3"
  • PinDataLength — (Integer)

    The length of PIN being verified.

  • PrimaryAccountNumber — (String)

    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 — (map)

    The attributes and values for PIN data verification.

    • Ibm3624Pin — (map)

      Parameters that are required to generate or verify Ibm3624 PIN.

      • DecimalizationTable — required — (String)

        The decimalization table to use for IBM 3624 PIN algorithm. The table is used to convert the algorithm intermediate result from hexadecimal characters to decimal.

      • PinOffset — required — (String)

        The PIN offset value.

      • PinValidationData — required — (String)

        The unique data for cardholder identification.

      • PinValidationDataPadCharacter — required — (String)

        The padding character for validation data.

    • VisaPin — (map)

      Parameters that are required to generate or verify Visa PIN.

      • PinVerificationKeyIndex — required — (Integer)

        The value for PIN verification index. It is used in the Visa PIN algorithm to calculate the PVV (PIN Verification Value).

      • VerificationValue — required — (String)

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

  • VerificationKeyIdentifier — (String)

    The keyARN of the PIN verification key.

Callback (callback):

• function(err, data) { ... }

  Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

  Context (this):

  • (AWS.Response) —

    the response object containing error, data properties, and the original request object.

  Parameters:

  • err (Error) —

    the error object returned from the request. Set to null if the request is successful.

  • data (Object) —

    the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

    • EncryptionKeyArn — (String)

      The keyARN of the PEK that Amazon Web Services Payment Cryptography uses for encrypted pin block generation.

    • EncryptionKeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

    • VerificationKeyArn — (String)

      The keyARN of the PIN encryption key that Amazon Web Services Payment Cryptography uses for PIN or PIN Offset verification.

    • VerificationKeyCheckValue — (String)

      The key check value (KCV) of the encryption key. The KCV is used to check if all parties holding a given key have the same key or to detect that a key has changed.

      Amazon Web Services Payment Cryptography computes the KCV according to the CMAC specification.

Returns:

• (AWS.Request) —

  a handle to the operation request for subsequent event callback registration.