---
title: shopPayPaymentRequestSessionSubmit - Storefront API
description: Submits a Shop Pay payment request session.
api_version: 2025-10
api_name: storefront
type: mutation
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/storefront/latest/mutations/shopPayPaymentRequestSessionSubmit
  md: https://shopify.dev/docs/api/storefront/latest/mutations/shopPayPaymentRequestSessionSubmit.md
---

# shop​Pay​Payment​Request​Session​Submit

mutation

Submits a Shop Pay payment request session.

## Arguments

* idempotency​Key

  [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String)

  required

  The idempotency key is used to guarantee an idempotent result.

* order​Name

  [String](https://shopify.dev/docs/api/storefront/latest/scalars/String)

  The order name to be used for the order created from the payment request.

* payment​Request

  [Shop​Pay​Payment​Request​Input!](https://shopify.dev/docs/api/storefront/latest/input-objects/ShopPayPaymentRequestInput)

  required

  The final payment request object.

* token

  [String!](https://shopify.dev/docs/api/storefront/latest/scalars/String)

  required

  A token representing a payment session request.

***

## Shop​Pay​Payment​Request​Session​Submit​Payload returns

* payment​Request​Receipt

  [Shop​Pay​Payment​Request​Receipt](https://shopify.dev/docs/api/storefront/latest/objects/ShopPayPaymentRequestReceipt)

  The checkout on which the payment was applied.

* user​Errors

  [\[User​Errors​Shop​Pay​Payment​Request​Session​User​Errors!\]!](https://shopify.dev/docs/api/storefront/latest/objects/UserErrorsShopPayPaymentRequestSessionUserErrors)

  non-null

  Error codes for failed Shop Pay payment request session mutations.

***

## Examples

* ### shopPayPaymentRequestSessionSubmit reference

## Mutation Reference

```graphql
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

```json
{
  "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
}
```