Skip to main content
Anchor to UserError

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

Arguments

Anchor to externalHandleexternalHandle
•String

Handle used in the external system.

Anchor to readyready
•Boolean!
required

The provider is ready to process merchant's payments.

Anchor to paymentSessionRejectpaymentSessionReject
•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.

Arguments

Anchor to idid
•ID!
required

The payment session ID.

Anchor to reasonreason
•PaymentSessionRejectionReasonInput!
required

The rejection reason.

Anchor to authenticationauthentication
•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 paymentDetailspaymentDetails
•PaymentSessionPaymentDetails

The payment details used to process the transaction.

Anchor to paymentSessionResolvepaymentSessionResolve
•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.

Arguments

Anchor to idid
•ID!
required

The payment session ID.

Anchor to authorizationExpiresAtauthorizationExpiresAt
•DateTime

The date and time when an authorized payment session expires.

Anchor to authenticationauthentication
•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.

Anchor to paymentDetailspaymentDetails
•PaymentSessionPaymentDetails

The payment details used to process the transaction.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?