Package com.gemalto.mfs.mwsdk.dcm

Interface DigitalizedCardStatus

public interface DigitalizedCardStatus
This interface defines the current state of the digitalized card. This interface allows the user of this SDK to retrieve the following information from the DigitalizedCard:
  1. The card state - to indicate if the card is ACTIVE or SUSPENDED DigitalizedCardState
  2. The remaining number of credentials - to indicate how many more times the wallet is able to perform a transaction
  3. If the card needs replenishment - Each card has it's own threshold for the minimum number of credentials remaining in storage. If the number of remaining credentials reaches this threshold, then the card needs to be replenished.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getAuxiliaryNumberOfPaymentsLeft()
    Only available for auxiliary card.
    String
    getExpiryDate()
    Retrieves the LUK expiry date of the card.
    int
    getNumberOfPaymentsLeft()
    Retrieves the remaining number of credentials left to perform payment transactions for this card.
    DigitalizedCardState
    getState()
    Retrieves the state of the digitalized card.
    boolean
    needsReplenishment()
    Determines if the card needs to be replenished based on the number of credentials left, and set the minimum threshold provided by the CPS.

  • Method Details

    • getState

      DigitalizedCardState getState()
      Retrieves the state of the digitalized card. DigitalizedCardState
      Returns:
      DigitalizedCardState

    • getNumberOfPaymentsLeft

      int getNumberOfPaymentsLeft()
      Retrieves the remaining number of credentials left to perform payment transactions for this card.
      Returns:
      The remaining number of credentials.

    • needsReplenishment

      boolean needsReplenishment()
      Determines if the card needs to be replenished based on the number of credentials left, and set the minimum threshold provided by the CPS.
      Returns:
      A true value if the number of remaining credentials is lesser than the threshold set by the CPS server. Otherwise, `false` is returned.

    • getExpiryDate

      String getExpiryDate()
      Retrieves the LUK expiry date of the card.
      Returns:
      The key validity period on the LUK key of the digitalized card.
      • A null value is returned if it is a SUK.
      • A null value is returned if there is an error in the validity period of the key.

    • getAuxiliaryNumberOfPaymentsLeft

      int getAuxiliaryNumberOfPaymentsLeft()
      Only available for auxiliary card. Retrieves the remaining number of credentials left to perform payment transactions for this auxiliary card.
      Returns:
      The remaining number of credentials left.
      Since:
      6.12