Mutation Root
The schema's entry point for all mutation operations.
Anchor to FieldsFields
- Anchor to captureSessionRejectcapture•Capture
Session Reject Session Reject Payload Rejects an open capture session.
After the
mutation completes on a given capture session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
reason
argument will be ignored.- Anchor to captureSessionResolvecapture•Capture
Session Resolve Session Resolve Payload Resolves an open capture session.
After the
mutation completes on a given capture session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed.
- Anchor to paymentsAppConfigurepayments•Payments
App Configure App Configure Payload Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the
mutation, refer to the tutorial for onboarding merchants to payments extensions.
- Anchor to paymentSessionConfirmpayment•Payment
Session Confirm Session Confirm Payload Initiates the confirmation process of the given payment_session.
Shopify will start confirming the payment. According to its business logic, Shopify determines if the payment can be authorized and sends a POST request to the payments app, delivering the confirmation result.
- Anchor to paymentSessionModalpayment•Payment
Session Modal Session Modal Payload Raises a modal that will be displayed to the buyer after a checkout is completed. Included data will be used to populate the UI extension in the modal.
- Anchor to paymentSessionPendingpayment•Payment
Session Pending Session Pending Payload Change a payment session status to pending.
Upon receiving the response from the
mutation, you must redirect the customer back to Shopify, using
in
.
Upon completion, pending payments must be finalized into either a successful or failed state using the
or
mutations. Both
sale
andauthorization
payments can be marked as pending.- Anchor to paymentSessionRedirectpayment•Payment
Session Redirect Session Redirect Payload Redirects the buyer to the given URL for the payment session. For example, Shopify will redirect the buyer to the URL where the 3DS authentication will take place for onsite payment with
payment method.
- Anchor to paymentSessionRejectpayment•Payment
Session Reject Session Reject Payload Rejects an open payment session. After the
mutation completes on a given payment session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
argument will be ignored.
- Anchor to paymentSessionResolvepayment•Payment
Session Resolve Session Resolve Payload Resolves an open payment session. After the
mutation completes on a given payment session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
Details
argument will be ignored.- Anchor to refundSessionRejectrefund•Refund
Session Reject Session Reject Payload Rejects an open refund session. After the
mutation completes on a given refund session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
argument will be ignored.
- Anchor to refundSessionResolverefund•Refund
Session Resolve Session Resolve Payload Resolves an open refund session. After the
mutation completes on a given refund session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
Details
argument will be ignored.- Anchor to verificationSessionRedirectverification•Verification
Session Redirect Session Redirect Payload Redirects the buyer to the given URL for the verification session. Shopify will redirect the buyer to the URL where the 3DS authentication will take place when verifying the buyer's credit_card.
- Anchor to verificationSessionRejectverification•Verification
Session Reject Session Reject Payload Rejects an open verification session. After the
mutation completes on a given verification session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
argument will be ignored.
- Anchor to verificationSessionResolveverification•Verification
Session Resolve Session Resolve Payload Resolves an open verification session. After the
mutation completes on a given verification session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
Details
argument will be ignored.- Anchor to voidSessionRejectvoid•Void
Session Reject Session Reject Payload Rejects an open void session. After the
mutation completes on a given void session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
argument will be ignored.
- Anchor to voidSessionResolvevoid•Void
Session Resolve Session Resolve Payload Resolves an open void session. After the
mutation completes on a given void session, any
mutation attempts will fail. Subsequent
mutation attempts will succeed, but the
Details
argument will be ignored.