Skip to main content

Documentation

Cancel

Send a request to cancel a sale that is being displayed on a PAX POS device

Parameters
Request Header Parameters
Request Body Parameters

    • deviceToken

    • The token of a PAX POS device.

    • correlationId

    • An ID provided by the caller. Returned in the callback for message matching. In a cancel request, use the value from the sale/refund that is being canceled.

202 Accepted Response
400 Error Response

    • type

    • Example: https://tools.ietf.org/html/rfc7231#section-6.5.1

    • title

    • Bad Request

    • status

    • 400

    • detail

    • DeviceId not registered.

401 Error Response

    • message

    • Unauthorized

500 Error Response

    • message

    • Server Error

  • /cancel

  • 202 Cancel Accepted

  • curl -X
post https://CloudLinkApi/cancel
-H 'X-API-KEY: your-access-key-here'
-d '{
     "deviceToken": "b16526c3447ba6cea4818d",
     "correlationId": "011182D3-A941-4207-9905-D7770347D492"
}
'  
  • {
  "message": "Accepted"	
}

  • 400 Bad Request

  • curl -X
post https://CloudLinkApi/cancel
-H 'X-API-KEY: your-access-key-here'
-d '{
     "deviceToken": "b16526c3447ba6cea4818d",
     "correlationId": "011182D3-A941-4207-9905-D7770347D492"
}
' 
  • {
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "Bad Request",
  "status": 400,
  "detail": "DeviceId not registered"
}

  • 401 Unauthorized

  • curl -X
post https://CloudLinkApi/cancel
-H 'X-API-KEY: your-access-key-here'
-d '{
     "deviceToken": "b16526c3447ba6cea4818d",
     "correlationId": "011182D3-A941-4207-9905-D7770347D492"
}
' 
  • {
  "message": "Unauthorized"
}

  • 500 Server Error

  • curl -X
post https://CloudLinkApi/cancel
-H 'X-API-KEY: your-access-key-here'
-d '{
     "deviceToken": "b16526c3447ba6cea4818d",
     "correlationId": "011182D3-A941-4207-9905-D7770347D492"
}
' 
  • {
  "message": "Server Error"
}
In this section: