Package com.thalesgroup.gemalto.d1.card.cardservice

Class CardControlSettings

  • public final class CardControlSettings
extends Object
    The card settings for the card issued by D1.
    Since:
    4.0.0

    • Constructor Detail

      • CardControlSettings

        public CardControlSettings()
        Internal constructor for CardSettingsControl object. Call the CardSettings.getControlSetting() API to initialize the CardControlSettings object.

    • Method Detail

      • isOnlinePaymentEnabled

        @NonNull
public Boolean isOnlinePaymentEnabled()
        Enable/Disable online payment setting of the card.

      • setOnlinePaymentEnabled

        public void setOnlinePaymentEnabled​(@NonNull
                                    Boolean enabled)
        To enable/disable the online payment setting of the card. Mandatory for getCardSettings API.

      • isContactlessEnabled

        @Nullable
public Boolean isContactlessEnabled()
        Enable/disable the contactless payment setting of the card.

      • setContactlessEnabled

        public void setContactlessEnabled​(@NonNull
                                  Boolean enabled)
        To enable/disable the contactless payment setting of the card. This is an optional parameter for getCardSettings API. In cases where this parameter is not available in getCardSettings() API and the end user tries to update it, D1 SDK will return D1Exception.ErrorCode.ERROR_CARD_SETTINGS_OPERATION_NOT_ALLOWED.

      • isMagneticStripeEnabled

        @Nullable
public Boolean isMagneticStripeEnabled()
        To enable/disable the magnetic stripe setting of the card.

      • setMagneticStripeEnabled

        public void setMagneticStripeEnabled​(@NonNull
                                     Boolean enabled)
        To enable/disable the magneticStripe setting of the card. This is an optional parameter for getCardSettings API. In cases where this parameter is not available in getCardSettings() API and the end user tries to update it, D1 SDK will return D1Exception.ErrorCode.ERROR_CARD_SETTINGS_OPERATION_NOT_ALLOWED.

      • isATMWithdrawalEnabled

        @Nullable
public Boolean isATMWithdrawalEnabled()
        Enable/disable the ATM withdrawal setting of the card.

      • setATMWithdrawalEnabled

        public void setATMWithdrawalEnabled​(@NonNull
                                    Boolean enabled)
        To enable/disable the ATM withdrawal setting of the card. This is an optional parameter for getCardSettings API. In cases where this parameter is not available in getCardSettings() API and the end user tries to update it, D1 SDK will return D1Exception.ErrorCode.ERROR_CARD_SETTINGS_OPERATION_NOT_ALLOWED.

      • isAbroadPaymentEnabled

        @NonNull
public Boolean isAbroadPaymentEnabled()
        Enable/disable the abroad payment setting of the card.

      • setAbroadPaymentEnabled

        public void setAbroadPaymentEnabled​(@NonNull
                                    Boolean enabled)
        To enable/disable abroad payment setting of the card. Mandatory for getCardSettings API.

      • getDeniedCurrencyList

        @NonNull
public List<String> getDeniedCurrencyList()
        Gets the list of currencies, in ISO 4217 alpha code format, that will not be authorized. Mandatory for getCardSettings API

      • setDeniedCurrencyList

        public void setDeniedCurrencyList​(@NonNull
                                  List<String> currencyList)
        Defines the list of currencies, in ISO 4217 alpha code format, that will not be authorized.

      • getGeography

        @NonNull
public CardControlSettings.Geography getGeography()
        Gets the list of countries and regions that the card is allowed to use. If the geographical location is not defined then no geography control is performed; the card can be used worldwide. Mandatory for getCardSettings API

      • setGeography

        public void setGeography​(@NonNull
                         CardControlSettings.Geography geography)
        Defines the list of countries and regions that the card is allowed to use. If the geographical location is not defined then no geography control is performed, the card can be used worldwide.

      • getMerchant

        public CardControlSettings.Merchant getMerchant()
        The set of controls which is applied on the merchant category. Mandatory for getCardSettings API.

      • setMerchant

        public void setMerchant​(CardControlSettings.Merchant merchant)
        Sets the set of controls which is applied on the merchant category.

      • restore

        public void restore()
        Restores the card control settings.