Card Lifecycle v1
Card Lifecycle Push is one of the modules available through debiX PUSH. This use case enables issuers to receive near real-time notifications for lifecycle events related to cards.
Currently, the following events are supported:
- CardOrdered
- CardUpdated
- CardBlocked
- CardUnblocked
- CardDeleted
- CardOrderReversed
- CardSync
- PinOrdered
- PinViewed
- IssueOccurred
An event is 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.
Card Ordered
card-ordered-payload.json
Card Updated and Card Sync
The payload specification of the events CardUpdated and CardSync is identical. The events differ only in their purpose: CardUpdated notifies about changes, whereas CardSync provides a full data snapshot for synchronization that was requested by the issuer via debiX API POST cards/sync.
Card Status Changes
The payload specification of the events CardBlocked, CardUnblocked and CardDeleted is identical. The payloads differ in the value of the field blockInformation which is set only in the case of a CardBlocked event and null otherwise.
Simple Card Events
The payload specification of the events CardOrderReserved, PinOrdered and PinViewed is identical.
simple-card-event-payload.json
Issue Occurred
The event IssueOccurred contains details about a processing error or warning. Refer to Error codes for a list of possible issue codes.
issue-payload.json
Other Definitions
Common Card Lifecycle Definitions
card-lifecycle-definitions.json
Common Definitions
common-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:
- issuerTraceId (optional)
- pushEventType
- pushModule
- pushModuleApiVersion
- pushTransactionId
Issuer-Side Processing
Upon receiving a message, the issuer can:
-
Update card status in the backend core banking systems.
-
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
