Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.09 KB

error.md

File metadata and controls

31 lines (21 loc) · 1.09 KB

Error

Represents an error encountered during a request to the Connect API.

See Handling errors for more information.

Structure

Error

Fields

Name Type Tags Description Getter
Category String Required Indicates which high-level category of error has occurred during a
request to the Connect API.
String getCategory()
Code String Required Indicates the specific error that occurred during a request to a
Square API.
String getCode()
Detail String Optional A human-readable description of the error for debugging purposes. String getDetail()
Field String Optional The name of the field provided in the original request (if any) that
the error pertains to.
String getField()

Example (as JSON)

{
  "category": "API_ERROR",
  "code": "CARD_NOT_SUPPORTED",
  "detail": "detail0",
  "field": "field8"
}