Package com.thalesgroup.gemalto.d1

Enum D1Exception.ErrorCode

    • Enum Constant Detail

      • ERROR_NOT_AUTHORIZED

        public static final D1Exception.ErrorCode ERROR_NOT_AUTHORIZED
        This operation is not authorized. Verify the parameters requested are correct. getCode() value: 10006.

        NOTE:
        Retry the operation again.

      • ERROR_DEVICE_ENVIRONMENT_UNSAFE

        public static final D1Exception.ErrorCode ERROR_DEVICE_ENVIRONMENT_UNSAFE
        The device environment is potentially unsafe, please ensure that the device environment is safe. getCode() value: 10007.

        NOTE:
        Ensure that the device environment is safe.

      • ERROR_CARD_NOT_FOUND

        public static final D1Exception.ErrorCode ERROR_CARD_NOT_FOUND
        The provided cardID is not found. getCode() value: 10009.

        NOTE:
        Integrator should ensure that the cardID is correct.

      • ERROR_NOT_ACTIVE

        public static final D1Exception.ErrorCode ERROR_NOT_ACTIVE
        The consumer/card is not in the active state. Please ensure that the card/consumer is in the active state. getCode() value: 10010.

        NOTE:
        Integrator should ensure that the card/consumer is in the active state.

      • ERROR_CORE

        public static final D1Exception.ErrorCode ERROR_CORE
        An error occurred whilst executing core operations. It is caused by a storage (unlikely) or a network failure. getCode() value: 20001.

        NOTE:
        Integrator should check the underlying errors for more details. Ensure that the device is connected to the internet.

      • ERROR_NO_CARD_ACTIVATION_METHOD

        public static final D1Exception.ErrorCode ERROR_NO_CARD_ACTIVATION_METHOD
        There was no card activation method found for this card. getCode() value: 20002.

        NOTE:
        Integrator should first retrieve the activation method for this card.

      • ERROR_UI_COMPONENT_NOT_FOUND

        public static final D1Exception.ErrorCode ERROR_UI_COMPONENT_NOT_FOUND
        The required UI component is not found. getCode() value: 20003.

        NOTE:
        Integrator should provide the necessary UI component.

      • ERROR_PIN_MISMATCH

        public static final D1Exception.ErrorCode ERROR_PIN_MISMATCH
        There was a mismatch with the PIN inputs. getCode() value: 20004.

        NOTE:
        Integrator should ensure that the provided PINs are identical.

      • ERROR_CARD_NOT_MANAGED_BY_D1

        public static final D1Exception.ErrorCode ERROR_CARD_NOT_MANAGED_BY_D1
        The consumer/card is not issued by D1. getCode() value: 20005.

        NOTE:
        The API only supports the consumerID on which the cards are issued by D1. Integrator should ensure the consumerID and cardID is issued by D1.

        Since:
        3.3.0

      • ERROR_PIN_INVALID

        public static final D1Exception.ErrorCode ERROR_PIN_INVALID
        The PIN inputs do not meet the PIN length or contain unexpected characters. getCode() value: 20010.

        NOTE:
        Integrator should ensure that the provided PINs meet the PIN length and contain only digits.

        Since:
        3.3.0

      • ERROR_CARD_OPERATION_NOT_ALLOWED

        public static final D1Exception.ErrorCode ERROR_CARD_OPERATION_NOT_ALLOWED
        Operation (resume/suspend/replace) is not allowed on the card which is issued by D1. It could be due to the card state and state reason. getCode() value: 40011.

        NOTE:
        Integrator should display information to user that the card operation is not allowed because the current card state and reason.

        Category - Managed Card Service

        Since:
        3.3.0

      • ERROR_CARD_OPERATION_INVALID_REASON

        public static final D1Exception.ErrorCode ERROR_CARD_OPERATION_INVALID_REASON
        Operation replace is not allowed on the card which is issued by D1. It could be due to the card state and state reason. getCode() value: 40012.

        NOTE:
        Please ensure that the state reason provided is valid for the given operation. Please refer StateReason.getReplaceReasons() for valid reasons.

        Category - Managed Card Service

        Since:
        3.3.0

      • ERROR_CARD_SETTINGS_OPERATION_NOT_ALLOWED

        public static final D1Exception.ErrorCode ERROR_CARD_SETTINGS_OPERATION_NOT_ALLOWED
        Operation updateCardLimit/updateCardControls settings is not allowed on the card which is issued by D1. Update is performed on null property from getCardSettings API. getCode() value: 40013.

        NOTE:
        Please do not set value on null property obtained from getCardSettings. The null property indicate that the field is not supported/configured on backend.

        Category - Managed Card Service

        Since:
        3.3.0

      • ERROR_CARD_SETTINGS_INVALID_FORMAT

        public static final D1Exception.ErrorCode ERROR_CARD_SETTINGS_INVALID_FORMAT
        Operation updateCardLimit/updateCardControls settings encounter error because the value is not following allowed format for the card which is issued by D1. getCode() value: 40014.

        NOTE:
        Please ensure that all properties included in the card settings object follows allowed format. Please refer ISO 3166-1 alpha-2 format for allowed country list and ISO 4217 alpha code format for allowed currency list.

      • ERROR_CARD_SETTINGS_INVALID_VALUE

        public static final D1Exception.ErrorCode ERROR_CARD_SETTINGS_INVALID_VALUE
        Operation updateCardLimit/updateCardControls settings encounter error because the input format is correct however value is incorrect for the card which is issued by D1. getCode() value: 40015.

        NOTE:
        Please ensure that all mandatory properties included in the card settings object having correct values.

        Since:
        3.3.0

      • ERROR_PUSH_TOKEN_NOT_FOUND

        public static final D1Exception.ErrorCode ERROR_PUSH_TOKEN_NOT_FOUND
        The push token is not found during notification registration.

        NOTE:
        Integrator should call D1Task.updatePushToken before calling MessagingService.registerMessageNotification

        Since:
        3.3.0

      • ERROR_RISK

        public static final D1Exception.ErrorCode ERROR_RISK
        Risk assessment failed. getCode() value: 30001.

        NOTE:
        Integrator should check the underlying errors for more details and also ensure that:

        • The risk credentials are correct.
        • The device is connected to the internet.

        Category - Risk API

        See Also:
        D1Task.Builder#setRiskURLString(String), D1Task.Builder#setRiskClientID(String)

      • ERROR_CARD

        public static final D1Exception.ErrorCode ERROR_CARD
        Errors occurred whilst executing card operations. getCode() value: 40001.

        NOTE:
        Integrator should check the underlying errors for more details. Ensure card configurations are correct and the device is connected to the internet.

        Category - Card API

      • ERROR_SPAY_APP_NOT_FOUND

        public static final D1Exception.ErrorCode ERROR_SPAY_APP_NOT_FOUND
        Samsung Pay App is not found on device. getCode() value: 40006.

        NOTE:
        Ask End user to install Samsung Pay app.

        Category - Card API

      • ERROR_GPAY_NOT_SUPPORTED

        public static final D1Exception.ErrorCode ERROR_GPAY_NOT_SUPPORTED
        The feature is not supported. It could be because of Google Pay not available. getCode() value: 40007.

        NOTE:
        Integrator should display information to the user.

      • ERROR_SPAY_NOT_SUPPORTED

        public static final D1Exception.ErrorCode ERROR_SPAY_NOT_SUPPORTED
        The feature is not supported. It could be because of Samsung Pay not available or Device model is not Samsung. getCode() value: 40008.

        NOTE:
        Integrator should display information to the user.

      • ERROR_GPAY

        public static final D1Exception.ErrorCode ERROR_GPAY
        Errors encountered whilst executing Google Pay operations. getCode() value: 40009.

        NOTE:
        Integrator should check the underlying errors for more details. Ensure Google Pay configurations are correct and the device has internet connection.

        Category - GPAY API

      • ERROR_SPAY

        public static final D1Exception.ErrorCode ERROR_SPAY
        Errors encountered whilst executing Samsung Pay operations. getCode() value: 40010.

        NOTE:
        Integrator should check the underlying errors for more details. Ensure Samsung Pay configurations are correct and the device has internet connection.

        Category - SPAY API

      • ERROR_D1PAY

        public static final D1Exception.ErrorCode ERROR_D1PAY
        Errors occurred whilst executing D1 Pay operations. getCode() value: 50001.

        NOTE:
        Integrator should check the underlying errors for more details. Ensure D1 Pay configurations are correct and the device is connected to the internet.

        Category - D1PAY API

      • ERROR_D1PAY_DELETION_IN_PROGRESS

        public static final D1Exception.ErrorCode ERROR_D1PAY_DELETION_IN_PROGRESS
        D1 Pay Token Deletion is in progress. getCode() value: 50006.

        This may happen rarely if digitization stopped in the middle for any reason, for example, End User may terminate the application or the application has crashed.

        NOTE:
        Integrator should wait for push notification on D1PayDataChangedListener.onDataChanged(String, State) for State.DELETED before performing digitization again.

        Category - D1 PAY API

      • ERROR_D1PAY_MOBILE_GATEWAY

        public static final D1Exception.ErrorCode ERROR_D1PAY_MOBILE_GATEWAY
        Error encountered in D1 Pay card mobile gateway operation. getCode() value: 50007.

        NOTE:
        Integrator should check the underlying errors for more details.

        Category - D1 PAY API

      • ERROR_D1PAY_PROVISIONING_SERVICE

        public static final D1Exception.ErrorCode ERROR_D1PAY_PROVISIONING_SERVICE
        Error encountered in D1 Pay provisioning operation. getCode() value: 50008.

        NOTE:
        Integrator should check the underlying errors for more details.

        Category - D1 PAY API

      • ERROR_D1PAY_PAYMENT_SERVICE

        public static final D1Exception.ErrorCode ERROR_D1PAY_PAYMENT_SERVICE
        Error encountered in D1Pay payment operation. getCode() value: 50009.

        NOTE:
        Integrator should check the underlying errors for more details.

        Category - D1PAY API

      • ERROR_D1PAY_VISA_REPLENISHMENT_AUTHENTICATION

        public static final D1Exception.ErrorCode ERROR_D1PAY_VISA_REPLENISHMENT_AUTHENTICATION
        Error encountered when D1Pay check whether VISA replenishment requires authentication. getCode() value: 50010.

        NOTE:
        Integrator should check the underlying errors for more details.

        Category - D1PAY API

      • ERROR_D1PAY_VISA_REPLENISHMENT_PREPARATION

        public static final D1Exception.ErrorCode ERROR_D1PAY_VISA_REPLENISHMENT_PREPARATION
        An error occurred when D1 Pay prepares a Visa replenishment. getCode() value: 50011.

        NOTE:
        Integrator should check the underlying errors for more details.

        Category - D1PAY API

      • ERROR_D1PAY_CARD_SUSPENDED

        public static final D1Exception.ErrorCode ERROR_D1PAY_CARD_SUSPENDED
        D1 Pay card has been suspended before or during payment activation process. getCode() value: 50012.

        NOTE:
        Integrator should notify user that the card has been suspended by the card issuer. Contact the card issuer for more information.

        Category - D1 PAY API

      • ERROR_D1PAY_CARD_NOT_EXISTING

        public static final D1Exception.ErrorCode ERROR_D1PAY_CARD_NOT_EXISTING
        D1 Pay card has been deleted before or during payment activation process. getCode() value: 50013.

        NOTE:
        Integrator should notify user that the card has been deleted by the card issuer. Contact the card issuer for more information.

        Category - D1 PAY API

      • ERROR_D1PAY_POS_COMM_DISCONNECTED

        public static final D1Exception.ErrorCode ERROR_D1PAY_POS_COMM_DISCONNECTED
        Error encountered when connection of the mobile device with POS terminal is lost while there is an APDU exchange. getCode() value: 50014.

        NOTE:
        Integrator should notify user to try again.

        Category - D1PAY API

      • ERROR_D1PAY_OUT_OF_PAYMENT_KEYS

        public static final D1Exception.ErrorCode ERROR_D1PAY_OUT_OF_PAYMENT_KEYS
        An error occurred when D1 Pay card does not have any payment keys left. This may happen when the handset is not connected to the internet for a long time. getCode() value: 50015.

        NOTE:
        Integrator should notify user that the user need to ensure an internet connection is available. When it is available, the card should be replenished.

        Category - D1 PAY API

      • ERROR_D1PAY_NO_DEFAULT_CARD

        public static final D1Exception.ErrorCode ERROR_D1PAY_NO_DEFAULT_CARD
        No D1 Pay card is set as default card. getCode() value: 50016.

        NOTE:
        Integrator should display a message and a list of available cards to the user.

        Category - D1PAY API

      • ERROR_D1PAY_BIOFP_CONDITION_NOT_SATISFIED

        public static final D1Exception.ErrorCode ERROR_D1PAY_BIOFP_CONDITION_NOT_SATISFIED
        An error occurred when there is no biometric identifier enrolled on device or the device screen lock type is changed to swipe. getCode() value: 50017.

        NOTE:
        Integrator should display the message to the user.

        Category - D1 PAY API

      • ERROR_D1PAY_CPS_UPGRADE_OR_INIT_IN_PROGRESS

        public static final D1Exception.ErrorCode ERROR_D1PAY_CPS_UPGRADE_OR_INIT_IN_PROGRESS
        An error occurred when the D1 Pay provisioning upgrade or initialization operation is ongoing. getCode() value: 50018.

        NOTE:
        Integrator should inform the user to try it again after 30 seconds.

        Category - D1PAY API

      • ERROR_D1PAY_NOT_SUPPORTED

        public static final D1Exception.ErrorCode ERROR_D1PAY_NOT_SUPPORTED
        The feature is not supported. It could be because of D1 Pay not available. Either Biometric or Screen Lock should be enabled. getCode() value: 50019.

        NOTE:
        Integrator should display information to the user.

      • ERROR_INVALID_ARGUMENT

        public static final D1Exception.ErrorCode ERROR_INVALID_ARGUMENT
        Errors encountered whilst executing initialization. getCode() value: 60002.

        NOTE:
        Integrator should check the underlying errors for more details. The required configuration parameters are missing or invalid.
        For Samsung Pay, please check if you register the App into Samsung Portal and you provide correct value of serviceId.
        For OEM Provisioning (Google Pay & Samsung Pay), make sure to set visaClientAppId on ConfigParams.buildConfigCard(Activity, OEMPayType, String, String)

      • ERROR_AUTHN

        public static final D1Exception.ErrorCode ERROR_AUTHN
        Authn operations failed. getCode() value: 70001.

        NOTE:
        Integrator should check the underlying errors for more details.

        Category - Authn API

      • ERROR_AUTHN_NOT_ENROLLED

        public static final D1Exception.ErrorCode ERROR_AUTHN_NOT_ENROLLED
        Authn User is not enrolled. getCode() value: 70002.

        NOTE:
        Integrator should first do authn enroll.

        Category - Authn API

      • ERROR_AUTHN_ACCESS_DENIED

        public static final D1Exception.ErrorCode ERROR_AUTHN_ACCESS_DENIED
        Authn Access denied. getCode() value: 70003.

        NOTE:
        Integrator should check whether user authenticate with wrong credential(fingerprint, face etc.)

        Category - Authn API

      • ERROR_AUTHN_USER_LOCKOUT

        public static final D1Exception.ErrorCode ERROR_AUTHN_USER_LOCKOUT
        Authn User Locked Out. getCode() value: 70004.

        NOTE:
        Integrator should ask user to wait as user authenticate with wrong credential(fingerprint, face etc.) too many times

        Category - Authn API

      • ERROR_AUTHN_INVALID_ENROLLMENT_TOKEN

        public static final D1Exception.ErrorCode ERROR_AUTHN_INVALID_ENROLLMENT_TOKEN
        Authn Invalid Enrollment Token. getCode() value: 70005.

        NOTE:
        Integrator should ask user to try again to enroll to get a fresh enrollment token

        Category - Authn API

    • Method Detail

      • values

        public static D1Exception.ErrorCode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (D1Exception.ErrorCode c : D1Exception.ErrorCode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static D1Exception.ErrorCode valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getCode

        public int getCode()
        Retrieves the code number of this error.
        Returns:
        The code number.

      • getMessage

        public String getMessage()
        Retrieves the underlying error and current error description.
        Returns:
        The error description.

      • getRecoverySuggestion

        public String getRecoverySuggestion()
        Retrieves recovery suggestion for this error.
        Returns:
        The recovery suggestion.