Tokenize

POST 
/Device/Tokenize

Tokenize is used to tokenize a credit card primary account number (PAN) encrypted on a card payment terminal or pin-pad device."

Request

Header Parameters

tx-tokenex-id stringrequired
Your TokenEx token vault identifier or vaultless tokenization profile.
Default value: 8149339711073860
tx-apikey stringrequired
Provides access to one or more functions in the TokenEx API.
Default value: 9nRH8CsmeV0hxjV4EFqlyzycGMuRjJsqksTY9BEv
tx-token-scheme stringrequired
The name or the numerical value of the TokenEx token scheme to be used to tokenize the data.
Default value: PCI
tx-dual-decryption boolean
Set to true if the data payload is dual encrypted on a device such as the MagTek tDynamo.
Default value: false
tx-include-track-details boolean
Set to true to get the cardholder name and expiration date from the track data if is dual encrypted on a device such as the MagTek tDynamo.
Default value: false
tx-use-pin-variant boolean
Set to true if MSR ENCRYPTION VARIANT is set to PIN Encryption and the data is dual encrypted on a device such as the MagTek tDynamo.
Default value: false

application/json

Body

encryptionProfile stringrequired
The name of the Encryption Profile that should be used to decrypt the encryptedTrack.
Default value: EncryptionProfileName
ksn stringrequired

The Key Serial Number used for DUKPT.

requestFormat stringrequired
Format used in the request. Valid values: Base64, Hex.
Default value: Base64
encryptedTrack stringrequired

The encrypted Track 1 data from the device payload (location is device specific).

Responses

200

200

application/json

Schema

Schema

oneOf

Default

token string

Example: 693008da-9a73-4918-a1f5-03b6fb867c1c

referenceNumber string

Example: 21042212110512863701

success boolean

Default value: true

Example: true

error string

Example:

message string

Example: Tokenize Successful!

Response with tx-Include-track-details

name string

Example: <card holders name here>

expiration string

Example: <card expiration here>

token string

Example: 693008da-9a73-4918-a1f5-03b6fb867c1c

referenceNumber string

Example: 21042212110512863701

success boolean

Default value: true

Example: true

error string

Example:

message string

Example: Tokenize Successful!

Example (from schema)

{}

Default

{
  "token": "693008da-9a73-4918-a1f5-03b6fb867c1c",
  "referenceNumber": "21042212110512863701",
  "success": true,
  "error": "",
  "message": "Tokenize Successful!"
}

Response with tx-Include-track-details

{
  "name": "<card holders name here>",
  "expiration": "<card expiration here>",
  "token": "693008da-9a73-4918-a1f5-03b6fb867c1c",
  "referenceNumber": "21042212110512863701",
  "success": true,
  "error": "",
  "message": "Tokenize Successful!"
}

Loading...