Shop
Return type for mutation.
Anchor to FieldsFields
- paymentRequestReceipt (ShopPayPaymentRequestReceipt)
- userErrors ([UserErrorsShopPayPaymentRequestSessionUserErrors!]!)
- Anchor to paymentRequestReceiptpayment•Shop
Request Receipt Pay Payment Request Receipt The checkout on which the payment was applied.
- Anchor to userErrorsuser•[User
Errors Errors Shop Pay Payment Request Session User Errors!]! non-null Error codes for failed Shop Pay payment request session mutations.
Anchor to Mutations with this payloadMutations with this payload
- shopPayPaymentRequestSessionSubmit (ShopPayPaymentRequestSessionSubmitPayload)
- •mutation
Finalizes a Shop Pay payment request session. Call this mutation after creating a session with
.The
argument ensures the payment transaction occurs only once, preventing duplicate charges. On success, returns awith 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.
- Anchor to tokentoken•String!required
A token representing a payment session request.
- Anchor to paymentRequestpayment•Shop
Request Pay Payment Request Input! required The final payment request object.
- Anchor to idempotencyKeyidempotency•String!
Key required The idempotency key is used to guarantee an idempotent result.
- Anchor to orderNameorder•String
Name The order name to be used for the order created from the payment request.
Arguments