What arguments does setPaymentMethodOnCart accept?

The setPaymentMethodOnCart mutation accepts 1 argument: input (SetPaymentMethodOnCartInput).

What does setPaymentMethodOnCart return?

setPaymentMethodOnCart returns SetPaymentMethodOnCartOutput.

Does setPaymentMethodOnCart require authentication?

setPaymentMethodOnCart requires an Authorization header with a Bearer customer token. Obtain the token by calling the generateCustomerToken mutation with the customer's email and password.

MageSmith

MutationQuote · Magento 2.4.9

setPaymentMethodOnCart

Q: What does the setPaymentMethodOnCart mutation do in Magento 2 GraphQL?

setPaymentMethodOnCart is a Magento 2 GraphQL mutation in the Quote module. Apply a payment method to the cart. It returns SetPaymentMethodOnCartOutput and requires an Authorization header (Bearer customer token).

setPaymentMethodOnCart is a Magento 2 GraphQL mutation in the Quote module. Apply a payment method to the cart. It returns SetPaymentMethodOnCartOutput and requires an Authorization header (Bearer customer token).

Last verified: 2026-05-23 against Magento 2.4.9.

Returns

SetPaymentMethodOnCartOutput

Resolver class

Magento\QuoteGraphQl\Model\Resolver\SetPaymentMethodOnCart

Arguments

input SetPaymentMethodOnCartInput

An input object that defines which payment method to apply to the cart.

Example request

Auto-generated from the SDL — paste-ready against your store's /graphql endpoint. Replace the host, store code, and any required values before running.

Headers

Content-Type

application/json

Store

default store view code; use 'default' for the single-store baseline

Authorization

Bearer <CUSTOMER_TOKEN> obtain from generateCustomerToken mutation

Query

mutation {
  setPaymentMethodOnCart {
    cart {
      gift_message {
        to
        from
        message
      }
      id
      items {
        not_available_message
        id
        uid
        quantity
        is_available
        prices { ... }
        product { ... }
        errors { ... }
      }
      itemsV2 {
        items { ... }
        page_info { ... }
        total_count
      }
      applied_coupon {
        code
      }
      applied_coupons {
        code
      }
      email
      shipping_addresses {
        available_shipping_methods { ... }
        selected_shipping_method { ... }
        customer_notes
        items_weight
        cart_items { ... }
        cart_items_v2 { ... }
        same_as_billing
        pickup_location_code
      }
      billing_address {
        customer_notes
      }
      available_payment_methods {
        is_deferred
        code
        title
      }
      selected_payment_method {
        code
        title
        purchase_order_number
      }
      prices {
        grand_total { ... }
        grand_total_excluding_tax { ... }
        subtotal_including_tax { ... }
        subtotal_excluding_tax { ... }
        discount { ... }
        subtotal_with_discount_excluding_tax { ... }
        applied_taxes { ... }
        discounts { ... }
      }
      total_quantity
      is_virtual
      rules {
        uid
      }
    }
  }
}