Cancel session

BETA

Cancel a terminal session.

It might be necessary to cancel a terminal session without payment.

Path

When you need to cancel a terminal session, you can use the endpoint:

PUT /terminal-sessions/{terminalSessionId}/cancel

Note that the API method for cancelling a terminal session is PUT rather than DELETE. The session itself is not deleted, and it can be called up using the get terminal operation for reference.

note

If payment has been attempted or completed on a terminal session, it will no longer be possible to cancel it. This includes failed payment attempts.

In the successful cancel session response, the status of the session will change to CancelRequested. The status will first move to CancelRequested. Finally, status of the session will change to Canceled.

Sample requests

cURL

omni-payments/terminals/curl/request-cancel.sh

loading...

View full example on GitHub

Python

omni-payments/terminals/python/request-cancel.py

loading...

View full example on GitHub

PowerShell

omni-payments/terminals/powershell/request-cancel.ps1

loading...

View full example on GitHub

API reference Learn about the API and integrate with API endpoints.

Introduction Return to the introduction page.

Step-by-step guide See the new terminals endpoints in practice.

Support Our support team is always happy to help with any questions you have.