GetValueWithCustomData()
GetValueWithCustomData() gets the plaintext value for a token that has customer-specified data.
Syntax
public String GetValueWithCustomData (String naeUser, String naePassword, String dbUser, String dbPswd, String tableName, String token, String customData, Integer format)
Request Parameters
| Parameters | Data Types | Descriptions |
|---|---|---|
| naeUser | string | A Key Manager user with access to the AES and HMAC keys. |
| naePassword | string | The Key Manager user’s password. |
| dbUser | string | A database user with access to the token table. |
| dbPswd | string | The database user’s password. |
| tableName | string | This is the Token Vault name and it must be in CAPITAL LETTERS. |
| token | string | A token. |
| customData | string | Customer-specific data associated with the token. • For MySQL, if the customData parameter is null or empty, then the GetValueWithCustomData() API returns result irrespective of the customData value in token vault. |
| format | integer | The format of the returned value. Use one of the following options to set the format of the returned value: • 0 - 0 corresponds to MaskingFormat.SHOW_ALL. It shows all characters of 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
A string array of the plaintext value.
