Package com.gemalto.mfs.mwsdk.dcm

Class DigitalizedCardProfileKeys

  • public final class DigitalizedCardProfileKeys
extends java.lang.Object
    This contains a list of keys for insensitive and custom data in the card profile that can be retrieved by the UI application, via API DigitalizedCardDetails.getValue(String). The data available here are classified to be insensitive and useful for End-User display if UI application desires to do so.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ACCOUNT_TYPE  
      static java.lang.String ADDITIONAL_DATA
      The key to get the additional and custom data.
      static java.lang.String ADDITIONAL_DATA_ODA_CERTIFICATE_EXPIRY_DATA
      The key to get the VISA ODA Certificate Expiry Date
      static java.lang.String ADDITIONAL_DATA_PAN_EXPIRY
      Key to get the PAN Expiry data
      static java.lang.String ADDITIONAL_DATA_PAN_LAST_4_DIGITS
      The key to get the PAN last 4 digits of the card.
      static java.lang.String ADDITIONAL_DATA_PRODUCT_ID
      The key to get the Product ID of the card.
      static java.lang.String CARD_COUNTRY_CODE  
      static java.lang.String CVM_RESET_TIMEOUT
      The key to get the duration during which the CardHolder verification, once successfully verified, status remains valid.
      static java.lang.String DC_TOKEN_ID
      The key to get the token ID associated with the card profile.
      static java.lang.String DIGITIZED_CARD_ID  
      static java.lang.String DUAL_TAP_TIMEOUT
      The key to get the maximum duration allowed between the first tap and second tap for the high-value transaction use case, whereas the first tap would trigger the UI application to perform CardHolder verification within this duration only.
      static java.lang.String IS_TRANSACTION_ID_REQUIRED  
      static java.lang.String IS_US_AIP_MASKING_SUPPORTED  
      static java.lang.String MASTERCARD_APPLICATION_LIFE_CYCLE_DATA
      Only for Mastercard.
      The key to get the application Life Cycle Data which contains the unique application ID of the issuer
      static java.lang.String MASTERCARD_CARD_LAYOUT_DESC
      Only for Mastercard.
      The key to get the card layout description which is the optional data element personalized by the issuer and containing the image of a card that for displaying on the MPA.
      static java.lang.String MASTERCARD_MCHIP_ISSUER_OPTIONS
      Only for Mastercard.
      The key to get the M/Chip CVM Issuer Options which contains the issuer defined options related to the CVM applied by the application when working in the PayPass M/Chip mode.
      static java.lang.String MASTERCARD_SECURITY_WORD
      Only for Mastercard.
      The key to get the MasterCard security word which is the static password used to authenticate the mobile MasterCard PayPass to the cardholder through the MPA.
      static java.lang.String PAN  
      static java.lang.String PAYMENT_CHANNELS
      Represents the field that identifies the supported payment channels for a card profile.
      The values are represented in hexadecimal format: 0x80 - CONTACTLESS 0x40 - DSRP 0x20 - QR 0xA0 - CONTACTLESS AND QR 0xC0 - CONTACTLESS AND DSRP 0xE0 - CONTACTLESS AND DSRP AND QR See ProfileChannel for more details.
      static java.lang.String PRODUCT_TYPE  
      static java.lang.String SCHEME
      The key to get the textual representation of card scheme.
      static java.lang.String VERSION  

    • Method Summary

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • DC_TOKEN_ID

        public static final java.lang.String DC_TOKEN_ID
        The key to get the token ID associated with the card profile. Linked to the dc.tokenID field in the JSON structure.
        See Also:
        Constant Field Values

      • SCHEME

        public static final java.lang.String SCHEME
        The key to get the textual representation of card scheme. The texts are coming from server, typically in block letters such as "MASTERCARD" or "VISA".
        See Also:
        Constant Field Values

      • CVM_RESET_TIMEOUT

        public static final java.lang.String CVM_RESET_TIMEOUT
        The key to get the duration during which the CardHolder verification, once successfully verified, status remains valid.
        See Also:
        Constant Field Values

      • DUAL_TAP_TIMEOUT

        public static final java.lang.String DUAL_TAP_TIMEOUT
        The key to get the maximum duration allowed between the first tap and second tap for the high-value transaction use case, whereas the first tap would trigger the UI application to perform CardHolder verification within this duration only.
        See Also:
        Constant Field Values

      • ADDITIONAL_DATA

        public static final java.lang.String ADDITIONAL_DATA
        The key to get the additional and custom data. These data are not really part of the profile data, either added by the server or from the issuers. NOTE that the value of this key is in fact always a JSON dictionary object that contains key-value pairs. The server always inject in this value 2 mandatory keys, which are ADDITIONAL_DATA_PRODUCT_ID and ADDITIONAL_DATA_PAN_LAST_4_DIGITS.
        An example of extracting additional data is as following: 
         
  final DigitalizedCardDetails details = card.getCardDetails(null).waitToComplete().getResult();
  final JSONObject additionalDataJson = new JSONObject(details.getValue(DigitalizedCardProfileKeys.ADDITIONAL_DATA);
  // Get Product ID & Last 4 Digits
  final String productId = additionalDataJson.get(DigitalizedCardProfileKeys.ADDITIONAL_DATA_PRODUCT_ID);
  final String last4Digits = additionalDataJson.get(DigitalizedCardProfileKeys.ADDITIONAL_DATA_LAST_4_DIGITS);
  // Get some other custom data object, for example "custom_data"
  final JSONObject customData = additionalDataJson.getJSONObject("custom_data");
  // If the data is nested, for example "custom_data" contains a key called "contract_id"
  final String contractId = customData.get("contract_id");
        See Also:
        Constant Field Values

      • ADDITIONAL_DATA_PRODUCT_ID

        public static final java.lang.String ADDITIONAL_DATA_PRODUCT_ID
        The key to get the Product ID of the card. Product ID is the standardized identification of the card, that is provisioned by the server. One of the common usages of this value is to allow mapping a given card with custom data in the UI application. For example, the card image is not provisioned to the SDK, but rather acquired through different channel by the UI application. The UI application would then be able to display the card list with the images correctly via this value.
        An example of mapping a card to its image using Product ID is as following 
         
  final DigitalizedCardDetails details = card.getCardDetails(null).waitToComplete().getResult();
  final JSONObject additionalDataJson = new JSONObject(details.getValue(DigitalizedCardProfileKeys.ADDITIONAL_DATA);
  // Assuming that UI application uses the Product ID as the image file name with extension .png
  final String productId = additionalDataJson.get(DigitalizedCardProfileKeys.ADDITIONAL_DATA_PRODUCT_ID);
  final String cardImgFileName = BASE_PATH + productId + ".png";
  // Here calls loading card image and display
        See Also:
        Constant Field Values

      • ADDITIONAL_DATA_PAN_LAST_4_DIGITS

        public static final java.lang.String ADDITIONAL_DATA_PAN_LAST_4_DIGITS
        The key to get the PAN last 4 digits of the card. Similar to ADDITIONAL_DATA_PRODUCT_ID, this value is typically used to identify the card, either by the UI application or by the End-User.
        An example of mapping a card to its image using PAN last 4 digits is as following 
         
  final DigitalizedCardDetails details = card.getCardDetails(null).waitToComplete().getResult();
  final JSONObject additionalDataJson = new JSONObject(details.getValue(DigitalizedCardProfileKeys.ADDITIONAL_DATA);
  // Assuming that UI application uses the PAN last 4 digits as the image file name with extension .png
  final String panLast4Digits = additionalDataJson.get(DigitalizedCardProfileKeys.ADDITIONAL_DATA_PAN_LAST_4_DIGITS);
  final String cardImgFileName = BASE_PATH + panLast4Digits + ".png";
  // Here calls loading card image and display
        See Also:
        Constant Field Values

      • ADDITIONAL_DATA_PAN_EXPIRY

        public static final java.lang.String ADDITIONAL_DATA_PAN_EXPIRY
        Key to get the PAN Expiry data
        See Also:
        Constant Field Values

      • ADDITIONAL_DATA_ODA_CERTIFICATE_EXPIRY_DATA

        public static final java.lang.String ADDITIONAL_DATA_ODA_CERTIFICATE_EXPIRY_DATA
        The key to get the VISA ODA Certificate Expiry Date
        See Also:
        Constant Field Values

      • MASTERCARD_CARD_LAYOUT_DESC

        public static final java.lang.String MASTERCARD_CARD_LAYOUT_DESC
        Only for Mastercard.
        The key to get the card layout description which is the optional data element personalized by the issuer and containing the image of a card that for displaying on the MPA. This may not contain any value which depends on the Issuer.
        See Also:
        Constant Field Values

      • MASTERCARD_SECURITY_WORD

        public static final java.lang.String MASTERCARD_SECURITY_WORD
        Only for Mastercard.
        The key to get the MasterCard security word which is the static password used to authenticate the mobile MasterCard PayPass to the cardholder through the MPA.
        See Also:
        Constant Field Values

      • MASTERCARD_APPLICATION_LIFE_CYCLE_DATA

        public static final java.lang.String MASTERCARD_APPLICATION_LIFE_CYCLE_DATA
        Only for Mastercard.
        The key to get the application Life Cycle Data which contains the unique application ID of the issuer
        See Also:
        Constant Field Values

      • MASTERCARD_MCHIP_ISSUER_OPTIONS

        public static final java.lang.String MASTERCARD_MCHIP_ISSUER_OPTIONS
        Only for Mastercard.
        The key to get the M/Chip CVM Issuer Options which contains the issuer defined options related to the CVM applied by the application when working in the PayPass M/Chip mode.
        See Also:
        Constant Field Values

      • PAYMENT_CHANNELS

        public static final java.lang.String PAYMENT_CHANNELS
        Represents the field that identifies the supported payment channels for a card profile.
        The values are represented in hexadecimal format:
        • 0x80 - CONTACTLESS
        • 0x40 - DSRP
        • 0x20 - QR
        • 0xA0 - CONTACTLESS AND QR
        • 0xC0 - CONTACTLESS AND DSRP
        • 0xE0 - CONTACTLESS AND DSRP AND QR
        See ProfileChannel for more details.
        See Also:
        Constant Field Values

      • IS_US_AIP_MASKING_SUPPORTED

        public static final java.lang.String IS_US_AIP_MASKING_SUPPORTED
        See Also:
        Constant Field Values

      • CARD_COUNTRY_CODE

        public static final java.lang.String CARD_COUNTRY_CODE
        See Also:
        Constant Field Values

      • DIGITIZED_CARD_ID

        public static final java.lang.String DIGITIZED_CARD_ID
        See Also:
        Constant Field Values

      • IS_TRANSACTION_ID_REQUIRED

        public static final java.lang.String IS_TRANSACTION_ID_REQUIRED
        See Also:
        Constant Field Values