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}

Request

Description

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

Request Header

x-api-key : your-api-key

Request (JSON)

{
  "redirectUrl": "https://example.com/consent-return"
}

Response

Description

The response contains the status of the deletion request. The system may require user consent, may succeed immediately, or may suggest retrying because of an internal bank error.

Success (200 OK)

{
  "consentRequired": false,
  "consentUrl": null,
  "success": true,
  "retryable": false
}

Consent Required (200 OK)

{
  "consentRequired": true,
  "consentUrl": "https://consent-url",
  "success": false,
  "retryable": false
}

Retry Suggested (200 OK)

{
  "consentRequired": false,
  "consentUrl": null,
  "success": false,
  "retryable": true
}

Request Fields

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

Response Fields

Name	In	Type	Description
consentRequired	body	boolean	Indicates whether additional user consent is required to process the deletion.
consentUrl	body	string	If consent is required, the URL where the user should provide consent.
success	body	boolean	Indicates whether the operation succeeded.
retryable	body	boolean	Indicates if the operation failed but may succeed if retried.

🛹 The payment is now cancelled.