Manage digital card LCM

Overview

Use the NFC Wallet SDK in your digital wallet application to manage a digital card lifecycle (LCM).

Primary use case:

• Delete a digital card from the digital wallet application

Before you start you should get an access token as described in Get an access token.

In this section, we describe LCM actions initiated from the digital wallet application. The issuer backend can also initiate digital card LCM directly with the TSP.

SDK integration

Use MGCardLifeCycleManager and the digital card ID to trigger LCM actions.

Implement MGCardLifecycleEventListener to handle onSuccess and onError callbacks.

Supported actions:

• deleteCard
• suspendCard
• resumeCard

onSuccess confirms that the NFC Wallet SDK accepted the request. The digital wallet application updates after it receives a push notification.

Changes from the NFC Wallet backend don't appear immediately in the digital wallet application.

NFC Wallet backend sends a push notification to synchronize the digital card state.

See Handle push notifications.

Delete a digital card

Delete a digital card using MGCardLifeCycleManager.deleteCard(...).

Deleting a card permanently removes it from the digital wallet application.

DeleteCard.java

// get the access token
String accessToken = "....";

// Get the card life cycle manager.
MGCardLifeCycleManager cardLifeCycleManager = MGClient.getCardLifeCycleManager();

// Delete a card using its digital card ID.
cardLifeCycleManager.deleteCard(
    digitalCardId,
    new MGCardLifecycleEventListener() {
        @Override
        public void onSuccess(String digitalCardId) {
            /*
             * Request accepted by the NFC Wallet SDK.
             * The NFC Wallet backend sends a push notification to complete the operation.
             *
             * If the card is already deleted server-side, the SDK removes local card data.
             */
        }

        @Override
        public void onError(String digitalCardId, MobileGatewayError error) {
            /*
             * Request failed.
             * Inspect MobileGatewayError to determine the cause.
             */
        }
    },
    null,
    null,
    accessToken );

After the issuer backend or digital wallet application initiates a delete request, the digital card can temporarily appear as RETIREDstate.

During this time, DigitalizedCardManager#getAllCards() can still return the card.

The card disappears from the list after the SDK removes it from local storage.

Suspend a digital card

Suspend a digital card using MGCardLifeCycleManager.suspendCard(...).

Resume a digital card

Resume a digital card using MGCardLifeCycleManager.resumeCard(...).