Parameters

Edit online

The parameters for CSNBDMP.

For the definitions of the return_code, reason_code, exit_data_length, and exit_data parameters, see Parameters common to all verbs.

rule_array_count
Direction: Input
Type: Integer
A pointer to an integer variable containing the number of elements in the rule_array variable. This value must be 0 or 1.
rule_array
Direction: Input
Type: String array
Keywords that provide control information to the callable service. The keywords must be in contiguous storage with each of the keywords left-justified in its own 8-byte location and padded on the right with blanks. The rule_array keywords are described in Table 1.
Table 1. Keywords for DK Migrate PIN control information

Keywords for DK Migrate PIN control information
Keyword Description
PIN Block output selection keyword (One, optional)
EPB Return an encrypted PIN block and a MAC of the encrypted PIN block.
NOEPB Do not return an encrypted PIN block (EPB). This is the default value.
PAN_data_length
Direction: Input
Type: Integer
Specifies the length in bytes of the PAN_data parameter. The value must be in the range 10 - 19.
PAN_data
Direction: Input
Type: String
The personal account number in character form which the PIN is associated. The primary account number, including check digit, should be included.
card_p_data_length
Direction: Input
Type: Integer
Specifies the length in bytes of the card_p_data parameter. The value must be in the range 2 - 256.
card_p_data
Direction: Input
Type: String
The time-invariant card data (CDp), determined by the card issuer, which is used to differentiate between multiple cards for one account.
card_t_data_length
Direction: Input
Type: Integer
Specifies the length in bytes of the card_t_data parameter. The value must be in the range 2 - 256.
card_t_data
Direction: Input
Type: String
The time-sensitive card data, determined by the card issuer, which, together with the account number and the card_p_data, specifies an individual card.
ISO1_PIN_block_length
Direction: Input
Type: Integer
Specifies the length in bytes of the ISO1_PIN_block parameter. This value must be 8.
ISO1_PIN_block
Direction: Input
Type: String
The 8-byte encrypted PIN block with the current PIN in ISO-1 format with the customer chosen PIN. This PIN is used to generate the PIN reference value.
IPIN_encryption_key_identifier_length
Direction: Input
Type: Integer
Specifies the length in bytes of the IPIN_encryption_key_identifier parameter. If the IPIN_encryption_key_identifier contains a label, the length must be 64. Otherwise, the value must be at least the actual token length, up to 725.
IPIN_encryption_key_identifier
Direction: Input/Output
Type: String
The identifier of the key to decrypt the PIN block containing the IOS-1 PIN. The key identifier is an operational token or the key label of an operational token in key storage. The key algorithm of this key must be DES and the key type must be IPINENC.

If the token supplied was encrypted under the old master key, the token is returned encrypted under the current master key.

PRW_key_identifier_length
Direction: Input
Type: Integer
Specifies the length in bytes of the PRW_key_identifier parameter. If PRW_key_identifier contains a label, the length must be 64. Otherwise, the value must be at least the actual token length, up to 725.
PRW_key_identifier
Direction: Input/Output
Type: String
The identifier of the PRW generating key. The key identifier is an operational token or the key label of an operational token in key storage. The key algorithm of this key must be AES, the key type must be PINPRW, and the key usage fields must indicate GENONLY, CMAC, and DKPINOP.

If the token supplied was encrypted under the old master key, the token is returned encrypted under the current master key.

OPIN_encryption_key_identifier_length
Direction: Input
Type: Integer
Specifies the length in bytes of the OPIN_encryption_key_identifier parameter. If the rule array indicates that no encrypted PIN block is to be returned, this value must be 0. If OPIN_encryption_key_identifier contains a label, the length must be 64. Otherwise, the value must be at least the actual token length, up to 725.
OPIN_encryption_key_identifier
Direction: Input/Output
Type: String
The identifier of the key to wrap the PIN block. The key identifier is an operational token or the key label of an operational token in key storage. If the rule array indicates that no encrypted PIN block is to be returned, this parameter is ignored. The key algorithm of this key must be AES, the key type must be PINPROT, and the key usage fields must indicate ENCRYPT, CBC, and DKPINOP.

If the token supplied was encrypted under the old master key, the token is returned encrypted under the current master key.

OEPB_MAC_key_identifier_length
Direction: Input
Type: Integer
Specifies the length in bytes of the OEPB_MAC_key_identifier parameter. If the rule array indicates that no encrypted PIN block MAC is to be returned, this value must be 0. If OEPB_MAC_key_identifier contains a label, the length must be 64. Otherwise, the value must be at least the actual token length, up to 725.
OEPB_MAC_key_identifier
Direction: Input/Output
Type: String
The identifier of the key to generate the MAC of the PIN block. The key identifier is an operational token or the key label of an operational token in key storage. If the rule array indicates that no encrypted PIN block is to be returned, this parameter is ignored. The key algorithm of this key must be AES, the key type must be MAC, and the key usage fields must indicate GENONLY, CMAC, and DKPINOP.

If the token supplied was encrypted under the old master key, the token is returned encrypted under the current master key.

PIN_reference_value_length
Direction: Input/Output
Type: Integer
Specifies the length in bytes of the PIN_reference_value parameter. This value must be 16. On output, PIN_reference_value_length is set to 16.
PIN_reference_value
Direction: Output
Type: String
The 16-byte calculated PIN reference value.
PRW_random_number_length
Direction: Input/Output
Type: Integer
Specifies the length in bytes of the PRW_random_number parameter. The value must be 4. On output, PRW_random_number_length is set to 4.
PRW_random_number
Direction: Output
Type: String
The 4-byte random number associated with the PIN reference value.
encrypted_PIN_block_length
Direction: Input/Output
Type: Integer
Specifies the length in bytes of the encrypted_PIN_block parameter. If the rule array indicates that no encrypted PIN block should be returned, this value must be 0. Otherwise, it should be at least 32.
encrypted_PIN_block
Direction: Output
Type: String
The 32-byte encrypted PIN block in PBF-1 format. This parameter is ignored if no encrypted PIN block is returned.
PIN_block_MAC_length
Direction: Input/Output
Type: Integer
Specifies the length in bytes of the PIN_block_MAC parameter. If the rule_array indicates that no PIN block MAC should be returned, this value must be 0. Otherwise, it must be at least 8.
PIN_block_MAC
Direction: Output
Type: String
The 8-byte CMAC of the encrypted PIN block. This parameter is ignored if no encrypted PIN block is returned.