• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”
Enum
You are viewing an old version of the API

ErrorCode

Indicates the specific error that occurred during a request to a Square API.

Values

INTERNAL_SERVER_ERROR

A general server error occurred.

UNAUTHORIZED

A general authorization error occurred.

ACCESS_TOKEN_EXPIRED

The provided access token has expired.

ACCESS_TOKEN_REVOKED

The provided access token has been revoked.

CLIENT_DISABLED

The provided client has been disabled.

FORBIDDEN

A general access error occurred.

INSUFFICIENT_SCOPES

The provided access token does not have permission to execute the requested action.

APPLICATION_DISABLED

The calling application was disabled.

V1_APPLICATION

The calling application was created prior to 2016-03-30 and is not compatible with v2 Square API calls.

V1_ACCESS_TOKEN

The calling application is using an access token created prior to 2016-03-30 and is not compatible with v2 Square API calls.

CARD_PROCESSING_NOT_ENABLED

The location provided in the API call is not enabled for credit card processing.

BAD_REQUEST

A general error occurred with the request.

MISSING_REQUIRED_PARAMETER

The request is missing a required path, query, or body parameter.

INCORRECT_TYPE

The value provided in the request is the wrong type. For example, a string instead of an integer.

INVALID_TIME

Formatting for the provided time value is incorrect.

INVALID_TIME_RANGE

The time range provided in the request is invalid. For example, the end time is before the start time.

INVALID_VALUE

The provided value is invalid. For example, including % in a phone number.

INVALID_CURSOR

The pagination cursor included in the request is invalid.

UNKNOWN_QUERY_PARAMETER

The query parameters provided is invalid for the requested endpoint.

CONFLICTING_PARAMETERS

One or more of the request parameters conflict with each other.

EXPECTED_JSON_BODY

The request body is not a JSON object.

INVALID_SORT_ORDER

The provided sort order is not a valid key. Currently, sort order must be ASC or DESC.

VALUE_REGEX_MISMATCH

The provided value does not match an expected regular expression.

VALUE_TOO_SHORT

The provided string value is shorter than the minimum length allowed.

VALUE_TOO_LONG

The provided string value is longer than the maximum length allowed.

VALUE_TOO_LOW

The provided value is less than the supported minimum.

VALUE_TOO_HIGH

The provided value is greater than the supported maximum.

VALUE_EMPTY

The provided value has a default (empty) value such as a blank string.

ARRAY_LENGTH_TOO_LONG

The provided array has too many elements.

ARRAY_LENGTH_TOO_SHORT

The provided array has too few elements.

ARRAY_EMPTY

The provided array is empty.

EXPECTED_BOOLEAN

The endpoint expected the provided value to be a boolean.

EXPECTED_INTEGER

The endpoint expected the provided value to be an integer.

EXPECTED_FLOAT

The endpoint expected the provided value to be a float.

EXPECTED_STRING

The endpoint expected the provided value to be a string.

EXPECTED_OBJECT

The endpoint expected the provided value to be a JSON object.

EXPECTED_ARRAY

The endpoint expected the provided value to be an array or list.

EXPECTED_MAP

The endpoint expected the provided value to be a map or associative array.

EXPECTED_BASE64_ENCODED_BYTE_ARRAY

The endpoint expected the provided value to be an array encoded in base64.

INVALID_ARRAY_VALUE

One or more objects in the array does not match the array type.

INVALID_ENUM_VALUE

The provided static string is not valid for the field.

INVALID_CONTENT_TYPE

Invalid content type header.

INVALID_FORM_VALUE

Only relevant for applications created prior to 2016-03-30. Indicates there was an error while parsing form values.

CUSTOMER_NOT_FOUND

The provided customer id can't be found in the merchant's customers list.

ONE_INSTRUMENT_EXPECTED

A general error occurred.

NO_FIELDS_SET

A general error occurred.

TOO_MANY_MAP_ENTRIES

Too many entries in the map field.

MAP_KEY_LENGTH_TOO_SHORT

The length of one of the provided keys in the map is too short.

MAP_KEY_LENGTH_TOO_LONG

The length of one of the provided keys in the map is too long.

CARD_EXPIRED

The card issuer declined the request because the card is expired.

INVALID_EXPIRATION

The expiration date for the payment card is invalid. For example, it indicates a date in the past.

INVALID_EXPIRATION_YEAR

The expiration year for the payment card is invalid. For example, it indicates a year in the past or contains invalid characters.

INVALID_EXPIRATION_DATE

The expiration date for the payment card is invalid. For example, it contains invalid characters.

UNSUPPORTED_CARD_BRAND

The credit card provided is not from a supported issuer.

UNSUPPORTED_ENTRY_METHOD

The entry method for the credit card (swipe, dip, tap) is not supported.

INVALID_ENCRYPTED_CARD

The encrypted card information is invalid.

INVALID_CARD

The credit card cannot be validated based on the provided details.

GENERIC_DECLINE

Square received a decline without any additional information. If the payment information seems correct, the buyer can contact their issuer to ask for more information.

CVV_FAILURE

The card issuer declined the request because the CVV value is invalid.

ADDRESS_VERIFICATION_FAILURE

The card issuer declined the request because the postal code is invalid.

INVALID_ACCOUNT

The issuer was not able to locate the account on record.

CURRENCY_MISMATCH

The currency associated with the payment is not valid for the provided funding source. For example, a gift card funded in USD cannot be used to process payments in GBP.

INSUFFICIENT_FUNDS

The funding source has insufficient funds to cover the payment.

INSUFFICIENT_PERMISSIONS

The Square account does not have the permissions to accept this payment. For example, Square may limit which merchants are allowed to receive gift card payments.

CARDHOLDER_INSUFFICIENT_PERMISSIONS

The card issuer has declined the transaction due to restrictions on where the card can be used. For example, a gift card is limited to a single merchant.

INVALID_LOCATION

The Square account cannot take payments in the specified region. A Square account can take payments only from the region where the account was created.

TRANSACTION_LIMIT

The card issuer has determined the payment amount is either too high or too low. The API returns the error code mostly for credit cards (for example, the card reached the credit limit). However, sometimes the issuer bank can indicate the error for debit or prepaid cards (for example, card has insufficient funds).

VOICE_FAILURE

The card issuer declined the request because the issuer requires voice authorization from the cardholder.

PAN_FAILURE

The specified card number is invalid. For example, it is of incorrect length or is incorrectly formatted.

EXPIRATION_FAILURE

The card expiration date is either invalid or indicates that the card is expired.

CARD_NOT_SUPPORTED

The card is not supported either in the geographic region or by the merchant category code (MCC).

INVALID_PIN

The card issuer declined the request because the PIN is invalid.

INVALID_POSTAL_CODE

The postal code is incorrectly formatted.

INVALID_FEES

The app_fee_money on a payment is too high.

MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED

The card must be swiped, tapped, or dipped. Payments attempted by manually entering the card number are declined.

PAYMENT_LIMIT_EXCEEDED

Square declined the request because the payment amount exceeded the processing limit for this merchant.

GIFT_CARD_AVAILABLE_AMOUNT

When a Gift Card is a payment source, you can allow taking a partial payment by adding the accept_partial_authorization parameter in the request. However, taking such a partial payment does not work if your request also includes tip_money, app_fee_money, or both. Square declines such payments and returns the GIFT_CARD_AVAILABLE_AMOUNT error. For more information, see CreatePayment errors (additional information).

ACCOUNT_UNUSABLE

The account provided cannot carry out transactions.

BUYER_REFUSED_PAYMENT

Bank account rejected or was not authorized for the payment.

DELAYED_TRANSACTION_EXPIRED

The application tried to update a delayed-capture payment that has expired.

DELAYED_TRANSACTION_CANCELED

The application tried to cancel a delayed-capture payment that was already cancelled.

DELAYED_TRANSACTION_CAPTURED

The application tried to capture a delayed-capture payment that was already captured.

DELAYED_TRANSACTION_FAILED

The application tried to update a delayed-capture payment that failed.

CARD_TOKEN_EXPIRED

The provided card token (nonce) has expired.

CARD_TOKEN_USED

The provided card token (nonce) was already used to process payment.

AMOUNT_TOO_HIGH

The requested payment amount is too high for the provided payment source.

UNSUPPORTED_INSTRUMENT_TYPE

The API request references an unsupported instrument type/

REFUND_AMOUNT_INVALID

The requested refund amount exceeds the amount available to refund.

REFUND_ALREADY_PENDING

The payment already has a pending refund.

PAYMENT_NOT_REFUNDABLE

The payment is not refundable. For example, a previous refund has already been rejected and no new refunds can be accepted.

REFUND_DECLINED

Request failed - The card issuer declined the refund.

INVALID_CARD_DATA

Generic error - the provided card data is invalid.

SOURCE_USED

The provided source id was already used to create a card.

SOURCE_EXPIRED

The provided source id has expired.

UNSUPPORTED_LOYALTY_REWARD_TIER

The referenced loyalty program reward tier is not supported. This could happen if the reward tier created in a first party application is incompatible with the Loyalty API.

LOCATION_MISMATCH

Generic error - the given location does not matching what is expected.

IDEMPOTENCY_KEY_REUSED

The provided idempotency key has already been used.

UNEXPECTED_VALUE

General error - the value provided was unexpected.

SANDBOX_NOT_SUPPORTED

The API request is not supported in sandbox.

INVALID_EMAIL_ADDRESS

The provided email address is invalid.

INVALID_PHONE_NUMBER

The provided phone number is invalid.

CHECKOUT_EXPIRED

The provided checkout URL has expired.

BAD_CERTIFICATE

Bad certificate.

INVALID_SQUARE_VERSION_FORMAT

The provided Square-Version is incorrectly formatted.

API_VERSION_INCOMPATIBLE

The provided Square-Version is incompatible with the requested action.

CARD_DECLINED

The card was declined.

VERIFY_CVV_FAILURE

The CVV could not be verified.

VERIFY_AVS_FAILURE

The AVS could not be verified.

CARD_DECLINED_CALL_ISSUER

The payment card was declined with a request for the card holder to call the issuer.

CARD_DECLINED_VERIFICATION_REQUIRED

The payment card was declined with a request for additional verification.

BAD_EXPIRATION

The card expiration date is either missing or incorrectly formatted.

CHIP_INSERTION_REQUIRED

The card issuer requires that the card be read using a chip reader.

ALLOWABLE_PIN_TRIES_EXCEEDED

The card has exhausted its available pin entry retries set by the card issuer. Resolving the error typically requires the card holder to contact the card issuer.

RESERVATION_DECLINED

The card issuer declined the refund.

NOT_FOUND

Not Found - a general error occurred.

APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND

Square could not find the associated Apple Pay certificate.

METHOD_NOT_ALLOWED

Method Not Allowed - a general error occurred.

NOT_ACCEPTABLE

Not Acceptable - a general error occurred.

REQUEST_TIMEOUT

Request Timeout - a general error occurred.

CONFLICT

Conflict - a general error occurred.

GONE

The target resource is no longer available and this condition is likely to be permanent.

REQUEST_ENTITY_TOO_LARGE

Request Entity Too Large - a general error occurred.

UNSUPPORTED_MEDIA_TYPE

Unsupported Media Type - a general error occurred.

UNPROCESSABLE_ENTITY

Unprocessable Entity - a general error occurred.

RATE_LIMITED

Rate Limited - a general error occurred.

NOT_IMPLEMENTED

Not Implemented - a general error occurred.

BAD_GATEWAY

Bad Gateway - a general error occurred.

SERVICE_UNAVAILABLE

Service Unavailable - a general error occurred.

TEMPORARY_ERROR

A temporary internal error occurred. You can safely retry your call using the same idempotency key.

GATEWAY_TIMEOUT

Gateway Timeout - a general error occurred.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?