---
title: ShopPayPaymentRequestSession - Storefront API
description: Represents a Shop Pay payment request session.
api_version: 2026-01
api_name: storefront
type: object
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/storefront/latest/objects/ShopPayPaymentRequestSession
  md: https://shopify.dev/docs/api/storefront/latest/objects/ShopPayPaymentRequestSession.md
---

# Shop​Pay​Payment​Request​Session

object

Represents a Shop Pay payment request session.

## Fields

* checkout​Url

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

  non-null

  The checkout URL of the Shop Pay payment request session.

* payment​Request

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

  non-null

  The payment request associated with the Shop Pay payment request session.

* source​Identifier

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

  non-null

  The source identifier of the Shop Pay payment request session.

* token

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

  non-null

  The token of the Shop Pay payment request session.

***

## Map

No referencing types

***

## Mutations

* [shop​Pay​Payment​Request​Session​Create](https://shopify.dev/docs/api/storefront/latest/mutations/shopPayPaymentRequestSessionCreate)

  mutation

  Creates a [Shop Pay payment request session](https://shopify.dev/docs/api/storefront/2026-01/objects/ShopPayPaymentRequestSession) for processing payments. The session includes a checkout URL where customers complete their purchase and a token for subsequent operations like submitting the payment.

  The `sourceIdentifier` must be unique across all orders to ensure accurate reconciliation.

  For a complete integration guide including the JavaScript SDK setup and checkout flow, refer to the [Shop Component API documentation](https://shopify.dev/docs/api/commerce-components/pay). For implementation steps, see the [development journey guide](https://shopify.dev/docs/api/commerce-components/pay/development-journey). For common error scenarios, see the [troubleshooting guide](https://shopify.dev/docs/api/commerce-components/pay/troubleshooting-guide).

  * source​Identifier

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

    required

    ### Arguments

    A unique identifier for the payment request session.

  * payment​Request

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

    required

    A payment request object.

  ***

***

## ShopPayPaymentRequestSession Mutations

### Mutated by

* [shop​Pay​Payment​Request​Session​Create](https://shopify.dev/docs/api/storefront/latest/mutations/shopPayPaymentRequestSessionCreate)