Get Status

This method is used to retrieve the status of a network token. A network token can have one of the following statuses: INACTIVE, ACTIVE, SUSPENDED, and DELETED .

• Test URI: https://test-api.tokenex.com/v2/NetworkToken/GetStatus
• Prod US URI: https://api.tokenex.com/v2/NetworkToken/GetStatus
• Prod EU URI: https://eu1-api.tokenex.com/v2/NetworkToken/GetStatus

Required API Key Permissions: NetworkTokenizationGeneralAccess

Request Headers: Authentication and Authorization^{* denotes a required field}

HTTP Request Header	Description
tx-tokenex-id*	Like a username, this ID logically segments your tokenized data.
tx-apikey*	Controls your access to individual function in the API

Request Body Parameters:

Parameter	Description
token	The TokenEx token that represents the PAN and has an associated network token.

Response Body Parameters:

Parameter	Type	Description
success	bool	Indicator if the request was successfully processed by TokenEx.
referenceNumber	string	TokenEx reference number for the transaction.
error	string	TokenEx Error Code and human readable description.
message	string	Human readable message about response from TokenEx.
networkResponse.tokenState	string enum	The current state of the token. It has predefined values which are INACTIVE, ACTIVE, SUSPENDED, and DELETED.
networkResponse.messageId	string	Unique message identifier (GUID format) of this command.
networkResponse.conversationId	string	Message identifier assigned for the entire conversation (GUID format). Typically, it is generated by the initiator of the flow.
networkResponse.statusCode	string	The four-digit status code.
networkResponse.statusMessage	string	Human readable comments about the status.

Request

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"
}

Response

{
  "networkResponse": {
    "tokenState": "ACTIVE",
    "messageId": "5b7d8ca7-fa4c-4a93-8bd0-c64c1ebdbeee",
    "conversationId": "a81530fc-0851-4c28-aff1-7dd5c150e84b",
    "statusCode": "0000",
    "statusMessage": null
  },
  "referenceNumber": "21082509302518698472",
  "success": true,
  "error": "",
  "message": "Network Tokenization GetStatus Successful!"
}