Mutation Root
The schema's entry point for all mutation operations.
Anchor to FieldsFields
- captureSessionReject (CaptureSessionRejectPayload)
- captureSessionResolve (CaptureSessionResolvePayload)
- paymentsAppConfigure (PaymentsAppConfigurePayload)
- paymentSessionConfirm (PaymentSessionConfirmPayload)
- paymentSessionModal (PaymentSessionModalPayload)
- paymentSessionPending (PaymentSessionPendingPayload)
- paymentSessionRedirect (PaymentSessionRedirectPayload)
- paymentSessionReject (PaymentSessionRejectPayload)
- paymentSessionResolve (PaymentSessionResolvePayload)
- refundSessionReject (RefundSessionRejectPayload)
- refundSessionResolve (RefundSessionResolvePayload)
- verificationSessionRedirect (VerificationSessionRedirectPayload)
- verificationSessionReject (VerificationSessionRejectPayload)
- verificationSessionResolve (VerificationSessionResolvePayload)
- voidSessionReject (VoidSessionRejectPayload)
- voidSessionResolve (VoidSessionResolvePayload)
- Anchor to captureSessionRejectcapture•Capture
Session Reject Session Reject Payload Rejects an open capture session.
After the
mutation completes on a given capture session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but thereasonargument will be ignored.- •ID!required
The capture session ID.
- Anchor to reasonreason•Capture
Session Rejection Reason Input! required The rejection reason.
Arguments
- •ID!
- Anchor to captureSessionResolvecapture•Capture
Session Resolve Session Resolve Payload Resolves an open capture session.
After the
mutation completes on a given capture session, anymutation attempts will fail. Subsequentmutation attempts will succeed.- •ID!required
The capture session ID.
Arguments
- •ID!
- 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 externalHandleexternal•String
Handle Handle used in the external system.
- Anchor to readyready•Boolean!required
The provider is ready to process merchant's payments.
Arguments
- 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.
- •ID!required
The payment session ID.
Arguments
- •ID!
- 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.
- •ID!required
The payment session ID.
- Anchor to expiresAtexpires•Date
At Time The date and time the modal will expire, in UTC
- Anchor to actionaction•Modal
Action! required The buyer action and corresponding data that will be made available in the modal at runtime.
Arguments
- •ID!
- 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, usingin.Upon completion, pending payments must be finalized into either a successful or failed state using the
ormutations. Bothsaleandauthorizationpayments can be marked as pending.- •ID!required
The payment session ID.
- Anchor to pendingExpiresAtpending•Date
Expires At Time! required The date and time when the pending payment expires, recommended to be within 3 days.
- Anchor to reasonreason•Payment
Session State Pending Reason! required The reason the payment is pending.
Arguments
- •ID!
- 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.- •ID!required
The payment session ID.
- Anchor to redirectUrlredirect•URL!
Url required The URL that Shopify will redirect the buyer to, for 3DS authentication. Applicable to payments with the credit card payment method only.
Arguments
- •ID!
- Anchor to paymentSessionRejectpayment•Payment
Session Reject Session Reject Payload Rejects an open payment session. After the
mutation completes on a given payment session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but theargument will be ignored.- •ID!required
The payment session ID.
- Anchor to reasonreason•Payment
Session Rejection Reason Input! required The rejection reason.
- Anchor to authenticationauthentication•Payment
Session Three DSecure Authentication The 3D Secure authentication data from the partner. Must be present if and only if the Redirect mutation has been called and the payment method is credit card.
- Anchor to paymentDetailspayment•Payment
Details Session Payment Details The payment details used to process the transaction.
Arguments
- •ID!
- Anchor to paymentSessionResolvepayment•Payment
Session Resolve Session Resolve Payload Resolves an open payment session. After the
mutation completes on a given payment session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but theDetailsargument will be ignored.- •ID!required
The payment session ID.
- •Date
Time The date and time when an authorized payment session expires.
- Anchor to authenticationauthentication•Payment
Session Three DSecure Authentication The 3D Secure authentication data from the partner. Must be present if and only if the Redirect mutation has been called and the payment method is credit card.
- Anchor to networkTransactionIdnetwork•String
Transaction Id The transaction ID issued by the network when processing the payment.
- Anchor to paymentDetailspayment•Payment
Details Session Payment Details The payment details used to process the transaction.
Arguments
- •ID!
- Anchor to refundSessionRejectrefund•Refund
Session Reject Session Reject Payload Rejects an open refund session. After the
mutation completes on a given refund session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but theargument will be ignored.- •ID!required
The refund session ID.
- Anchor to reasonreason•Refund
Session Rejection Reason Input! required The rejection reason.
Arguments
- •ID!
- Anchor to refundSessionResolverefund•Refund
Session Resolve Session Resolve Payload Resolves an open refund session. After the
mutation completes on a given refund session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but theDetailsargument will be ignored.- •ID!required
The refund session ID.
Arguments
- •ID!
- 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.
- •ID!required
The verification session ID.
- Anchor to redirectUrlredirect•URL!
Url required The URL that Shopify will redirect the buyer to, for 3DS authentication. Applicable to verifications with the credit card payment method only.
Arguments
- •ID!
- Anchor to verificationSessionRejectverification•Verification
Session Reject Session Reject Payload Rejects an open verification session. After the
mutation completes on a given verification session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but theargument will be ignored.- •ID!required
The verification session ID.
- Anchor to reasonreason•Verification
Session Rejection Reason Input! required The rejection reason.
- Anchor to authenticationauthentication•Verification
Session Three DSecure Authentication The 3D Secure authentication data from the partner. Must be present if and only if the Redirect mutation has been called and the payment method is credit card.
Arguments
- •ID!
- Anchor to verificationSessionResolveverification•Verification
Session Resolve Session Resolve Payload Resolves an open verification session. After the
mutation completes on a given verification session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but theDetailsargument will be ignored.- •ID!required
The verification session ID.
- Anchor to networkTransactionIdnetwork•String
Transaction Id Deprecated - Anchor to authenticationauthentication•Verification
Session Three DSecure Authentication The 3D Secure authentication data from the partner. Must be present if and only if the Redirect mutation has been called and the payment method is credit card.
- Anchor to paymentDetailspayment•Verification
Details Session Payment Details Input The payment details used to process the verification.
Arguments
- •ID!
- Anchor to voidSessionRejectvoid•Void
Session Reject Session Reject Payload Rejects an open void session. After the
mutation completes on a given void session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but theargument will be ignored.- •ID!required
The void session ID.
- Anchor to reasonreason•Void
Session Rejection Reason Input! required The rejection reason.
Arguments
- •ID!
- Anchor to voidSessionResolvevoid•Void
Session Resolve Session Resolve Payload Resolves an open void session. After the
mutation completes on a given void session, anymutation attempts will fail. Subsequentmutation attempts will succeed, but theDetailsargument will be ignored.- •ID!required
The void session ID.
Arguments
- •ID!