Cancel scheduled checkout

Overview

The Checkout Payment Delete API allows clients to request the cancellation of a scheduled checkout payment. The deletion process may require user consent. The API provides information on whether user consent is needed, whether the operation succeeded, or if the client should retry.

Endpoint

DELETE /api/v1/ext/checkout-requests/{id}

Description

The request requires a redirect URL where the user would be redirected after the consent is provided. In case user consent is required to complete the process.

Request Header

api-key : your-api-key

Request Body (JSON)

🚧
Please note some HTTP clients libraries drop the body while peforming DELETE requests, please make sure you are sending the body.

{
  "redirectUrl": "https://example.com/redirect-post-sca"
}

Request Fields Reference

Name	In	Type	Required	Description
id	path	string	true	ID to uniquely identify the checkout request payment.
api-key	header	string	true	Key to uniquely identify the client.
redirectUrl	body	string	true	Where the user would be redirected after the consent is provided. (in case of user consent)

The payment is now cancelled 🛹