User
Error codes for failed Shop Pay payment request session mutations.
Anchor to FieldsFields
- code (UserErrorsShopPayPaymentRequestSessionUserErrorsCode)
- field ([String!])
- message (String!)
- Anchor to codecode•User
Errors Shop Pay Payment Request Session User Errors Code The error code.
- Anchor to fieldfield•[String!]
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- shopPayPaymentRequestSessionCreate (ShopPayPaymentRequestSessionCreatePayload)
- shopPayPaymentRequestSessionSubmit (ShopPayPaymentRequestSessionSubmitPayload)
- •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
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.
- Anchor to sourceIdentifiersource•String!
Identifier required A unique identifier for the payment request session.
- Anchor to paymentRequestpayment•Shop
Request Pay Payment Request Input! required A payment request object.
Arguments
- •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