paymentExpressCheckoutUpdate

Mutationin Payment

Bring a wallet payment in progress up to date with the cart, for a wallet whose own sheet changes the shipping address or method, such as PayPal Express. Set the new address or method on the cart first; this then sends the provider the cart's amount to pay and its shipping options. Pass the paymentData the wallet holds, and hand the wallet the one returned.

Arguments

Argument	Type	Description
paymentId	ID!
paymentData	String!

Returns

PaymentExpressCheckoutUpdateResponse!

Field	Type	Description
paymentData	String	The data the wallet continues with, which replaces what it had. Null when the update failed.
paymentErrors	[PaymentExpressCheckoutUpdateError!]	Error details if the payment could not be updated

Example

Query

mutation PaymentExpressCheckoutUpdate($paymentId: ID!, $paymentData: String!) {
  paymentExpressCheckoutUpdate(paymentId: $paymentId, paymentData: $paymentData) {
    paymentData
    paymentErrors {
      __typename
      ... on PaymentError {
        code
        message
      }
      ... on ValidationError {
        message
      }
    }
  }
}

Variables

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

Response

{
  "data": {
    "paymentExpressCheckoutUpdate": {
      "paymentData": "Example",
      "paymentErrors": [
        {
          "__typename": "PaymentError",
          "code": "TARGET_NOT_FOUND",
          "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	Stub: answers Not implemented
@evolve-framework/sfcc	Resolved