captureSessionReject mutation
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 RejectionReasonInput
argument will be ignored.
Required access
write_payment_sessions
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The capture session ID. |
reason
(
CaptureSessionRejectionReasonInput!
)
required
|
The rejection reason. |
CaptureSessionRejectionReasonInput fields
-
code (
CaptureSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
captureSession (
CaptureSession
)The updated capture session.
-
userErrors (
[CaptureSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
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 RejectionReasonInput
argument will be ignored.
Required access
write_payment_sessions
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The capture session ID. |
reason
(
CaptureSessionRejectionReasonInput!
)
required
|
The rejection reason. |
CaptureSessionRejectionReasonInput fields
-
code (
CaptureSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
captureSession (
CaptureSession
)The updated capture session.
-
userErrors (
[CaptureSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
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 RejectionReasonInput
argument will be ignored.
Required access
write_payment_sessions
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The capture session ID. |
reason
(
CaptureSessionRejectionReasonInput!
)
required
|
The rejection reason. |
CaptureSessionRejectionReasonInput fields
-
code (
CaptureSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
captureSession (
CaptureSession
)The updated capture session.
-
userErrors (
[CaptureSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
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 RejectionReasonInput
argument will be ignored.
Required access
write_payment_sessions
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The capture session ID. |
reason
(
CaptureSessionRejectionReasonInput!
)
required
|
The rejection reason. |
CaptureSessionRejectionReasonInput fields
-
code (
CaptureSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
captureSession (
CaptureSession
)The updated capture session.
-
userErrors (
[CaptureSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
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 RejectionReasonInput
argument will be ignored.
Required access
write_payment_sessions
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The capture session ID. |
reason
(
CaptureSessionRejectionReasonInput!
)
required
|
The rejection reason. |
CaptureSessionRejectionReasonInput fields
-
code (
CaptureSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
captureSession (
CaptureSession
)The updated capture session.
-
userErrors (
[CaptureSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
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 RejectionReasonInput
argument will be ignored.
Required access
write_payment_sessions
access scope.
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The capture session ID. |
reason
(
CaptureSessionRejectionReasonInput!
)
required
|
The rejection reason. |
CaptureSessionRejectionReasonInput fields
-
code (
CaptureSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
captureSession (
CaptureSession
)The updated capture session.
-
userErrors (
[CaptureSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.