triPOS REST API

<back to all web services

CancelSaleRequest

The following routes are available for this service:
DELETE/api/v1/sale/{laneId}Cancels an in-progress sale transactionA DELETE request sent to the sale endpoint cancels an in-progress sale transaction on the specified lane. Currently, this is only valid for Mobile devices.
CancelSaleRequest Parameters:
NameParameterData TypeRequiredDescription
LaneIdpathintYesSpecifies which lane to use.

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /json/reply/CancelSaleRequest HTTP/1.1 
Host: triposqa.vantiv.com 
Content-Type: application/json
Content-Length: length

{"laneId":0}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"saleCancelled":false,"_errors":[{"userMessage":"String","developerMessage":"String","errorType":"String","exceptionMessage":"String","exceptionTypeFullName":"String","exceptionTypeShortName":"String"}],"_hasErrors":true,"_links":[],"_logs":["String"],"_type":"String","_warnings":[{"developerMessage":"String","userMessage":"String"}]}