Skip to main content
Anchor to ShopPayPaymentRequestSession

ShopPayPaymentRequestSession

object

Represents a Shop Pay payment request session.

Anchor to FieldsFields

Anchor to checkoutUrlcheckoutUrl
•URL!
non-null

The checkout URL of the Shop Pay payment request session.

Anchor to paymentRequestpaymentRequest
•ShopPayPaymentRequest!
non-null

The payment request associated with 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.

Was this section helpful?

Anchor to MutationsMutations

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?