Skip to main content
Anchor to ShopPayPaymentRequestSession

ShopPayPaymentRequestSession

object

Represents a Shop Pay payment request session.

Anchor to FieldsFields

Anchor to businessEntityIdbusinessEntityId
•String

The ID of the business entity selected for this session, in the form accepted by shopPayPaymentRequestSessionCreate and shopPayPaymentRequestSessionBusinessEntityUpdate. Returns null if no entity was selected or the selected entity can't be found for this shop. When no entity is selected, the shop's primary business entity is used. This ID can't be resolved through the Storefront API's node query.

Anchor to checkoutUrlcheckoutUrl
•URL!
non-null

The checkout URL of the Shop Pay payment request session.

Anchor to sourceIdentifiersourceIdentifier
•String!
non-null

The source identifier of the Shop Pay payment request session.

Anchor to tokentoken
•String!
non-null

The token of the Shop Pay payment request session.

Anchor to paymentRequestpaymentRequest
•ShopPayPaymentRequest
Deprecated
Show fields
Was this section helpful?

Anchor to MutationsMutations

Anchor to shopPayPaymentRequestSessionBusinessEntityUpdateshopPayPaymentRequestSessionBusinessEntityUpdate
•mutation

Updates the business entity associated with an ongoing Shop Pay payment request session. You can change the business entity before submitting payment, or after the latest payment attempt has failed.

Show payload

Arguments

Anchor to businessEntityIdbusinessEntityId
•String!
required

The full global ID of the business entity to process this payment through, such as gid://shopify/BusinessEntity/123, returned by the Admin API businessEntities query. To use the shop's primary business entity, provide its global ID.

Anchor to tokentoken
•String!
required

A payment request session token.

Anchor to shopPayPaymentRequestSessionCreateshopPayPaymentRequestSessionCreate
•mutation

Creates a Shop Pay payment request session 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. For implementation steps, see the development journey guide. For common error scenarios, see the troubleshooting guide.

Show payload

Arguments

Anchor to businessEntityIdbusinessEntityId
•String

The full global ID of the business entity to process this payment through, such as gid://shopify/BusinessEntity/123, returned by the Admin API businessEntities query. Omit it to use the shop's primary business entity.

Anchor to paymentRequestpaymentRequest
•ShopPayPaymentRequestInput
Deprecated
Show input fields
Anchor to sourceIdentifiersourceIdentifier
•String!
required

A unique identifier for the payment request session.

Was this section helpful?