setNegotiableQuotePaymentMethod mutation

The setNegotiableQuotePaymentMethod mutation defines which payment method to apply to the cart. The negotiable quote must be in the UPDATED state to successfully apply the payment method.

Supported online payment methods include:

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

The following offline payment methods are also supported:

This mutation requires a valid customer authentication token.

Syntax

Copy
{
    setNegotiableQuotePaymentMethod(
        input: SetNegotiableQuotePaymentMethodInput!
    ): SetNegotiableQuotePaymentMethodOutput
}
Copied to your clipboard
{
    setNegotiableQuotePaymentMethod(
        input: SetNegotiableQuotePaymentMethodInput!
    ): SetNegotiableQuotePaymentMethodOutput
}

Reference

The setNegotiableQuotePaymentMethod reference provides detailed information about the types and fields defined in this mutation.

Example usage

The following example sets the payment method .

Request:

Copy
mutation {
  setNegotiableQuotePaymentMethod(
    input: {
      quote_uid: "xCA4wSZEHsb5QbFiKfoq5k1Dk8vIPBgb"
      payment_method: { code: "checkmo" }
    }
  ) {
    quote {
      uid
      name
      status
      available_payment_methods {
        code
        title
      }
      selected_payment_method {
        code
        title
        purchase_order_number
      }
      items {
        product {
          sku
          name
        }
      }
    }
  }
}
Copied to your clipboard
mutation {
  setNegotiableQuotePaymentMethod(
    input: {
      quote_uid: "xCA4wSZEHsb5QbFiKfoq5k1Dk8vIPBgb"
      payment_method: { code: "checkmo" }
    }
  ) {
    quote {
      uid
      name
      status
      available_payment_methods {
        code
        title
      }
      selected_payment_method {
        code
        title
        purchase_order_number
      }
      items {
        product {
          sku
          name
        }
      }
    }
  }
}

Response:

Copy
{
  "data": {
    "setNegotiableQuotePaymentMethod": {
      "quote": {
        "uid": "xCA4wSZEHsb5QbFiKfoq5k1Dk8vIPBgb",
        "name": "April 22 request",
        "status": "UPDATED",
        "available_payment_methods": [
          {
            "code": "checkmo",
            "title": "Check / Money order"
          }
        ],
        "selected_payment_method": {
          "code": "checkmo",
          "title": "Check / Money order",
          "purchase_order_number": null
        }
      }
    }
  }
}
Copied to your clipboard
{
  "data": {
    "setNegotiableQuotePaymentMethod": {
      "quote": {
        "uid": "xCA4wSZEHsb5QbFiKfoq5k1Dk8vIPBgb",
        "name": "April 22 request",
        "status": "UPDATED",
        "available_payment_methods": [
          {
            "code": "checkmo",
            "title": "Check / Money order"
          }
        ],
        "selected_payment_method": {
          "code": "checkmo",
          "title": "Check / Money order",
          "purchase_order_number": null
        }
      }
    }
  }
}

Last updated 11/7/2023

Was this helpful?

Yes

No