GetBatchWithCustomData()
Get the plaintext values for an array of tokens and their corresponding custom data values.
Syntax
Request Parameters
| Parameters | Data Types | Descriptions |
|---|---|---|
| naeUser | String | The Key Manager user with access to the AES and HMAC keys. |
| naePassword | String | The Key Manager user’s password. |
| dbUser | String | The database user with access to the token table. |
| dbPswd | String | The database user’s password. |
| tableName | String | The token table The name must be in CAPITAL LETTERS. |
| tokens | String array | An array of tokens. |
| customData | String array | The customer-specific data associated with the plaintext value(s). Note: For My SQL, if the customData parameter is null or empty, then the GetBatchWithCustomData() API returns results for all the customData values in token vault. |
| format | Int | The format of the returned value. Use one of the following options to set the masking format of the returned value: • 0 - 0 corresponds to MaskingFormat.SHOW_ALL. It shows all characters of the plaintext value.• 1 - 1 corresponds to MaskingFormat.SHOW_FIRST_SIX. It shows only the first six characters of the plaintext value and masks the remaining characters. For example, a 16-digit credit card number will be masked as 123456XXXXXXXXXX.• 2 - 2 corresponds to MaskingFormat.SHOW_FIRST_TWO_LAST_FOUR. It shows only the first two and last four characters of the plaintext value and masks the remaining characters. For example, a 16-digit credit card number will be masked as 12XXXXXXXXXX3456.• 3 - 3 corresponds to MaskingFormat.SHOW_FIRST_SIX_LAST_FOUR. It shows only the first six and last four characters of the plaintext value and masks the remaining characters. For example, a 16-digit credit card number will be masked as 123456XXXXXX1234.• 6 - 6 corresponds to MaskingFormat.SHOW_LAST_FOUR or TokenService.MASK_TOKEN. It shows only the last four characters of the plaintext value and masks the remaining characters. For example, a 16-digit credit card number will be masked as XXXXXXXXXXXX1234.• Masking format ID can be generated using the createMaskingFormat API. |
Returned Value
| Returned Value | Description |
|---|---|
| String[] | The plaintext values. |
