Skip to main content

Get Status

This method is used to retrieve the status of a network token.

Required API Key Permissions: NetworkTokenizationGeneralAccess

Request Headers: Authentication and Authorization

* denotes a required field
HTTP Request HeaderDescription
tx-tokenex-id*Like a username, this ID logically segments your tokenized data.
tx-apikey*Controls your access to individual functions in the API

Request Body Parameters:

ParameterDescription
tokenThe TokenEx token that represents the PAN and has an associated network token.
tokenReferenceIdIf there is more than one network token stored for that token, indicate which network token to use for this operation.

Response Body Parameters:

ParameterTypeDescription
successboolIndicator if the request was successfully processed by TokenEx.
referenceNumberstringTokenEx reference number for the transaction.
errorstringTokenEx Error Code and human readable description.
messagestringHuman readable message about response from TokenEx.
providerstringIdentifies which provider serviced the request: CybersourceTMS or VisaTGS.
thirdPartyStatusCodestringReserved field; not currently populated.
networkResponse.tokenStatestring enumThe current state of the token, as returned by the token provider.
networkResponse.messageIdstringUnique message identifier (GUID format), generated per response.
networkResponse.conversationIdstringMessage identifier assigned for the entire conversation (GUID format).
networkResponse.statusCodestringThe four-digit status code.
networkResponse.statusMessagestringHuman readable comments about the status. Null on success.
POST /v2/NetworkToken/GetStatus HTTP/1.1
Host: test-api.tokenex.com
tx-apikey: YourAPIKey
tx-tokenex-id: YourTokenExID
Content-Type: application/json

{
"token": "476120FDallZ7718",
"tokenReferenceId": "749f4d0d-4005-443e-9a66-0ea2d317b8f6"
}