Skip to main content
Anchor to captureSessionReject

captureSessionReject

mutation

Requires write_payment_sessions access scope.

Rejects an open capture session.

After the captureSessionReject mutation completes on a given capture session, any captureSessionResolve mutation attempts will fail. Subsequent captureSessionReject mutation attempts will succeed, but the reason argument will be ignored.

Anchor to Arguments

Arguments

Anchor to idid
•
ID!required

The capture session ID.

Anchor to reasonreason
•
CaptureSessionRejectionReasonInput!required

The rejection reason.

Was this section helpful?

Anchor to CaptureSessionRejectPayload returnsCaptureSessionRejectPayload returns

Anchor to captureSessioncaptureSession
•
CaptureSession

The updated capture session.

Anchor to userErrorsuserErrors
•
[CaptureSessionRejectUserError!]!non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?