Translate Pin Data

paymentcryptographydataplane_translate_pin_data

R Documentation

Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4

Description

Translates encrypted PIN block from and to ISO 9564 formats 0,1,3,4. For more information, see Translate PIN data in the Amazon Web Services Payment Cryptography User Guide.

PIN block translation involves changing the encrytion of PIN block from one encryption key to another encryption key and changing PIN block format from one to another without PIN block data leaving Amazon Web Services Payment Cryptography. The encryption key transformation can be from PEK (Pin Encryption Key) to BDK (Base Derivation Key) for DUKPT or from BDK for DUKPT to PEK. Amazon Web Services Payment Cryptography supports TDES and AES key derivation type for DUKPT translations.

The allowed combinations of PIN block format translations are guided by PCI. It is important to note that not all encrypted PIN block formats (example, format 1) require PAN (Primary Account Number) as input. And as such, PIN block format that requires PAN (example, formats 0,3,4) cannot be translated to a format (format 1) that does not require a PAN for generation.

For information about valid keys for this operation, see Understanding key attributes and Key types for specific data operations in the Amazon Web Services Payment Cryptography User Guide.

Amazon Web Services Payment Cryptography currently supports ISO PIN block 4 translation for PIN block built using legacy PAN length. That is, PAN is the right most 12 digits excluding the check digits.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

• generate_pin_data

• verify_pin_data

Usage

paymentcryptographydataplane_translate_pin_data(IncomingKeyIdentifier,
  OutgoingKeyIdentifier, IncomingTranslationAttributes,
  OutgoingTranslationAttributes, EncryptedPinBlock,
  IncomingDukptAttributes, OutgoingDukptAttributes, IncomingWrappedKey,
  OutgoingWrappedKey)

Arguments

IncomingKeyIdentifier

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

When a WrappedKeyBlock is provided, this value will be the identifier to the key wrapping key for PIN block. Otherwise, it is the key identifier used to perform the operation.

OutgoingKeyIdentifier

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

IncomingTranslationAttributes

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

OutgoingTranslationAttributes

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

EncryptedPinBlock

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

IncomingDukptAttributes

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

OutgoingDukptAttributes

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

IncomingWrappedKey

The WrappedKeyBlock containing the encryption key under which incoming PIN block data is encrypted.

OutgoingWrappedKey

The WrappedKeyBlock containing the encryption key for encrypting outgoing PIN block data.

Value

A list with the following syntax:

list(
  PinBlock = "string",
  KeyArn = "string",
  KeyCheckValue = "string"
)

Request syntax

svc$translate_pin_data(
  IncomingKeyIdentifier = "string",
  OutgoingKeyIdentifier = "string",
  IncomingTranslationAttributes = list(
    IsoFormat0 = list(
      PrimaryAccountNumber = "string"
    ),
    IsoFormat1 = list(),
    IsoFormat3 = list(
      PrimaryAccountNumber = "string"
    ),
    IsoFormat4 = list(
      PrimaryAccountNumber = "string"
    )
  ),
  OutgoingTranslationAttributes = list(
    IsoFormat0 = list(
      PrimaryAccountNumber = "string"
    ),
    IsoFormat1 = list(),
    IsoFormat3 = list(
      PrimaryAccountNumber = "string"
    ),
    IsoFormat4 = list(
      PrimaryAccountNumber = "string"
    )
  ),
  EncryptedPinBlock = "string",
  IncomingDukptAttributes = list(
    KeySerialNumber = "string",
    DukptKeyDerivationType = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256",
    DukptKeyVariant = "BIDIRECTIONAL"|"REQUEST"|"RESPONSE"
  ),
  OutgoingDukptAttributes = list(
    KeySerialNumber = "string",
    DukptKeyDerivationType = "TDES_2KEY"|"TDES_3KEY"|"AES_128"|"AES_192"|"AES_256",
    DukptKeyVariant = "BIDIRECTIONAL"|"REQUEST"|"RESPONSE"
  ),
  IncomingWrappedKey = list(
    WrappedKeyMaterial = list(
      Tr31KeyBlock = "string"
    ),
    KeyCheckValueAlgorithm = "CMAC"|"ANSI_X9_24"
  ),
  OutgoingWrappedKey = list(
    WrappedKeyMaterial = list(
      Tr31KeyBlock = "string"
    ),
    KeyCheckValueAlgorithm = "CMAC"|"ANSI_X9_24"
  )
)