Skip to main content
Anchor to ShopPayPaymentRequestSessionCreatePayload

ShopPayPaymentRequestSessionCreatePayload

payload

Return type for shopPayPaymentRequestSessionCreate mutation.

Anchor to FieldsFields

Anchor to shopPayPaymentRequestSessionshopPayPaymentRequestSession
•ShopPayPaymentRequestSession

The new Shop Pay payment request session object.

Anchor to userErrorsuserErrors
•[UserErrorsShopPayPaymentRequestSessionUserErrors!]!
non-null

Error codes for failed Shop Pay payment request session mutations.

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

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.

Arguments

Anchor to sourceIdentifiersourceIdentifier
•String!
required

A unique identifier for the payment request session.

Anchor to paymentRequestpaymentRequest
•ShopPayPaymentRequestInput!
required

A payment request object.

Was this section helpful?