setPaymentMethodOnCart mutation

The setPaymentMethodOnCart mutation defines which payment method to apply to the cart. Magento GraphQL supports the following offline payment methods:

Supported online payment methods include:

• Braintree
• Braintree Vault
• PayPal Express Checkout
• PayPal Payflow Link
• PayPal Payflow Pro
• PayPal Payments Advanced
• PayPal Website Payments Pro Hosted Solution
• Express Checkout for other PayPal solutions

Syntax

mutation: {setPaymentMethodOnCart(input: SetPaymentMethodOnCartInput): SetPaymentMethodOnCartOutput}}

Example usage

Offline payment method

The following example assigns the banktransfer payment method to the specified cart.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
mutation {
  setPaymentMethodOnCart(input: {
      cart_id: "rMQdWEecBZr4SVWZwj2AF6y0dNCKQ8uH"
      payment_method: {
          code: "banktransfer"
      }
  }) {
    cart {
      selected_payment_method {
        code
        title
      }
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
{
  "data": {
    "setPaymentMethodOnCart": {
      "cart": {
        "selected_payment_method": {
          "code": "banktransfer",
          "title": "Bank Transfer Payment"
        }
      }
    }
  }
}

Input attributes

The top-level SetPaymentMethodOnCartInput object is listed first. All child objects are listed in alphabetical order.

SetPaymentMethodOnCartInput attributes

The SetPaymentMethodOnCartInput object must contain the following attributes:

PaymentMethodInput attributes

The PaymentMethodInput object can contain the following attributes:

For all online payment methods, the payload must include an object that defines additional information specific to that payment method.

Output attributes

The SetPaymentMethodOnCartOutput object contains the Cart object.

Cart object

Cart query output provides more information about the Cart object.

Errors