Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 989 Bytes

error.md

File metadata and controls

31 lines (21 loc) · 989 Bytes

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
Category string Required Indicates which high-level category of error has occurred during a
request to the Connect API.
Code string Required Indicates the specific error that occurred during a request to a
Square API.
Detail string Optional A human-readable description of the error for debugging purposes.
Field string Optional The name of the field provided in the original request (if any) that
the error pertains to.

Example (as JSON)

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