Skip to main content

Lifecycle Management

This method is used to change the status of a network token. The only supported action is deletion (DELETE_TOKEN). To check the current status of a token, see the GetStatus method.

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 function in the API

Request Body Parameters:

ParameterTypeDescription
tokenstringThe TokenEx token that represents the PAN and has an associated network token.
lifecycleManagementActionstring enumThe action to update the status of the network token. Value: DELETE_TOKEN.
tokenReferenceIdstringIf 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.tokenReferenceIdstringUnique reference identifier for the token generated.
networkResponse.lifecycleManagementActionstring enumThe action that was performed. Value: DELETE_TOKEN.
networkResponse.messageIdstringUnique message identifier (GUID format) of this command.
networkResponse.conversationIdstringMessage identifier assigned for the entire conversation (GUID format). Typically, it is generated by the initiator of the flow.
networkResponse.statusCodestringThe four-digit status code.
networkResponse.statusMessagestringHuman readable comments about the status; null on success.
POST /v2/NetworkToken/LifecycleManagement HTTP/1.1
Host: test-api.tokenex.com
tx-apikey: YourAPIKey
tx-tokenex-id: YourTokenExID
Content-Type: application/json

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