Represents an error encountered during a request to the Connect API.
See Handling errors for more information.
Error
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() |
{
"category": "API_ERROR",
"code": "INVALID_PAUSE_LENGTH",
"detail": "detail0",
"field": "field8"
}