com.symbol.emdk.payment

Enum PaymentResults

java.lang.Object

java.lang.Enum<PaymentResults>

com.symbol.emdk.payment.PaymentResults

All Implemented Interfaces:

Serializable, Comparable<PaymentResults>

public enum PaymentResults
extends Enum<PaymentResults>

Defines all the error codes the payment API returns.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACCOUNT_NUMBER_MISMATCH The account does not match account number of card used.
ALREADY_CLOSED The device is already closed.
ALREADY_ENABLED Payment device is already enabled and its ready to use.
API_SEQUENCE_ERROR API not called in specific order.
APP_EXPIRED The Card App is expired.
AUTHENTICATION_FAILED Payment device authentication failed.
AUTHORIZATION_FAILED Application authorization failed.
CANCEL_KEY_PRESSED Deprecated.
CANNOT_ABORT Abort does not support aborting the previously requested command
CARD_AUTHENTICATION_FAILED Card data authentication failed.
CARD_BLOCKED The card is blocked.
CARD_EXPIRED The card is expired.
CARD_INSERTION_ERROR Deprecated.
CARD_NOT_AUTHORIZED Deprecated.
CARD_REMOVED Card removed while payment device was reading the card data.
CARD_SWIPE_ERROR Error occurred while swiping the card.
CHIP_READ_ERROR Error occurred while reading chip or IC.
CHIP_READ_NO_APP_ERROR No app to read the chip on this card.
COMMUNICATION_ERROR Communication error occurred.
CONNECTION_ERROR Bluetooth connection error.
DEVICE_IN_USE Payment device is already used by other application.
DEVICE_NOT_ENABLED The payment device is not enabled.
DEVICE_NOT_PAIRED The payment device is not paired.
DEVICE_UPDATE_IN_PROGRESS The PD40 Device Upadate is in progress.
DISABLE_FAILED Failed to disable the payment device.
DISABLED New state when PD40 disconnects or goes out of range
DOWNLOAD_TIMEOUT The download file specified does not exists.
EMV_APP_ADD_ERROR Failed to add the EMV APP/EMV CAPK.
EMV_APP_NOT_SELECTED Must set the Emv App before calling this method.
EMV_CAPK_ADD_ERROR Add EMV CAPK failed
EMV_TRANSACTION_DENIED EMV transaction is denied.
EMV_TRANSACTION_ERROR EMV transaction error or not expected.
ENABLE_FAILED Failed to enable the payment device.
FAILURE Operation is failed.
FEATURE_NOT_SUPPORTED The feature is not supported.
FILE_NOT_FOUND The file specified in the file downLoad does not exists.
FILE_VERIFICATION_FAILED The download file format is not valid.
GAC_CARD_LOOPBACK Deprecated.
GAC_RESPONSE_ERROR Deprecated.
GET_ONLINE_PIN_FAILED Get Online PIN failed.
INCOMPETE_DATA The sent data is incomplete or incorrect.
INVALID_CONFIGURATION The payment device configuration is not correct.
INVALID_DATA_LENGTH Invalid data length
INVALID_MAC_KEY_LENGTH Invalid MAC key length.
INVALID_OBJECT The object is invalid.
INVALID_PIN_LENGTH Invalid maximum and minimum PIN length
INVALID_VALUE The parameter value is not correct.
LOW_POWER_OPERATION_CANCELLED The payment device is low power and operation is cancelled.
MAC_BLOCK_CREATE_ERROR Error occured during mac block creation.
MAC_KEY_CREATE_ERROR Error occured during mac key creation.
MAC_VALIDATION_ERROR Mac validation failed.
NO_DATA_LISTENER Data listener is not added.
NO_DUKPT_KEY No DUKPT key to get PIN
NO_ENCRYPTION_KEY Data encryption key is not injected on Payment Device.
NO_PIN_INPUT User choose to bypass PIN.
NULL_POINTER Null value is passed as input parameter.
OK_KEY_PRESSED OK or Enter key is pressed by the user.
OPERATION_CANCELLED The operation is cancelled by the user.
PREVIOUS_COMMAND_PENDING Previously requested command is in progress, wait for it to complete.
REMOVECARD_COMMAND_PENDING RemoveCard is pending, Please remove the card to perform other requests.
REPETITIVE_OPERATION Same command is repeated
SUCCESS Success.
TIMED_OUT Operation is timed out.
TLV_DATA_ERROR Tag-Length-Value data format error.
UNDEFINED Error code not defined.
UNSUPPORTED_ENCRYPTION_TYPE Encryption type not supported.
UPDATE_FILE_SIGNATURE_ERROR Update file signature error.
UPDATE_FILE_TOO_LARGE Update file too large to update.
UPDATE_FILE_WRITE_ERROR Failed to update or flash the file sent.

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the description for the error.
int	getValue() This method provides integer value assigned to the enum.
static PaymentResults	valueOf(String name) Returns the enum constant of this type with the specified name.
static PaymentResults[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SUCCESS

public static final PaymentResults SUCCESS

Success.

INVALID_VALUE

public static final PaymentResults INVALID_VALUE

The parameter value is not correct.

AUTHORIZATION_FAILED

public static final PaymentResults AUTHORIZATION_FAILED

Application authorization failed.

FAILURE

public static final PaymentResults FAILURE

Operation is failed.

TIMED_OUT

public static final PaymentResults TIMED_OUT

Operation is timed out.

AUTHENTICATION_FAILED

public static final PaymentResults AUTHENTICATION_FAILED

Payment device authentication failed.

ENABLE_FAILED

public static final PaymentResults ENABLE_FAILED

Failed to enable the payment device.

DISABLE_FAILED

public static final PaymentResults DISABLE_FAILED

Failed to disable the payment device.

ALREADY_ENABLED

public static final PaymentResults ALREADY_ENABLED

Payment device is already enabled and its ready to use.

OPERATION_CANCELLED

public static final PaymentResults OPERATION_CANCELLED

The operation is cancelled by the user.

OK_KEY_PRESSED

public static final PaymentResults OK_KEY_PRESSED

OK or Enter key is pressed by the user.

CANCEL_KEY_PRESSED

@Deprecated
public static final PaymentResults CANCEL_KEY_PRESSED

Deprecated.

LOW_POWER_OPERATION_CANCELLED

public static final PaymentResults LOW_POWER_OPERATION_CANCELLED

The payment device is low power and operation is cancelled.

TLV_DATA_ERROR

public static final PaymentResults TLV_DATA_ERROR

Tag-Length-Value data format error.

MAC_KEY_CREATE_ERROR

public static final PaymentResults MAC_KEY_CREATE_ERROR

Error occured during mac key creation.

MAC_BLOCK_CREATE_ERROR

public static final PaymentResults MAC_BLOCK_CREATE_ERROR

Error occured during mac block creation.

MAC_VALIDATION_ERROR

public static final PaymentResults MAC_VALIDATION_ERROR

Mac validation failed.

INVALID_MAC_KEY_LENGTH

public static final PaymentResults INVALID_MAC_KEY_LENGTH

Invalid MAC key length.

INVALID_DATA_LENGTH

public static final PaymentResults INVALID_DATA_LENGTH

Invalid data length

INVALID_PIN_LENGTH

public static final PaymentResults INVALID_PIN_LENGTH

Invalid maximum and minimum PIN length

ALREADY_CLOSED

public static final PaymentResults ALREADY_CLOSED

The device is already closed.

CHIP_READ_ERROR

public static final PaymentResults CHIP_READ_ERROR

Error occurred while reading chip or IC.

CARD_BLOCKED

public static final PaymentResults CARD_BLOCKED

The card is blocked.

CHIP_READ_NO_APP_ERROR

public static final PaymentResults CHIP_READ_NO_APP_ERROR

No app to read the chip on this card.

CARD_INSERTION_ERROR

@Deprecated
public static final PaymentResults CARD_INSERTION_ERROR

Deprecated.

DEVICE_NOT_PAIRED

public static final PaymentResults DEVICE_NOT_PAIRED

The payment device is not paired.

DEVICE_NOT_ENABLED

public static final PaymentResults DEVICE_NOT_ENABLED

The payment device is not enabled.

INVALID_CONFIGURATION

public static final PaymentResults INVALID_CONFIGURATION

The payment device configuration is not correct.

COMMUNICATION_ERROR

public static final PaymentResults COMMUNICATION_ERROR

Communication error occurred.

FEATURE_NOT_SUPPORTED

public static final PaymentResults FEATURE_NOT_SUPPORTED

The feature is not supported.

INVALID_OBJECT

public static final PaymentResults INVALID_OBJECT

The object is invalid.

NO_DATA_LISTENER

public static final PaymentResults NO_DATA_LISTENER

Data listener is not added.

PREVIOUS_COMMAND_PENDING

public static final PaymentResults PREVIOUS_COMMAND_PENDING

Previously requested command is in progress, wait for it to complete.

CARD_SWIPE_ERROR

public static final PaymentResults CARD_SWIPE_ERROR

Error occurred while swiping the card.

EMV_APP_NOT_SELECTED

public static final PaymentResults EMV_APP_NOT_SELECTED

Must set the Emv App before calling this method.

EMV_APP_ADD_ERROR

public static final PaymentResults EMV_APP_ADD_ERROR

Failed to add the EMV APP/EMV CAPK.

EMV_TRANSACTION_DENIED

public static final PaymentResults EMV_TRANSACTION_DENIED

EMV transaction is denied.

CARD_EXPIRED

public static final PaymentResults CARD_EXPIRED

The card is expired.

APP_EXPIRED

public static final PaymentResults APP_EXPIRED

The Card App is expired.

CARD_NOT_AUTHORIZED

@Deprecated
public static final PaymentResults CARD_NOT_AUTHORIZED

Deprecated.

API_SEQUENCE_ERROR

public static final PaymentResults API_SEQUENCE_ERROR

API not called in specific order.

DEVICE_IN_USE

public static final PaymentResults DEVICE_IN_USE

Payment device is already used by other application. Close the previous session before using it or set the forceEnable to true in the payment configuration to forcibly close the previous session.

CONNECTION_ERROR

public static final PaymentResults CONNECTION_ERROR

Bluetooth connection error. Try calling enable..

NULL_POINTER

public static final PaymentResults NULL_POINTER

Null value is passed as input parameter.

CARD_REMOVED

public static final PaymentResults CARD_REMOVED

Card removed while payment device was reading the card data.

EMV_TRANSACTION_ERROR

public static final PaymentResults EMV_TRANSACTION_ERROR

EMV transaction error or not expected.

CARD_AUTHENTICATION_FAILED

public static final PaymentResults CARD_AUTHENTICATION_FAILED

Card data authentication failed.

GET_ONLINE_PIN_FAILED

public static final PaymentResults GET_ONLINE_PIN_FAILED

Get Online PIN failed.

GAC_CARD_LOOPBACK

@Deprecated
public static final PaymentResults GAC_CARD_LOOPBACK

Deprecated.

GAC_RESPONSE_ERROR

@Deprecated
public static final PaymentResults GAC_RESPONSE_ERROR

Deprecated.

NO_DUKPT_KEY

public static final PaymentResults NO_DUKPT_KEY

No DUKPT key to get PIN

EMV_CAPK_ADD_ERROR

public static final PaymentResults EMV_CAPK_ADD_ERROR

Add EMV CAPK failed

ACCOUNT_NUMBER_MISMATCH

public static final PaymentResults ACCOUNT_NUMBER_MISMATCH

The account does not match account number of card used.

UPDATE_FILE_TOO_LARGE

public static final PaymentResults UPDATE_FILE_TOO_LARGE

Update file too large to update.

UPDATE_FILE_SIGNATURE_ERROR

public static final PaymentResults UPDATE_FILE_SIGNATURE_ERROR

Update file signature error.

UPDATE_FILE_WRITE_ERROR

public static final PaymentResults UPDATE_FILE_WRITE_ERROR

Failed to update or flash the file sent.

INCOMPETE_DATA

public static final PaymentResults INCOMPETE_DATA

The sent data is incomplete or incorrect.

DISABLED

public static final PaymentResults DISABLED

New state when PD40 disconnects or goes out of range

CANNOT_ABORT

public static final PaymentResults CANNOT_ABORT

Abort does not support aborting the previously requested command

REMOVECARD_COMMAND_PENDING

public static final PaymentResults REMOVECARD_COMMAND_PENDING

RemoveCard is pending, Please remove the card to perform other requests.

UNSUPPORTED_ENCRYPTION_TYPE

public static final PaymentResults UNSUPPORTED_ENCRYPTION_TYPE

Encryption type not supported.

NO_ENCRYPTION_KEY

public static final PaymentResults NO_ENCRYPTION_KEY

Data encryption key is not injected on Payment Device.

NO_PIN_INPUT

public static final PaymentResults NO_PIN_INPUT

User choose to bypass PIN.

REPETITIVE_OPERATION

public static final PaymentResults REPETITIVE_OPERATION

Same command is repeated

FILE_NOT_FOUND

public static final PaymentResults FILE_NOT_FOUND

The file specified in the file downLoad does not exists.

DOWNLOAD_TIMEOUT

public static final PaymentResults DOWNLOAD_TIMEOUT

The download file specified does not exists.

DEVICE_UPDATE_IN_PROGRESS

public static final PaymentResults DEVICE_UPDATE_IN_PROGRESS

The PD40 Device Upadate is in progress.

FILE_VERIFICATION_FAILED

public static final PaymentResults FILE_VERIFICATION_FAILED

The download file format is not valid.

UNDEFINED

public static final PaymentResults UNDEFINED

Error code not defined.

Method Detail

values

public static PaymentResults[] 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 (PaymentResults c : PaymentResults.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PaymentResults 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

getValue

public int getValue()

This method provides integer value assigned to the enum. It is recommended only to get error for the UNDEFINED enums at runtime if required.

Returns:

Integer value associated with the error code.

getDescription

public String getDescription()

Returns the description for the error.

Returns:

Returns error description.