Welcome to our new developer portal! Use the "Ask" button to chat with our AI Agent.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

SDK error codes

The merchant application may encounter the following SDK error codes if prerequisites are not configured.

Android

Error code
Use case
Recommendation

AUTHENTICATION_FAILURE_CANCEL

This error is returned when device authentication fails.

  • Display the error message to the end user.

DEVICE_AUTHENTICATION_NOT_SUPPORTED

This error is returned when biometric authentication is not set up on the device.

  • Display the error message to the end user.

CRYPTO_ERROR

This error is returned when there is a keystore issue.

  • Display the error message to the end user.

INVALID_PARAMETERS

This error is returned when the configuration parameters are not valid.

  • Display the error message to the end user.

INVALID_DEVICE_AUTHENTICATION_PARAM

This error is returned when the FragmentActivity parameter is null.

  • Display the error message to the end user.

STORAGE_ERROR

This error is returned when the device authentication method is not found in storage.

  • Display the error message to the end user.

TOKEN_NOT_BOUNDED

This error is returned when the provided token is not bound to the device.

  • Display the error message to the end user.

TOKEN_ALREADY_BOUNDED

This error is returned when the provided token is already bound to the device or pending activation.

  • Display the error message to the end user.

TOKEN_DEVICE_BINDING_PENDING

This error is returned when the device binding process is still pending.

  • Complete the device binding process.

TOKEN_DEVICE_BINDING_DECLINED

This error is returned when the token device binding is declined.

  • Display the error message to the end user.

INVALID_IDV_METHOD

This error is returned when the provided ID&V method is invalid.

  • Display the error message to the end user.

ISSUER_AUTHENTICATION_REQUIRED

This error is returned when issuer authentication is required before the end user can proceed.

  • Select an ID&V method using IDVSession.selectIdvMethod().

INVALID_OTP

This error is returned when the input OTP is in an invalid format.

  • The OTP must not be null or empty, and must be 8 digits or fewer.

JSON_PARSING_ERROR

This error is returned when an error occurs while parsing JSON.

  • Display the error message.

INVALID_TOKEN_ID

This error is returned when the Visa Provisioned Token ID provided is null or empty.

  • Display the error message.

KEYSTORE_ERROR

This error is returned when the key is permanently invalidated. For example, the end user enrolls a new biometric (fingerprint).

  • Display the error message.

ATTESTATION_ERROR

This error is returned when an issue occurs while generating the attestation object.

  • Display the error message.

iOS

Error code
Use case
Recommendation

TMGError.tokenNotBound

This error is returned when the provided token is not bound to the device.

  • Display the error message to the end user.

TMGError.tokenPending

This error is returned when the device binding process is still pending.

  • Complete the device binding process.

TMGError.tokenDeclined

This error is returned when the token device binding is declined.

  • Display the error message to the end user.

TMGError.tokenAlreadyBound

This error is returned when the provided token is already bound to the device or pending activation.

  • Display the error message to the end user.

TMGError.invalidConfigParams

This error is returned when the TMGClientConfiguration parameter is not valid.

  • Check the implementation details.

TMGError.invalidRequiredParams

This error is returned when the mandatory parameters are invalid.

  • Check the implementation details.

TMGError.invalidIdvMethod

This error is returned when the provided ID&V method is invalid.

  • Display the error message to the end user.

TMGError.invalidOTPMessage

This error is returned when the input OTP is in an invalid format.

  • The OTP must not be null or empty, and must be 8 digits or fewer.

TMGError.issuerAuthenticationRequired

This error is returned when issuer authentication is required before the end user can proceed.

  • Select an ID&V method using PendingBindingSession.selectIdvMethod().

TMGError.biometricNotSupported

This error is returned when biometric authentication is not set up on the device.

  • Display the error message to the end user.

TMGError.authenticationFailure(reason: String)

This error is returned when device authentication fails.

  • Display the error message to the end user.

TMGError.authenticationKeyInvalidated

This error is returned when the end user changes the biometrics used for authentication. For example, the end user updates Face ID or fingerprint settings. When this error is returned, the cryptographic key pair is no longer accessible, and all tokens are automatically unbound.

  • Display the error message to the end user.

TMGError.internalError(additionalMessage: String)

This error is returned when an internal error occurs. The additionalMessage provides more detail. This error is not recoverable. Contact Thales support.

  • Display the generic error message to the end user.

TMGError.deviceEnvironmentUnsafe(code: Int)

This error is returned when the device environment is potentially unsafe. Check the obfuscated error code with Thales.

  • Display the error message to the end user.

Last updated

Was this helpful?