Skip to main content
Anchor to PaymentSessionPendingUserError

PaymentSessionPendingUserError

object

Requires read_payment_sessions access scope.

Represents a payment session custom error.

•PaymentSessionPendingUserErrorCode

The error code.

•[String!]

The path to the input field that caused the error.

•String!
non-null

The error message.


Was this section helpful?

•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.

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.


Fields

•PaymentSession

The updated payment session.

•[PaymentSessionPendingUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?


Was this section helpful?