Get the card digitization state

Get the card digitization state

Use this guide to determine whether a card is already digitized in a specific wallet on the device. The issuer application uses this state to decide whether to show Add to wallet or Activate card, or to hide both.

You typically call this API when:

• the issuer application starts, or

• the end user opens a card details screen.

For the overall push provisioning flow, see Implement push to digital wallets.

Overview

The issuer application uses the D1 SDK to check the card Tokenization status in the mobile device. Based on the returned state, the issuer application updates the UI:

• DIGITIZED – The card is already tokenized in the wallet on this device. Hide Add to wallet and Activate card.

• NOT_DIGITIZED – The card is not tokenized. Show Add to wallet.

• PENDING_IDV – The digital card is created but pending ID&V. Show Activate card if in-app authentication is supported.

Caution

• If the card still appears as NOT_DIGITIZED after digitization, check that the issuer application is correctly configured in the TSP portal.

• For Samsung Pay, some issuers must register multiple issuer names in the portal. Ensure the issuer name used in the API matches the names registered in the portal. Only exact matches are returned. See the Samsung FAQ for troubleshooting tips.

Flow

Sequence diagram

Pre-requisites

• Consumer account and card were registered in D1

• SDK is properly initialized

• Issuer App called D1 SDK login API

High-level sequence to retrieve the card digitization state from the wallet.

Platform integration

Android

For Android 2.4.0 and later, the D1 SDK exposes the D1PushWallet.getCardDigitizationState() API to check the card Tokenization state for a specific wallet (Google Pay or Samsung Pay).

The possible states are:

• DIGITIZED The card has already been tokenized. No message or action is required.

• NOT_DIGITIZED Show an Add to Google/Samsung Pay button. Refer to the Google Pay brand guidelines for more information. The next step is to push the card into the wallet as explained in Push to the digital wallet.

• PENDING_IDV Show an Activate card button if issuer application authentication is supported. After successful authentication, call activateDigitalCard() to activate the digital card.

See the D1 SDK reference for the full API signature.

fun checkCardDigitizationState_v2_4_0(d1Task: D1Task, cardID: String) {
    val d1PushWallet = d1Task.d1PushWallet
    val wallet = OEMPayType.GOOGLE_PAY // it can be SAMSUNG_PAY

    val callback: D1Task.Callback<CardDigitizationState> = object : D1Task.Callback<CardDigitizationState> {

        override fun onSuccess(state: CardDigitizationState) {
            // Updates the UI based on the state value.

            // Hides the  "Add to Google/Samsung Pay" button.
            // Hides the "Activate your card" button.
            when (state) {
                NOT_DIGITIZED -> {
                    // Shows the "Add to Google/Samsung Pay" button.
                }
                PENDING_IDV -> {
                    // 1. Show the "Activate your card" button.
                    // 2. Authenticate the end user.
                    // 3. Perform activation: d1PushWallet.activateDigitalCard(cardID, wallet, callback)
                }
                DIGITIZED -> {
                    // Hides the "Add to Google/Samsung Pay" button.
                }
                else -> {
                    //Do nothing.
                }
            }
        }

        override fun onError(exception: D1Exception) {
            // Refer to D1 SDK Integration – Error Management section.
        }
    }
    d1PushWallet.getCardDigitizationState(cardID, wallet, callback)
}

iOS

For a full access to the D1 SDK, please check API reference.