Skip to main content

Token State Change Notification

This is an HTTP message pushed to an endpoint specified by a TokenEx client when the status of a network token changes. To utilize the token state change notification web hook, TokenEx clients will need to enroll within the TokenEx client portal. To enroll, open a support ticket to request this functionality. TokenEx support will need a URL to serve as the network state callback URL for this web hook.

Test Receiving URI: [enrolled Network State Callback URL]
Prod Receiving URI: [enrolled Network State Callback URL]

Request Body Parameters:

ParameterTypeDescription
tokenstringThe TokenEx token that represents the PAN.
successstringIndicator if the request was successfully processed.
referenceNumberstringTokenEx reference number for the transaction.
errorstringTokenEx Error Code and human readable description.
messagestringHuman readable message about response from TokenEx.
networkTokenStateChangeNotification.messageIdstringUnique message identifier (GUID format) of this command.
networkTokenStateChangeNotification.conversationIdstringMessage identifier assigned for the entire conversation (GUID format). Typically, it is generated by the initiator of the flow.
networkTokenStateChangeNotification.tokenRequestorIdstringOpaque identifier associated with the domain to which the token belongs. Treat as opaque; do not persist or use in downstream logic.
networkTokenStateChangeNotification.tokenReferenceIdstringUnique reference identifier for the token generated.
networkTokenStateChangeNotification.tokenTimestampstringThe event timestamp of the last state change, in Unix seconds.
networkTokenStateChangeNotification.requestReasonCodestring enumProvides more context for the token state change. Possible Values: CARD_UPDATED, METADATA_UPDATE, PROVISIONED, TOKEN_STATUS_UPDATE, TOKEN_UPDATED.
networkTokenStateChangeNotification.previousTokenStatestringThe previous network token status.
networkTokenStateChangeNotification.currentTokenStatestringThe current network token status
{
"token": "476120FDallZ7718",
"referenceNumber": "21082509302518698472",
"success": "true",
"error": "",
"message": "",
"networkTokenStateChangeNotification": {
"messageId": "6fdf4f09-7fbb-48ae-be1e-ac412a2949a7",
"conversationId": "aa3a5f54-6eb2-4714-aea3-9f525353cbd7",
"tokenRequestorId": "a1b2c3d4e5f6",
"tokenReferenceId": "b2b92b5b-403d-4bd8-a756-6e415b86b291",
"tokenTimestamp": "1759693200",
"requestReasonCode": "TOKEN_STATUS_UPDATE",
"previousTokenState": "INACTIVE",
"currentTokenState": "ACTIVE"
}
}