Error

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

See Handling errors for more information.

Structure

Error

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.

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