Skip to main content
object

The schema's entry point for all mutation operations.

Anchor to captureSessionRejectcaptureSessionReject
•CaptureSessionRejectPayload

Rejects an open capture session.

After the captureSessionReject mutation completes on a given capture session, any captureSessionResolve mutation attempts will fail. Subsequent captureSessionReject mutation attempts will succeed, but the reason argument will be ignored.

Arguments

•ID!
required

The capture session ID.

•CaptureSessionRejectionReasonInput!
required

The rejection reason.


Anchor to captureSessionResolvecaptureSessionResolve
•CaptureSessionResolvePayload

Resolves an open capture session.

After the captureSessionResolve mutation completes on a given capture session, any captureSessionReject mutation attempts will fail. Subsequent captureSessionResolve mutation attempts will succeed.

Arguments

•ID!
required

The capture session ID.


Anchor to paymentsAppConfigurepaymentsAppConfigure
•PaymentsAppConfigurePayload

Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the paymentsAppConfigure mutation, refer to the tutorial for onboarding merchants to payments extensions.

Arguments

•String

Handle used in the external system.

•Boolean!
required

The provider is ready to process merchant's payments.


Anchor to paymentSessionConfirmpaymentSessionConfirm
•PaymentSessionConfirmPayload

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.

Arguments

•ID!
required

The payment session ID.


•PaymentSessionModalPayload

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.

Arguments

•ID!
required

The payment session ID.

•DateTime

The date and time the modal will expire, in UTC

•ModalAction!
required

The buyer action and corresponding data that will be made available in the modal at runtime.


Anchor to paymentSessionPendingpaymentSessionPending
•PaymentSessionPendingPayload

Change a payment session status to pending.

Upon receiving the response from the PaymentSessionPending mutation, you must redirect the customer back to Shopify, using redirectUrl in nextAction.

Upon completion, pending payments must be finalized into either a successful or failed state using the paymentSessionResolve or paymentSessionReject mutations. Both sale and authorization payments can be marked as pending.

Arguments

•ID!
required

The payment session ID.

•DateTime!
required

The date and time when the pending payment expires, recommended to be within 3 days.

•PaymentSessionStatePendingReason!
required

The reason the payment is pending.


Anchor to paymentSessionRedirectpaymentSessionRedirect
•PaymentSessionRedirectPayload

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 credit_card payment method.

Arguments

•ID!
required

The payment session ID.

•URL!
required

The URL that Shopify will redirect the buyer to, for 3DS authentication. Applicable to payments with the credit card payment method only.


Anchor to paymentSessionRejectpaymentSessionReject
•PaymentSessionRejectPayload

Rejects an open payment session. After the paymentSessionReject mutation completes on a given payment session, any paymentSessionResolve mutation attempts will fail. Subsequent paymentSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

Arguments

•ID!
required

The payment session ID.

•PaymentSessionRejectionReasonInput!
required

The rejection reason.

•PaymentSessionThreeDSecureAuthentication

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.

•PaymentSessionPaymentDetails

The payment details used to process the transaction.


Anchor to paymentSessionResolvepaymentSessionResolve
•PaymentSessionResolvePayload

Resolves an open payment session. After the paymentSessionResolve mutation completes on a given payment session, any paymentSessionReject mutation attempts will fail. Subsequent paymentSessionResolve mutation attempts will succeed, but the Details argument will be ignored.

Arguments

•ID!
required

The payment session ID.

Anchor to authorizationExpiresAtauthorizationExpiresAt
•DateTime

The date and time when an authorized payment session expires.

•PaymentSessionThreeDSecureAuthentication

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 networkTransactionIdnetworkTransactionId
•String

The transaction ID issued by the network when processing the payment.

•PaymentSessionPaymentDetails

The payment details used to process the transaction.


•RefundSessionRejectPayload

Rejects an open refund session. After the refundSessionReject mutation completes on a given refund session, any refundSessionResolve mutation attempts will fail. Subsequent refundSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

Arguments

•ID!
required

The refund session ID.

•RefundSessionRejectionReasonInput!
required

The rejection reason.


Anchor to refundSessionResolverefundSessionResolve
•RefundSessionResolvePayload

Resolves an open refund session. After the refundSessionResolve mutation completes on a given refund session, any refundSessionReject mutation attempts will fail. Subsequent refundSessionResolve mutation attempts will succeed, but the Details argument will be ignored.

Arguments

•ID!
required

The refund session ID.


Anchor to verificationSessionRedirectverificationSessionRedirect
•VerificationSessionRedirectPayload

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.

Arguments

•ID!
required

The verification session ID.

•URL!
required

The URL that Shopify will redirect the buyer to, for 3DS authentication. Applicable to verifications with the credit card payment method only.


Anchor to verificationSessionRejectverificationSessionReject
•VerificationSessionRejectPayload

Rejects an open verification session. After the verificationSessionReject mutation completes on a given verification session, any verificationSessionResolve mutation attempts will fail. Subsequent verificationSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

Arguments

•ID!
required

The verification session ID.

•VerificationSessionRejectionReasonInput!
required

The rejection reason.

•VerificationSessionThreeDSecureAuthentication

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 verificationSessionResolveverificationSessionResolve
•VerificationSessionResolvePayload

Resolves an open verification session. After the verificationSessionResolve mutation completes on a given verification session, any verificationSessionReject mutation attempts will fail. Subsequent verificationSessionResolve mutation attempts will succeed, but the Details argument will be ignored.

Arguments

•ID!
required

The verification session ID.

Anchor to networkTransactionIdnetworkTransactionId
•String
Deprecated
•VerificationSessionThreeDSecureAuthentication

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.

•VerificationSessionPaymentDetailsInput

The payment details used to process the verification.


•VoidSessionRejectPayload

Rejects an open void session. After the voidSessionReject mutation completes on a given void session, any voidSessionResolve mutation attempts will fail. Subsequent voidSessionReject mutation attempts will succeed, but the RejectionReasonInput argument will be ignored.

Arguments

•ID!
required

The void session ID.

•VoidSessionRejectionReasonInput!
required

The rejection reason.


•VoidSessionResolvePayload

Resolves an open void session. After the voidSessionResolve mutation completes on a given void session, any voidSessionReject mutation attempts will fail. Subsequent voidSessionResolve mutation attempts will succeed, but the Details argument will be ignored.

Arguments

•ID!
required

The void session ID.



Was this section helpful?