Parameters

Edit online

The parameters for CSNBPGN.

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

PIN_generating_key_identifier
Direction: Input/Output
Type: String

A pointer to a string variable containing an operational fixed-length CCA DES key-token, a TR-31 DES key-token, or the label of such a token. For a CCA DES token, it must have a key type of PINGEN. In addition, the control vector of the key token must have CV bit 18 = B’1’ (CPINGENA).

For a TR-31 token, it must have the following attributes based on the Process Rule used:

IBM-PIN and IBM-PINO:

  • TR-31 key usage: V1
  • Algorithm: T
  • TR-31 mode of key use: C or G

VISA-PVV:

  • TR-31 key usage: V2
  • Algorithm: T
  • TR-31 mode of key use: C or G

GBP-PIN and INBK-PIN:

  • TR-31 key usage: V0
  • Algorithm: T
  • TR-31 mode of key use: C or G
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 1.
rule_array
Direction: Input
Type: String array
The process rule provides control information to the verb. The keyword is left-aligned in an 8-byte field and padded on the right with blanks. The rule_array keyword is described in Table 1.
Table 1. Keywords for Clear PIN Generate control information

Keywords for Clear PIN Generate control information
Keyword Description
Process Rule (One, required)
GBP-PIN The IBM® German Bank Pool PIN, which uses the institution PINGEN key to generate an institution PIN (IPIN).
IBM-PIN The IBM 3624 PIN, which is an institution-assigned PIN. It does not calculate the PIN offset.
IBM-PINO The IBM 3624 PIN offset, which is a customer-selected PIN and calculates the PIN offset (the output).
INBK-PIN The Interbank PIN that is generated.
VISA-PVV The VISA PIN validation value. Input is the customer PIN.
PIN_length
Direction: Input
Type: Integer
The length of the PIN used for the IBM algorithms only, IBM-PIN or IBM-PINO. Otherwise, this parameter is ignored. Specify an integer in the range 4 - 16.
PIN_check_length
Direction: Input
Type: Integer
The length of the PIN offset used for the IBM-PINO process rule only. Otherwise, this parameter is ignored. Specify an integer from 4 - 16.
Note: The PIN check length must be less than or equal to the integer specified in the PIN_length parameter.
data_array
Direction: Input
Type: String
Three 16-byte data elements required by the corresponding rule_array parameter. The data array consists of three 16-byte fields or elements whose specification depends on the process rule. If a process rule only requires one or two 16-byte fields, the rest of the data array is ignored by the verb. Table 2 describes the array elements.
Table 2. Array elements for the Clear PIN Generate verb

Array elements for the Clear PIN Generate verb
Array element Description
Clear_PIN Clear user selected PIN of 4 - 12 digits of 0 - 9. Left-aligned and padded with spaces. For IBM-PINO, this is the clear customer PIN (CSPIN).
Decimalization_table Decimalization table for IBM and GBP only. Sixteen digits of 0 - 9.

If the ANSI X9.8 PIN - Use stored decimalization tables only access control point (X'0356') is enabled in the active role, this table must match one of the active decimalization tables in the coprocessors.
Trans_sec_parm For VISA only, the leftmost sixteen digits. Eleven digits of the personal account number (PAN). One digit key index. Four digits of customer selected PIN.

For Interbank only, sixteen digits. Eleven rightmost digits of the personal account number (PAN). A constant of 6. One digit key selector index. Three digits of PIN validation data.
Validation_data Validation data for IBM and IBM German Bank Pool padded to 16 bytes. One to sixteen characters of hexadecimal account data left-aligned and padded on the right with blanks.
Table 3 lists the data array elements required by the process rule (rule_array parameter). The numbers refer to the process rule's position within the array.
Table 3. Array elements for Clear PIN Generate

Array elements for Clear PIN Generate
Process Rule IBM-PIN IBM-PINO GBP-PIN GBP-PINO VISA-PVV INBK-PIN
Decimalization_table 1 1 1 1    
Validation_data 2 2 2 2    
Clear_PIN   3   3    
Trans_sec_parm         1 1
Note: Generate offset for GBP algorithm is equivalent to IBM offset generation with PIN_check_length of 4 and PIN_length of 6.
returned_result
Direction: Output
Type: String
The 16-byte generated output, left-aligned, and padded on the right with blanks.