Token Lifecycle v1
Token Lifecycle Push is one of the modules available through debiX PUSH. This use case enables issuers to receive near real-time notifications whenever an event related to a token, i.e., a digital card occurs.
Currently, two events are supported, namely TokenUpdated and TokenDeclined. All events are wrapped in an envelope providing metadata such as API version and payload type. A subset of the metadata is also available as JMS properties.
JSON Schema
Push Event Envelope
event-envelope.json
Payloads
Payloads are delivered as stringified JSON in the envelope. The possible types are defined below. Notes for implementation: make sure to destringify the payloads before mapping them to their respective types.
TokenUpdated
token-updated-payload.json
TokenDeclined
token-declined-payload.json
Other Definitions
CommonDefinitions
common-definitions.json
TokenLifecycleDefinitions
token-lifecycle-definitions.json
JMS Properties
A subset of the metadata provided in the envelope, is also available as JMS Properties, mainly to facilitate event deserialization. The available JMS properties are:
- pushEventType
- pushModule
- pushModuleApiVersion
- pushTransactionId
Issuer-Side Processing
Upon receiving a message, the issuer can:
-
Update token related information in the backend core banking systems with updated status, change history, and provisioning details.
-
Inform cardholder via push notification in the issuer’s own apps, i.e., mobile banking.
-
Use the debiX API for follow-up actions, e.g., immediate token revocation.
Schematic Example
