Check digital card state

Overview

Before you digitize a card for NFC Payment, first check the card digitization state.

Flow

Use the D1 SDK in the issuer application to check the card digitization state. If the card is not digitized and the device is NFC-capable, display the Enable NFC Payment button. If the card is already digitized, or the issuer application does not meet the eligibility criteria, hide the Enable NFC Payment option.

The D1 SDK exposes the getCardDigitizationState() API to check the card digitization state.

The possible card digitization states are:

• NOT_DIGITIZED

  • Display the Enable NFC Payment button if the device is NFC-capable.
• DIGITIZATION_IN_PROGRESS

  • The card digitization process is already in progress. No action is required in the issuer application, and you cannot digitize another card at this time.
• DIGITIZED

  • No message is displayed. The card is already digitized.
  • The issuer application should check whether it is the default payment application in Android Tap & Pay settings.

Sequence diagram

Card digitization state flow in the issuer application.

SDK

Check digital card state

Android Kotlin

fun checkCardDigitizationState(d1Task: D1Task, cardID: String) {
    val callback: D1Task.Callback<CardDigitizationState> =
        object : D1Task.Callback<CardDigitizationState> {
            override fun onSuccess(state: CardDigitizationState) {
                // Update UI bases on the state value

                // Hide button "Enable NFC Payment"
                when (state) {
                    NOT_DIGITIZED -> {
                        // Check Device is Eligible
                        // Show button "Enable NFC Payment"
                    }

                    DIGITIZATION_IN_PROGRESS -> {
                        // Hide button "Enable NFC Payment"
                        // Show digitization in progress
                    }

                    DIGITIZED -> {
                        // Tap&Pay settings
                        // Check issuer application is the default payment application
                    }
                }
            }

            override fun onError(exception: D1Exception) {
                // Refer to D1 SDK Integration – Error Management section
                // Exception: Not Supported: Display message 'Not Supported'
            }
        }
    val d1PayWallet: D1PayWallet = d1Task.d1PayWallet
    d1PayWallet.getCardDigitizationState(cardID, callback)
}

Android Java

public void checkCardDigitizationState(@NonNull D1Task d1Task, @NonNull String cardID) {
    D1Task.Callback<CardDigitizationState> callback = new D1Task.Callback<CardDigitizationState>() {
        @Override
        public void onSuccess(@NonNull CardDigitizationState state) {
            // Update UI bases on the state value

            // Hide button "Enable NFC Payment"
            switch (state) {
                case NOT_DIGITIZED:
                    // Check Device is Eligible
                    // show button "Enable NFC Payment"
                    break;

                case DIGITIZATION_IN_PROGRESS:
                    // Hide button "Enable NFC Payment"
                    // Show digitization in progress
                    break;

                case DIGITIZED:
                    // Tap&Pay settings
                    // Check issuer application is the default payment application
                    break;
            }
        }

        @Override
        public void onError(@NonNull D1Exception exception) {
            // Refer to D1 SDK Integration – Error Management section
            // Exception: Not Supported: Display message 'Not Supported'
        }
    };
    D1PayWallet d1PayWallet = d1Task.getD1PayWallet();
    d1PayWallet.getCardDigitizationState(cardID, callback);
}