Skip to main content
object

Requires read_payment_sessions access scope.

A unique payment transaction.

Anchor to authorizationExpiresAtauthorizationExpiresAt
•DateTime

The date and time when an authorized payment session expires.

•ID!
non-null

A globally-unique ID.

•PaymentSessionNextAction

The next action expected of the partner.

•DateTime

The date and time when a pending payment session expires.

•PaymentSessionStates!
non-null

Details about the payment state.


Was this section helpful?

•mutation

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.

•mutation

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.

•mutation

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.

•mutation

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.

•mutation

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.

•mutation

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.


Was this section helpful?