---
title: PaymentScheduleCaptureUserError - GraphQL Admin
description: An error that occurs during the execution of `PaymentScheduleCapture`.
api_version: 2026-10
source_url:
  html: >-
    https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentScheduleCaptureUserError
  md: >-
    https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentScheduleCaptureUserError.md
api_name: admin
api_type: graphql
type: object
---

# Payment​Schedule​Capture​User​Error

object

An error that occurs during the execution of `PaymentScheduleCapture`.

## Fields

* code

  [Payment​Schedule​Capture​User​Error​Code](https://shopify.dev/docs/api/admin-graphql/latest/enums/PaymentScheduleCaptureUserErrorCode)

  The error code.

* field

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

  The path to the input field that caused the error.

* message

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

  non-null

  The error message.

***

## Map

No referencing types

***

## Mutations

* [payment​Schedule​Capture](https://shopify.dev/docs/api/admin-graphql/latest/mutations/paymentScheduleCapture)

  mutation

  Captures payment for a due [`PaymentSchedule`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentSchedule) using the vaulted payment method associated with the order.

  The mutation resolves the order and mandate from the given payment schedule, then initiates an asynchronous payment capture. Use the returned `jobResult` to poll for the status of the payment capture.

  * payment​Schedule​Id

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

    required

    ### Arguments

    The ID of the payment schedule to capture payment for.

  ***

***

## PaymentScheduleCaptureUserError Mutations

### Mutated by

* [payment​Schedule​Capture](https://shopify.dev/docs/api/admin-graphql/latest/mutations/paymentScheduleCapture)

***

## Interfaces

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

  interface

***

## PaymentScheduleCaptureUserError Implements

### Implements

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