Cancel a checkout.

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://developer.pace.cloud/doc/cart/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "Cart MCP server": {
    "url": "https://developer.pace.cloud/doc/cart/mcp"
  }
}

Close
POST /2026-3/checkouts/{checkoutId}/cancel

Cancels a checkout that is awaiting actions, abandoning the attempt. The payment authorization is released in the background, and the cart becomes editable again so a further checkout can be created.

Path parameters

  • checkoutId string(uuid) Required

    The unique identifier of the checkout to cancel.

Responses

  • 200 application/json

    The checkout has been successfully cancelled.

    Hide response attribute Show response attribute object
    • data object Required

      The cancelled checkout.

      Hide data attributes Show data attributes object
      • actions object Required

        The actions that are required to complete the checkout process.

        One of:
      • actionsUrl string(uri) | null Required

        The URL which the client may follow to complete the checkout process.

      • cancelledAt string(date-time) | null Required

        The timestamp when the checkout was cancelled.

      • cartId string(uuid) Required

        The unique identifier of the cart this checkout pays for.

      • completedAt string(date-time) | null Required

        The timestamp when the checkout was completed.

      • failedAt string(date-time) | null Required

        The timestamp when the checkout failed.

      • failureCode string | null Required

        The failure code of the checkout, if any. Free-form: new codes are introduced without a version change, so treat an unrecognized value as an unspecified failure.

      • id string(uuid) Required

        The unique identifier of the checkout.

      • items array[object] Required

        The checkouts of the individual cart items within this checkout attempt, in a stable order. An item checkout is still in flight unless its status is COMPLETED, FAILED or CANCELLED.

        Hide items attributes Show items attributes object
        • cancelledAt string(date-time) | null Required

          The timestamp when the item checkout was cancelled.

        • cartItemId string(uuid) Required

          The unique identifier of the cart item this item checkout belongs to.

        • completedAt string(date-time) | null Required

          The timestamp when the item checkout completed.

        • failedAt string(date-time) | null Required

          The timestamp when the item checkout failed.

        • failureCode string | null Required

          The failure code of the item checkout, if any. Free-form: new codes are introduced without a version change, so treat an unrecognized value as an unspecified failure.

        • id string(uuid) Required

          The unique identifier of the item checkout.

        • startedAt string(date-time) | null Required

          The timestamp when the item checkout started.

        • status string Required

          The status of the item checkout. It stays PROCESSING until the product integration reports the item as finished, which may happen after the checkout itself has completed.

          Values are PENDING, PROCESSING, COMPLETED, FAILED, or CANCELLED.

      • payment object Required

        The payment transaction for this checkout attempt.

        Hide payment attributes Show payment attributes object
        • authorizedAmount string(decimal) | null Required

          The authorized amount of the payment transaction, or null if not yet authorized.

          Minimum value is 0.

        • authorizedAt string(date-time) | null Required

          The timestamp when the payment was authorized.

        • cancelledAt string(date-time) | null Required

          The timestamp when the payment was cancelled.

        • capturedAmount string(decimal) | null Required

          The captured amount of the payment transaction, or null if not yet captured.

          Minimum value is 0.

        • capturedAt string(date-time) | null Required

          The timestamp when the payment was captured.

        • currency string Required

          The currency of the payment transaction.

        • failedAt string(date-time) | null Required

          The timestamp when the payment failed.

        • failureCode string | null Required

          The failure code of the payment transaction, if any. Free-form: new codes are introduced without a version change, so treat an unrecognized value as an unspecified failure.

        • status string Required

          The status of the payment transaction.

          Any of:

          Values are AUTHORIZING, AUTHORIZING_ACTIONS_REQUIRED, AUTHORIZED, CAPTURED, CANCELLED, or FAILED.

        • transactionId string(uuid) Required

          The public identifier of the payment transaction, which can be used to fetch payment detail directly from the payment service.

      • paymentMethodId string(uuid) Required

        The unique identifier of the payment method used for this checkout.

      • retryable boolean Required

        Whether a new checkout can be started for the cart after this attempt: true when it was cancelled, awaits actions, or failed for a transient reason (e.g. a provider error), and it is not the cart's last permitted attempt.

      • settlement object Required

        The background settlement of this checkout attempt, which captures or releases the authorized payment.

        Hide settlement attributes Show settlement attributes object
        • completedAt string(date-time) | null Required

          The timestamp when the settlement completed.

        • failedAt string(date-time) | null Required

          The timestamp of the most recent failed settlement run. A run that failed while retries remain is retried in the background, so this may be set while the status is still PROCESSING.

        • startedAt string(date-time) | null Required

          The timestamp when the settlement started.

        • status string Required

          The status of the background settlement.

          Values are PENDING, PROCESSING, COMPLETED, FAILED, or CANCELLED.

      • startedAt string(date-time) Required

        The timestamp when the checkout was started.

      • status string Required

        The current status of the checkout.

        Values are PROCESSING, ACTIONS_REQUIRED, COMPLETED, CANCELLED, or FAILED.

  • 400

    The request parameters are missing or invalid.

  • 401

    Client authentication failed.

  • 403

    Missing one or more required scopes.

  • 404

    The specified checkout was not found.

  • 409

    The checkout is not awaiting actions, or its cart is being modified concurrently.

  • 500

    An unexpected error occurred.

POST /2026-3/checkouts/{checkoutId}/cancel
curl \
 --request POST 'https://api.pace.cloud/cart/2026-3/checkouts/f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d/cancel' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": {
    "actions": {
      "cartItemId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "default": "7495345",
      "description": "The car mileage is required to complete the cart checkout.",
      "format": "TEXT",
      "label": "Car Mileage",
      "maximum": "100.00",
      "minimum": "10.00",
      "name": "CAR_MILEAGE",
      "optional": false,
      "pattern": "^[0-9]+$",
      "type": "INPUT"
    },
    "actionsUrl": "https://example.com/checkout/actions",
    "cancelledAt": "2023-05-15T14:30:00.000Z",
    "cartId": "ae1b58ef-ba5c-4240-b130-51fcf067d40d",
    "completedAt": "2023-05-15T14:05:00.000Z",
    "failedAt": "2023-05-15T14:00:05.000Z",
    "failureCode": "INSUFFICIENT_FUNDS",
    "id": "f1e2d3c4-b5a6-4789-9c0d-1e2f3a4b5c6d",
    "items": [
      {
        "cancelledAt": "2023-05-15T14:03:00.000Z",
        "cartItemId": "9b21c7e4-5d3a-4f8b-a1c6-7e2d9f4b0a53",
        "completedAt": "2023-05-15T14:05:00.000Z",
        "failedAt": "2023-05-15T14:04:00.000Z",
        "failureCode": "UNKNOWN",
        "id": "3f8a1c2d-4e5b-4a6c-8d7e-9f0a1b2c3d4e",
        "startedAt": "2023-05-15T14:00:02.000Z",
        "status": "COMPLETED"
      }
    ],
    "payment": {
      "authorizedAmount": "45.00",
      "authorizedAt": "2023-05-15T14:00:05.000Z",
      "cancelledAt": "2023-05-15T14:30:00.000Z",
      "capturedAmount": "45.00",
      "capturedAt": "2023-05-15T14:05:00.000Z",
      "currency": "EUR",
      "failedAt": "2023-05-15T14:00:05.000Z",
      "failureCode": "INSUFFICIENT_FUNDS",
      "status": "AUTHORIZED",
      "transactionId": "9c2f1e7a-3b4d-4f8a-9c1e-2d6b8a0f5e3c"
    },
    "paymentMethodId": "ecbec75f-7ca4-4017-a485-6a4836de5d25",
    "retryable": false,
    "settlement": {
      "completedAt": "2023-05-15T14:10:00.000Z",
      "failedAt": "2023-05-15T14:09:30.000Z",
      "startedAt": "2023-05-15T14:09:00.000Z",
      "status": "PENDING"
    },
    "startedAt": "2023-05-15T14:00:00.000Z",
    "status": "PROCESSING"
  }
}