Choose a version:

shopPayPaymentRequestSessionSubmit

mutation

Submits a Shop Pay payment request session.

Arguments

Anchor to idempotencyKeyidempotencyKey •String! required: The idempotency key is used to guarantee an idempotent result.
Anchor to orderNameorderName •String: The order name to be used for the order created from the payment request.
Anchor to paymentRequestpaymentRequest •ShopPayPaymentRequestInput! required: The final payment request object.
Anchor to tokentoken •String! required: A token representing a payment session request.

Was this section helpful?

Anchor to ShopPayPaymentRequestSessionSubmitPayload returnsShopPayPaymentRequestSessionSubmitPayload returns

Anchor to paymentRequestReceiptpaymentRequestReceipt •ShopPayPaymentRequestReceipt: The checkout on which the payment was applied.
Anchor to userErrorsuserErrors •[UserErrorsShopPayPaymentRequestSessionUserErrors!]! non-null: Error codes for failed Shop Pay payment request session mutations.

Was this section helpful?

Mutation Reference

mutation shopPayPaymentRequestSessionSubmit($idempotencyKey: String!, $orderName: String, $paymentRequest: ShopPayPaymentRequestInput!, $token: String!) {

shopPayPaymentRequestSessionSubmit(idempotencyKey: $idempotencyKey, orderName: $orderName, paymentRequest: $paymentRequest, token: $token) {

paymentRequestReceipt {

# ShopPayPaymentRequestReceipt fields

}

userErrors {

field

message

}

Input

{

"idempotencyKey": "<your-idempotencyKey>",

"orderName": "<your-orderName>",

"paymentRequest": {

"deliveryMethods": [

{

"amount": "",

"code": "<your-code>",

"deliveryExpectationLabel": "<your-deliveryExpectationLabel>",

"detail": "<your-detail>",

"label": "<your-label>",

"maxDeliveryDate": "",

"minDeliveryDate": ""

}

"discountCodes": [

"<your-discountCodes>"

"discounts": [

{

"amount": "",

"label": "<your-label>"

}

"lineItems": [

{

"finalItemPrice": "",

"finalLinePrice": "",

"image": "",

"itemDiscounts": [

"label": "<your-label>",

"lineDiscounts": [

"originalItemPrice": "",

"originalLinePrice": "",

"quantity": 1,

"requiresShipping": true,

"sku": "<your-sku>"

}

"locale": "<your-locale>",

"paymentMethod": "<your-paymentMethod>",

"presentmentCurrency": "",

"selectedDeliveryMethodType": "",

"shippingLines": [

{

"amount": "",

"code": "<your-code>",

"label": "<your-label>"

}

"subtotal": {

"amount": "29.99",

"currencyCode": ""

"total": {

"amount": "29.99",

"currencyCode": ""

"totalShippingPrice": {

"discounts": [

"finalTotal": "",

"originalTotal": ""

"totalTax": {

"amount": "29.99",

"currencyCode": ""

}

"token": "<your-token>"

}

{
  "idempotencyKey": "<your-idempotencyKey>",
  "orderName": "<your-orderName>",
  "paymentRequest": {
    "deliveryMethods": [
      {
        "amount": "",
        "code": "<your-code>",
        "deliveryExpectationLabel": "<your-deliveryExpectationLabel>",
        "detail": "<your-detail>",
        "label": "<your-label>",
        "maxDeliveryDate": "",
        "minDeliveryDate": ""
      }
    ],
    "discountCodes": [
      "<your-discountCodes>"
    ],
    "discounts": [
      {
        "amount": "",
        "label": "<your-label>"
      }
    ],
    "lineItems": [
      {
        "finalItemPrice": "",
        "finalLinePrice": "",
        "image": "",
        "itemDiscounts": [
          ""
        ],
        "label": "<your-label>",
        "lineDiscounts": [
          ""
        ],
        "originalItemPrice": "",
        "originalLinePrice": "",
        "quantity": 1,
        "requiresShipping": true,
        "sku": "<your-sku>"
      }
    ],
    "locale": "<your-locale>",
    "paymentMethod": "<your-paymentMethod>",
    "presentmentCurrency": "",
    "selectedDeliveryMethodType": "",
    "shippingLines": [
      {
        "amount": "",
        "code": "<your-code>",
        "label": "<your-label>"
      }
    ],
    "subtotal": {
      "amount": "29.99",
      "currencyCode": ""
    },
    "total": {
      "amount": "29.99",
      "currencyCode": ""
    },
    "totalShippingPrice": {
      "discounts": [
        ""
      ],
      "finalTotal": "",
      "originalTotal": ""
    },
    "totalTax": {
      "amount": "29.99",
      "currencyCode": ""
    }
  },
  "token": "<your-token>"
}

input ShopPayPaymentRequestInput {
  deliveryMethods: [ShopPayPaymentRequestDeliveryMethodInput!]
  discountCodes: [String!]
  discounts: [ShopPayPaymentRequestDiscountInput!]
  lineItems: [ShopPayPaymentRequestLineItemInput!]
  locale: String!
  paymentMethod: String
  presentmentCurrency: CurrencyCode!
  selectedDeliveryMethodType: ShopPayPaymentRequestDeliveryMethodType
  shippingLines: [ShopPayPaymentRequestShippingLineInput!]
  subtotal: MoneyInput!
  total: MoneyInput!
  totalShippingPrice: ShopPayPaymentRequestTotalShippingPriceInput
  totalTax: MoneyInput
}

input ShopPayPaymentRequestDeliveryMethodInput {
  amount: MoneyInput
  code: String
  deliveryExpectationLabel: String
  detail: String
  label: String
  maxDeliveryDate: ISO8601DateTime
  minDeliveryDate: ISO8601DateTime
}

input ShopPayPaymentRequestDiscountInput {
  amount: MoneyInput
  label: String
}

input ShopPayPaymentRequestLineItemInput {
  finalItemPrice: MoneyInput
  finalLinePrice: MoneyInput
  image: ShopPayPaymentRequestImageInput
  itemDiscounts: [ShopPayPaymentRequestDiscountInput!]
  label: String
  lineDiscounts: [ShopPayPaymentRequestDiscountInput!]
  originalItemPrice: MoneyInput
  originalLinePrice: MoneyInput
  quantity: Int!
  requiresShipping: Boolean
  sku: String
}

input ShopPayPaymentRequestShippingLineInput {
  amount: MoneyInput
  code: String
  label: String
}

input MoneyInput {
  amount: Decimal!
  currencyCode: CurrencyCode!
}

input ShopPayPaymentRequestTotalShippingPriceInput {
  discounts: [ShopPayPaymentRequestDiscountInput!]
  finalTotal: MoneyInput
  originalTotal: MoneyInput
}