cartPaymentRemove

Mutationin Cart

Remove a payment that has only reserved money from the cart, such as a gift card, and give the reservation back. A payment whose money has been taken, or that is still being decided by its provider, cannot be removed.

Arguments

Argument	Type	Description
`id`	`ID!`
`version`	`String`
`paymentId`	`ID!`

Returns

CartPaymentRemoveResponse!

Field	Type	Description
`cart`	`Cart`	Cart information after the payment is removed
`cartErrors`	`[CartPaymentRemoveError!]`	Error details if the payment could not be removed

Example

mutation CartPaymentRemove($id: ID!, $version: String, $paymentId: ID!) {
  cartPaymentRemove(id: $id, version: $version, paymentId: $paymentId) {
    cart {
      id
      version
      createdAt
      lastModifiedAt
      currency
      customerEmail
      isGuest
      totalQuantity
      deliveryRemarks
      vatNumber
      purchaseOrderNumber
      deliverySplit
      requestedDeliveryDate
      earliestCompleteDeliveryDate
      name
      defaultName
      status
    }
    cartErrors {
      __typename
      ... on ValidationError {
        message
      }
      ... on CartError {
        message
        code
      }
    }
  }
}

{
  "id": "id-1",
  "version": "Example",
  "paymentId": "id-1"
}

{
  "data": {
    "cartPaymentRemove": {
      "cart": {
        "id": "id-1",
        "version": "Example",
        "createdAt": "2026-10-01T09:30:00Z",
        "lastModifiedAt": "2026-10-01T09:30:00Z",
        "currency": "EUR",
        "customerEmail": "jane@example.com",
        "isGuest": true,
        "totalQuantity": 1,
        "deliveryRemarks": "Example",
        "vatNumber": "Example",
        "purchaseOrderNumber": "Example",
        "deliverySplit": "COMPLETE",
        "requestedDeliveryDate": "2026-10-01",
        "earliestCompleteDeliveryDate": "2026-10-01",
        "name": "Example",
        "defaultName": "Example",
        "status": "ACTIVE"
      },
      "cartErrors": [
        {
          "__typename": "ValidationError",
          "message": "Example"
        }
      ]
    }
  }
}

The query selects the return type's fields two levels deep; pick the ones you need. The response shows its shape with placeholder values.

Served by

@evolve-framework/commercetools	Resolved
@evolve-framework/medusa	Resolved
@evolve-framework/sfcc	Not resolved

Used by

The storefront packages that send it, in these GraphQL documents:

@evolve-storefront/feature-cart: CartPaymentRemove