Simphony Transaction Services Gen2 API Guide

Delete a check

delete

{basePath}/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

Supported Media Types

application/json

Path Parameters

checkRef(required): string

Check identifier

Header Parameters

Simphony-LocRef(required): string

The location identifier. Will be forced to lower-case.
Simphony-OrgShortName(required): string

The organization identifier. Will be forced to lower-case.
Simphony-RvcRef(required): integer

The revenue center identifier.

Response

Supported Media Types

application/json

204 Response

The check has been successfully voided.

400 Response

400 Bad Request

Root Schema : ChecksApiProblemDetailsDeleteChecks

Type: object

Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). **Extensions** * posDetails

Show Source

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: string

A HTTP response status code.

Example: 400
title: string

A short, human-readable summary of the problem type.

Example: POS Error

{
    "description":"Problem details is used as standard model for reporting details when HTTP error status code is returned. This definition is defined by [RFC7807](https://tools.ietf.org/html/rfc7807). \n\n  **Extensions**\n  * posDetails\n",
    "type":"object",
    "example":{
        "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"
            }
        ]
    },
    "properties":{
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"POS Error"
        },
        "status":{
            "description":"A HTTP response status code.",
            "type":"string",
            "example":400
        },
        "detail":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"The POS system is unable to process the request."
        },
        "instance":{
            "description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "type":"string",
            "example":"error:pos-error"
        },
        "posDetails":{
            "description":"(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "code":{
                        "description":"Short, unique identifier for the type of error",
                        "type":"string",
                        "example":"general_pos_error"
                    },
                    "message":{
                        "description":"A human-readable explanation specific to this occurrence of the problem.",
                        "type":"string",
                        "example":"Check opened on system"
                    }
                }
            }
        }
    }
}

Example:

{
    "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"
        }
    ]
}

Nested Schema : posDetails

Type: array

(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.

Show Source

Array of: object items

{
    "description":"(Problem Details Extension) Contains a list of the problem details from the POS System processing the request.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "code":{
                "description":"Short, unique identifier for the type of error",
                "type":"string",
                "example":"general_pos_error"
            },
            "message":{
                "description":"A human-readable explanation specific to this occurrence of the problem.",
                "type":"string",
                "example":"Check opened on system"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

code: string

Short, unique identifier for the type of error

Example: general_pos_error
message: string

A human-readable explanation specific to this occurrence of the problem.

Example: Check opened on system

{
    "type":"object",
    "properties":{
        "code":{
            "description":"Short, unique identifier for the type of error",
            "type":"string",
            "example":"general_pos_error"
        },
        "message":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Check opened on system"
        }
    }
}

401 Response

401 Unauthorized

403 Response

403 Forbidden

404 Response

404 Requested resource not found

521 Response

521 Service Timeout