Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1015 Bytes

error.md

File metadata and controls

31 lines (21 loc) · 1015 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 | undefined Optional A human-readable description of the error for debugging purposes.
field string | undefined Optional The name of the field provided in the original request (if any) that
the error pertains to.

Example (as JSON)

{
  "category": "RATE_LIMIT_ERROR",
  "code": "ACCESS_TOKEN_EXPIRED",
  "detail": null,
  "field": null
}