---
title: UserError - Payments Apps API
description: |-
  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.
api_version: 2026-10
source_url:
  html: 'https://shopify.dev/docs/api/payments-apps/latest/objects/UserError'
  md: 'https://shopify.dev/docs/api/payments-apps/latest/objects/UserError.md'
api_name: payments-apps
api_type: graphql
type: object
---

# User​Error

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.

## Fields

* field

  [\[String!\]](https://shopify.dev/docs/api/payments-apps/latest/scalars/String)

  The path to the input field that caused the error.

* message

  [String!](https://shopify.dev/docs/api/payments-apps/latest/scalars/String)

  non-null

  The error message.

***

## Map

No referencing types

***

## Mutations

* [payments​App​Configure](https://shopify.dev/docs/api/payments-apps/latest/mutations/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](https://shopify.dev/docs/apps/build/payments/onboard-a-merchant-payments-extension).

  * external​Handle

    [String](https://shopify.dev/docs/api/payments-apps/latest/scalars/String)

    ### Arguments

    Handle used in the external system.

  * ready

    [Boolean!](https://shopify.dev/docs/api/payments-apps/latest/scalars/Boolean)

    required

    The provider is ready to process merchant's payments.

  ***

* [payment​Session​Reject](https://shopify.dev/docs/api/payments-apps/latest/mutations/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.

  * authentication

    [Payment​Session​Three​DSecure​Authentication](https://shopify.dev/docs/api/payments-apps/latest/input-objects/PaymentSessionThreeDSecureAuthentication)

    ### Arguments

    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.

  * id

    [ID!](https://shopify.dev/docs/api/payments-apps/latest/scalars/ID)

    required

    The payment session ID.

  * payment​Details

    [Payment​Session​Payment​Details](https://shopify.dev/docs/api/payments-apps/latest/input-objects/PaymentSessionPaymentDetails)

    The payment details used to process the transaction.

  * reason

    [Payment​Session​Rejection​Reason​Input!](https://shopify.dev/docs/api/payments-apps/latest/input-objects/PaymentSessionRejectionReasonInput)

    required

    The rejection reason.

  ***

* [payment​Session​Resolve](https://shopify.dev/docs/api/payments-apps/latest/mutations/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.

  * authentication

    [Payment​Session​Three​DSecure​Authentication](https://shopify.dev/docs/api/payments-apps/latest/input-objects/PaymentSessionThreeDSecureAuthentication)

    ### Arguments

    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.

  * authorization​Expires​At

    [Date​Time](https://shopify.dev/docs/api/payments-apps/latest/scalars/DateTime)

    The date and time when an authorized payment session expires.

  * id

    [ID!](https://shopify.dev/docs/api/payments-apps/latest/scalars/ID)

    required

    The payment session ID.

  * network​Transaction​Id

    [String](https://shopify.dev/docs/api/payments-apps/latest/scalars/String)

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

  * payment​Details

    [Payment​Session​Payment​Details](https://shopify.dev/docs/api/payments-apps/latest/input-objects/PaymentSessionPaymentDetails)

    The payment details used to process the transaction.

  ***

***

## UserError Mutations

### Mutated by

* [payment​Session​Reject](https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentSessionReject)
* [payment​Session​Resolve](https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentSessionResolve)
* [payments​App​Configure](https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentsAppConfigure)

***

## Interfaces

* [Displayable​Error](https://shopify.dev/docs/api/payments-apps/latest/interfaces/DisplayableError)

  interface

***

## UserError Implements

### Implements

* [Displayable​Error](https://shopify.dev/docs/api/payments-apps/latest/interfaces/DisplayableError)