Skip to main content
Anchor to ShopPayPaymentRequestSessionSubmitPayload

ShopPayPaymentRequestSessionSubmitPayload

payload

Return type for shopPayPaymentRequestSessionSubmit mutation.

Anchor to paymentRequestReceiptpaymentRequestReceipt
•ShopPayPaymentRequestReceipt

The checkout on which the payment was applied.

Show fields
•[UserErrorsShopPayPaymentRequestSessionUserErrors!]!
non-null

Error codes for failed Shop Pay payment request session mutations.

Show fields

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Finalizes a Shop Pay payment request session. Call this mutation after creating a session with shopPayPaymentRequestSessionCreate.

The idempotencyKey argument ensures the payment transaction occurs only once, preventing duplicate charges. On success, returns a ShopPayPaymentRequestReceipt with the processing status and a receipt token.

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

•String!
required

The idempotency key is used to guarantee an idempotent result.

•String

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

•ShopPayPaymentRequestInput!
required

The final payment request object.

Show input fields
•String!
required

A token representing a payment session request.



Was this section helpful?