Choose a version:

Anchor to shopPayPaymentRequestSessionSubmit

shopPayPaymentRequestSessionSubmit

mutation

Finalizes a Shop Pay payment request session. Call this mutation after creating a session with shopPayPaymentRequestSessionCreate.

The idempotencyKey argument ensures the payment transaction occurs only once, preventing duplicate charges. On success, returns a ShopPayPaymentRequestReceipt with the processing status and a receipt token.

For a complete integration guide including the JavaScript SDK setup and checkout flow, refer to the Shop Component API documentation. For implementation steps, see the development journey guide. For common error scenarios, see the troubleshooting guide.

Anchor to Arguments

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?

Examples

shopPayPaymentRequestSessionSubmit reference

Mutation Reference

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

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

paymentRequestReceipt {

# ShopPayPaymentRequestReceipt fields

}

userErrors {

field

message

}

Input

{

"token": "<your-token>",

"paymentRequest": {

"discountCodes": [

"<your-discountCodes>"

"lineItems": [

{

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

"quantity": 1,

"sku": "<your-sku>",

"requiresShipping": true,

"image": {},

"originalLinePrice": {},

"finalLinePrice": {},

"lineDiscounts": [

{}

"originalItemPrice": {},

"finalItemPrice": {},

"itemDiscounts": [

{}

]

}

"shippingLines": [

{

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

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

"amount": {}

}

"total": {

"amount": "29.99",

"currencyCode": "USD"

"subtotal": {

"amount": "29.99",

"currencyCode": "USD"

"discounts": [

{

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

"amount": {}

}

"totalShippingPrice": {

"discounts": [

{}

"originalTotal": {},

"finalTotal": {}

"totalTax": {

"amount": "29.99",

"currencyCode": "USD"

"deliveryMethods": [

{

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

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

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

"amount": {},

"minDeliveryDate": "",

"maxDeliveryDate": "",

"deliveryExpectationLabel": "<your-deliveryExpectationLabel>"

}

"selectedDeliveryMethodType": "SHIPPING",

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

"presentmentCurrency": "USD",

"paymentMethod": "<your-paymentMethod>"

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

"orderName": "<your-orderName>"

}

Variables

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

Schema

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

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

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

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

input ShopPayPaymentRequestDiscountInput {
  label: String
  amount: MoneyInput
}

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

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