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:
Parameter | Type | Description |
---|---|---|
token | string | The TokenEx token that represents the PAN. |
success | string | Indicator if the request was successfully processed. |
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. |
networkTokenStateChangeNotification.messageId | string | Unique message identifier (GUID format) of this command. |
networkTokenStateChangeNotification.conversationId | string | Message identifier assigned for the entire conversation (GUID format). Typically, it is generated by the initiator of the flow. |
networkTokenStateChangeNotification.tokenRequestorId | string | TRID associated to the domain to which the token belongs (card brand specific). The format matches with the EMVCo Tokenization specifications. |
networkTokenStateChangeNotification.tokenReferenceId | string | Unique reference identifier for the token generated. |
networkTokenStateChangeNotification.tokenTimestamp | string | The event timestamp in milliseconds of the last state change. |
networkTokenStateChangeNotification.requestReason | string | The reason for the token state transition. |
networkTokenStateChangeNotification.requestReasonCode | string | It provides more context of the token state change. Possible Values: ACTIVATED_BY_CUSTOMER_SERVICE, ACTIVATED_BY_COBADGED_TOKEN, ACTIVATED_BY_ISSUER, ACTIVATED_BY_ISSUER_APP, ACTIVATED_BY_USER_REQUEST, SUSPENDED_BY_ISSUER, SUSPENDED_DUE_TO_FRAUD, SUSPENDED_BY_USER_REQUEST, SUSPENDED_BY_CUSTOMER_SERVICE, SUSPENDED_BY_TR, SUSPENDED_BY_TR_DUE_TO_FRAUD, RESUMED_BY_ISSUER, RESUMED_BY_USER_REQUEST, RESUMED_BY_CUSTOMER_SERVICE, RESUMED_BY_TR, RPAN_UPDATE, DELETED_FOR_SECURITY, DELETED_BY_CUSTOMER_SERVICE, DELETED_BY_ISSUER, DELETED_DUE_TO_FRAUD, DELETED_BY_USER_REQUEST, DELETED_DUE_TO_TOKEN_PROBLEM, DELETED_BY_TIME_LIMIT, DELETED_BY_TR, DELETED__BY_TR_DUE_TO_FRAUD, DELETED_DUE_TO_ERROR, STATE_CHANGED_ON_DEVICE, UNKNOWN_REASON_CODE |
networkTokenStateChangeNotification.previousTokenState | string | The previous network token status. |
networkTokenStateChangeNotification.currentTokenState | string | The current network token status. |
{
"token": "476120FDallZ7718",
"referenceNumber": "21082509302518698472",
"success": "true",
"error": "",
"networkTokenStateChangeNotification": {
"messageId": "6fdf4f09-7fbb-48ae-be1e-ac412a2949a7",
"conversationId": "aa3a5f54-6eb2-4714-aea3-9f525353cbd7",
"tokenRequestorId": "12345678901",
"tokenReferenceId": "b2b92b5b-403d-4bd8-a756-6e415b86b291",
"tokenTimestamp": "1523879928000",
"requestReason": "The mobile device is stolen.",
"requestReasonCode": "ACTIVATED_BY_ISSUER",
"previousTokenState": "INACTIVE",
"currentTokenState": "ACTIVE"
}
}
Updated almost 2 years ago