Indicates the specific error that occurred during a request to a Square API.
<- Enum
Enum
Indicates the specific error that occurred during a request to a Square API.
The provided access token does not have permission to execute the requested action.
The calling application was created prior to 2016-03-30 and is not compatible with v2 Square API calls.
The calling application is using an access token created prior to 2016-03-30 and is not compatible with v2 Square API calls.
The location provided in the API call is not enabled for credit card processing.
Beta
A required subscription was not found for the merchant
The request is missing a required path, query, or body parameter.
The value provided in the request is the wrong type. For example, a string instead of an integer.
The time range provided in the request is invalid. For example, the end time is before the start time.
The provided value is invalid. For example, including % in a phone number.
The query parameters provided is invalid for the requested endpoint.
One or more of the request parameters conflict with each other.
The provided sort order is not a valid key. Currently, sort order must be ASC or DESC.
The provided value does not match an expected regular expression.
The endpoint expected the provided value to be a map or associative array.
The endpoint expected the provided value to be an array encoded in base64.
Only relevant for applications created prior to 2016-03-30. Indicates there was an error while parsing form values.
The provided customer id can't be found in the merchant's customers list.
The length of one of the provided keys in the map is too short.
The length of one of the provided keys in the map is too long.
The subscription cannot be paused longer than the duration of the current phase.
The payment was declined by the card issuer during an Apple Tap to Pay (TTP) transaction with a request for the card's PIN. This code will be returned alongside CARD_DECLINED_VERIFICATION_REQUIRED as a supplemental error, and will include an issuer-provided token in the details field that is needed to initiate the PIN collection flow on the iOS device.
The expiration date for the payment card is invalid. For example, it indicates a date in the past.
The expiration year for the payment card is invalid. For example, it indicates a year in the past or contains invalid characters.
The expiration date for the payment card is invalid. For example, it contains invalid characters.
The entry method for the credit card (swipe, dip, tap) is not supported.
The payment was declined because there was a payment amount mismatch. The money amount Square was expecting does not match the amount provided.
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.
The card issuer declined the request because the postal code is invalid.
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.
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.
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.
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.
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).
The card issuer declined the request because the issuer requires voice authorization from the cardholder. The seller should ask the customer to contact the card issuing bank to authorize the payment.
The specified card number is invalid. For example, it is of incorrect length or is incorrectly formatted.
The card expiration date is either invalid or indicates that the card is expired.
The card is not supported either in the geographic region or by the merchant category code (MCC).
The card must be swiped, tapped, or dipped. Payments attempted by manually entering the card number are declined.
Square declined the request because the payment amount exceeded the processing limit for this merchant.
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).
The application tried to update a delayed-capture payment that has expired.
The application tried to cancel a delayed-capture payment that was already cancelled.
The application tried to capture a delayed-capture payment that was already captured.
The application tried to update a delayed-capture payment that failed.
The provided card token (nonce) was already used to process the payment or refund.
The requested payment amount is too high for the provided payment source.
The API request references an unsupported instrument type.
The requested refund amount exceeds the amount available to refund.
The payment is not refundable. For example, the payment has been disputed and is no longer eligible for refunds.
The Square account does not have the permissions to process this refund.
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.
Generic error - the given location does not matching what is expected.
The provided Square-Version is incompatible with the requested action.
The payment card was declined with a request for the card holder to call the issuer.
The payment card was declined with a request for additional verification.
The card issuer requires that the card be read using a chip reader.
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.
The body parameter is not recognized by the requested endpoint.
Square could not find the associated Apple Pay certificate.
The target resource is no longer available and this condition is likely to be permanent.
A temporary internal error occurred. You can safely retry your call using the same idempotency key.