voidSessionReject mutation
Rejects an open void session.
After the voidSessionReject
mutation completes on a given void session, any
voidSessionResolve
mutation attempts will fail. Subsequent voidSessionReject
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 void session ID. |
reason
(
VoidSessionRejectionReasonInput!
)
required
|
The rejection reason. |
VoidSessionRejectionReasonInput fields
-
code (
VoidSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
userErrors (
[VoidSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
-
voidSession (
VoidSession
)The updated void session.
Rejects an open void session.
After the voidSessionReject
mutation completes on a given void session, any
voidSessionResolve
mutation attempts will fail. Subsequent voidSessionReject
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 void session ID. |
reason
(
VoidSessionRejectionReasonInput!
)
required
|
The rejection reason. |
VoidSessionRejectionReasonInput fields
-
code (
VoidSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
userErrors (
[VoidSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
-
voidSession (
VoidSession
)The updated void session.
Rejects an open void session.
After the voidSessionReject
mutation completes on a given void session, any
voidSessionResolve
mutation attempts will fail. Subsequent voidSessionReject
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 void session ID. |
reason
(
VoidSessionRejectionReasonInput!
)
required
|
The rejection reason. |
VoidSessionRejectionReasonInput fields
-
code (
VoidSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
userErrors (
[VoidSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
-
voidSession (
VoidSession
)The updated void session.
Rejects an open void session.
After the voidSessionReject
mutation completes on a given void session, any
voidSessionResolve
mutation attempts will fail. Subsequent voidSessionReject
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 void session ID. |
reason
(
VoidSessionRejectionReasonInput!
)
required
|
The rejection reason. |
VoidSessionRejectionReasonInput fields
-
code (
VoidSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
userErrors (
[VoidSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
-
voidSession (
VoidSession
)The updated void session.
Rejects an open void session.
After the voidSessionReject
mutation completes on a given void session, any
voidSessionResolve
mutation attempts will fail. Subsequent voidSessionReject
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 void session ID. |
reason
(
VoidSessionRejectionReasonInput!
)
required
|
The rejection reason. |
VoidSessionRejectionReasonInput fields
-
code (
VoidSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
userErrors (
[VoidSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
-
voidSession (
VoidSession
)The updated void session.
Rejects an open void session.
After the voidSessionReject
mutation completes on a given void session, any
voidSessionResolve
mutation attempts will fail. Subsequent voidSessionReject
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 void session ID. |
reason
(
VoidSessionRejectionReasonInput!
)
required
|
The rejection reason. |
VoidSessionRejectionReasonInput fields
-
code (
VoidSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
userErrors (
[VoidSessionRejectUserError!]!
)The list of errors that occurred from executing the mutation.
-
voidSession (
VoidSession
)The updated void session.