Choose a version:

UserError

object

An error in the input of a mutation. Mutations return UserError objects to indicate validation failures, such as invalid field values or business logic violations, that prevent the operation from completing.

Anchor to FieldsFields

Anchor to fieldfield •[String!]: The path to the input field that caused the error.
Anchor to messagemessage •String! non-null: The error message.

Was this section helpful?

Anchor to MutationsMutations

Anchor to paymentsAppConfigure paymentsAppConfigure •mutation: 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.
Anchor to paymentSessionReject paymentSessionReject •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.
Anchor to paymentSessionResolve paymentSessionResolve •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?

Anchor to InterfacesInterfaces

Anchor to DisplayableError DisplayableError •interface

Was this section helpful?