com.squareup.sdk.pos

Enum ChargeRequest.ErrorCode

java.lang.Object

java.lang.Enum<ChargeRequest.ErrorCode>

com.squareup.sdk.pos.ChargeRequest.ErrorCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ChargeRequest.ErrorCode>

Enclosing class:

ChargeRequest

public static enum ChargeRequest.ErrorCode
extends java.lang.Enum<ChargeRequest.ErrorCode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CUSTOMER_MANAGEMENT_NOT_SUPPORTED The merchant account does not support Customer Management.
DISABLED The Point of Sale API is not currently available.
ERROR_INVALID_CUSTOMER_ID The Customer Id is invalid.
GIFT_CARDS_NOT_SUPPORTED Deprecated. Starting with SDK 1.1, Square Point of Sale supports Square Prepaid Gift Cards.
ILLEGAL_LOCATION_ID The provided location ID does not correspond to the location currently logged in to Square Point of Sale.
INSUFFICIENT_CARD_BALANCE Deprecated. Starting with SDK 1.1, Square Point of Sale supports split tender transactions, so a transaction can be completed as a split tender if a card has insufficient balance.
INVALID_REQUEST The information provided in the transaction request was invalid (a required field might have been missing or malformed).
NO_EMPLOYEE_LOGGED_IN Employee management is enabled but no employee is logged in to Square Point of Sale.
NO_NETWORK Square Point of Sale was unable to validate the Point of Sale API request because the Android device did not have an active network connection.
NO_RESULT Square Point of Sale did not return a transaction result.
TRANSACTION_ALREADY_IN_PROGRESS Another Square Point of Sale transaction is already in progress.
TRANSACTION_CANCELED The merchant canceled the transaction.
UNAUTHORIZED_CLIENT_ID Deprecated. Starting with SDK 1.2, the OAuth authorization flow is no longer required for Point of Sale API, and this error will never be returned.
UNEXPECTED An unexpected error occurred.
UNSUPPORTED_API_VERSION The installed version of Square Point of Sale doesn't support this version of the Point of Sale SDK.
USER_NOT_ACTIVATED The merchant tried to process the transaction with a credit card, but the merchant's Square account has not yet been activated for card processing.
USER_NOT_LOGGED_IN No user is currently logged in to Square Point of Sale.

Method Summary

Modifier and Type	Method and Description
static ChargeRequest.ErrorCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ChargeRequest.ErrorCode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISABLED

public static final ChargeRequest.ErrorCode DISABLED

The Point of Sale API is not currently available.

CUSTOMER_MANAGEMENT_NOT_SUPPORTED

public static final ChargeRequest.ErrorCode CUSTOMER_MANAGEMENT_NOT_SUPPORTED

The merchant account does not support Customer Management.

ERROR_INVALID_CUSTOMER_ID

public static final ChargeRequest.ErrorCode ERROR_INVALID_CUSTOMER_ID

The Customer Id is invalid. This could happen if the account logged in to Square Point of Sale is different from the account from which the customer information was downloaded.

GIFT_CARDS_NOT_SUPPORTED

@Deprecated
public static final ChargeRequest.ErrorCode GIFT_CARDS_NOT_SUPPORTED

Deprecated. Starting with SDK 1.1, Square Point of Sale supports Square Prepaid Gift Cards.

ILLEGAL_LOCATION_ID

public static final ChargeRequest.ErrorCode ILLEGAL_LOCATION_ID

The provided location ID does not correspond to the location currently logged in to Square Point of Sale.

INSUFFICIENT_CARD_BALANCE

@Deprecated
public static final ChargeRequest.ErrorCode INSUFFICIENT_CARD_BALANCE

Deprecated. Starting with SDK 1.1, Square Point of Sale supports split tender transactions, so a transaction can be completed as a split tender if a card has insufficient balance.

INVALID_REQUEST

public static final ChargeRequest.ErrorCode INVALID_REQUEST

The information provided in the transaction request was invalid (a required field might have been missing or malformed). Error#debugDescription provides additional details.

NO_EMPLOYEE_LOGGED_IN

public static final ChargeRequest.ErrorCode NO_EMPLOYEE_LOGGED_IN

Employee management is enabled but no employee is logged in to Square Point of Sale.

NO_NETWORK

public static final ChargeRequest.ErrorCode NO_NETWORK

Square Point of Sale was unable to validate the Point of Sale API request because the Android device did not have an active network connection.

NO_RESULT

public static final ChargeRequest.ErrorCode NO_RESULT

Square Point of Sale did not return a transaction result. In only this case, any value that you provided in ChargeRequest.Builder.requestMetadata(String) will not be returned.

TRANSACTION_ALREADY_IN_PROGRESS

public static final ChargeRequest.ErrorCode TRANSACTION_ALREADY_IN_PROGRESS

Another Square Point of Sale transaction is already in progress. The merchant should open Square Point of Sale to complete or cancel the current transaction before attempting to initiate a new one.

TRANSACTION_CANCELED

public static final ChargeRequest.ErrorCode TRANSACTION_CANCELED

The merchant canceled the transaction.

UNAUTHORIZED_CLIENT_ID

@Deprecated
public static final ChargeRequest.ErrorCode UNAUTHORIZED_CLIENT_ID

Deprecated. Starting with SDK 1.2, the OAuth authorization flow is no longer required for Point of Sale API, and this error will never be returned.

UNEXPECTED

public static final ChargeRequest.ErrorCode UNEXPECTED

An unexpected error occurred. Please contact [email protected] and include any code snippets and descriptions of your use case that might help diagnose the issue.

UNSUPPORTED_API_VERSION

public static final ChargeRequest.ErrorCode UNSUPPORTED_API_VERSION

The installed version of Square Point of Sale doesn't support this version of the Point of Sale SDK. This is probably because the installed version of Square Point of Sale is out of date.

USER_NOT_ACTIVATED

public static final ChargeRequest.ErrorCode USER_NOT_ACTIVATED

The merchant tried to process the transaction with a credit card, but the merchant's Square account has not yet been activated for card processing.

USER_NOT_LOGGED_IN

public static final ChargeRequest.ErrorCode USER_NOT_LOGGED_IN

No user is currently logged in to Square Point of Sale.

Method Detail

values

public static ChargeRequest.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 (ChargeRequest.ErrorCode c : ChargeRequest.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 ChargeRequest.ErrorCode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null