Delete a check
/api/v1/checks/{checkRef}
{basePath}/checks/929aacee2c6d42c78ae877e824c28eed00000431
API cancels the requested check from the specified revenue center if present and in a state where cancelation is allowed.
Request uses the checkRef that can be found in the check header once a check has been created at the POS.
Request
- application/json
-
checkRef(required): string
Check identifier
-
Simphony-LocRef(required): string
The location identifier.
-
Simphony-OrgShortName(required): string
The organization identifier.
-
Simphony-RvcRef(required): integer
The revenue center identifier.
Response
- application/json
204 Response
400 Response
object-
detail:
string
A human-readable explanation specific to this occurrence of the problem.Example:
The POS system is unable to process the request. -
instance:
string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.Example:
error:pos-error -
posDetails:
array posDetails
(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.
-
status:
integer
A HTTP response status code.Example:
400 -
title:
string
A short, human-readable summary of the problem type.Example:
POS Error
{
"title":"POS Error",
"status":400,
"detail":"The POS system is unable to process the request.",
"instance":"error:pos-error",
"posDetails":[
{
"code":"general_pos_error",
"message":"Check opened on system"
}
]
}arrayobject-
code:
string
Short, unique identifier for the type of errorExample:
general_pos_error -
message:
string
A human-readable explanation specific to this occurrence of the problem.Example:
Check opened on system
401 Response
-
WWW-Authenticate: string
Bearer authentication challenge. When token validation fails, the header may include error and error_description parameters.
The following conditions and HTTP response examples are illustrative and not exhaustive. Error descriptions may vary.
No token provided: No access token is provided, or the Authorization request header is missing. The response header is WWW-Authenticate: Bearer, without error or error_description parameters.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: BearerExpired token: The access token has expired. The timestamp in this example is illustrative.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The token expired at '05/19/2026 17:16:29'"Signing key not found: The token cannot be validated because its signing key was not found. For example, the token's key ID (kid) does not match a key in the JSON Web Key Set (JWKS) used for validation.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature key was not found"Invalid signature: The token signature is invalid. For example, the token may have been modified.
Example:
HTTP/1.1 401 Unauthorized WWW-Authenticate: Bearer error="invalid_token", error_description="The signature is invalid"For the missing-token, signing-key-not-found, and invalid-signature examples above, the response body is empty. The authentication error details are provided in the WWW-Authenticate response header.
The response may include an additional WWW-Authenticate header containing a bare Bearer challenge alongside the challenge shown in these examples.