Cancel Checkout
POST
https://api.apicenter.itsandbox.site/api/v1/payments/checkouts/{checkoutId}/cancelPerform Cancel Checkout operation on APICenter platform.
// Replace the path placeholders with your resource identifiers.
const paymentApiKey = process.env.APICENTER_PAYMENT_API_KEY;
if (!paymentApiKey) throw new Error("APICENTER_PAYMENT_API_KEY is required");
const response = await fetch("https://api.apicenter.itsandbox.site/api/v1/payments/checkouts/{checkoutId}/cancel", {
method: "POST",
headers: {
Authorization: "Bearer " + paymentApiKey,
"Idempotency-Key": "unique-key-cancelCheckout"
}
});
if (!response.ok) throw new Error("APICenter request failed: " + response.status);
const data = await response.json();
console.log(data);Response
No response example is supplied by this contract. See the documented response schema.Authentication
AuthorizationAPICenterApiKey
Authorization: Bearer <PAYMENT_API_KEY>. Use the consumer's payment API key. or Registered APICenter service JWT with gateway-enforced scopes.
Path parameters
The unique checkoutId identifier.
Headers
Unique key for safely retrying this payment mutation. Reuse the same key and request body after uncertain outcomes. A key used with a different request, an in-progress request, or an unresolved provider outcome returns HTTP 409.
Response
200Checkout cancelled
Errors
409The key was used with a different request, is already processing, or the provider outcome remains unresolved. Inspect `error.code`; in particular, `PAYMENT_OUTCOME_UNKNOWN` requires reconciliation before using a new key.