Checkout Cancellation

To prevent potential double charges, a Checkout Cancellation mechanism has been implemented. This feature allows a merchant's integration to explicitly terminate an active checkout session, especially in scenarios where a user closes the payment modal while a payment is pending.

When a cancellation is requested, Checkout stops the workflow, performs necessary compensation logic (like voiding transactions), and updates the session status.

API Endpoint

A new endpoint is available to request the cancellation of an active checkout session:

POST /checkouts/{intentUUID}/cancel

• Purpose: Explicitly terminate an active checkout session.
  • intentUUID (string, required): The unique identifier for the checkout session (intent) you wish to cancel.
• Authentication: This endpoint requires authentication and authorisation
• Request Body: No request body is required.

API Responses

The endpoint will return one of the following API responses:

• 202 Accepted: The cancellation request has been accepted, and the workflow termination has been successfully initiated.
• 400 Failed: The session that is trying to be canceled is not in the ‘active’ or ‘inprogress’ status.
• 404 Not Found: The specified intentUUID does not correspond to an active session.