refundSessionReject mutation
Rejects an open refund session.
After the refundSessionReject
mutation completes on a given refund session, any
refundSessionResolve
mutation attempts will fail. Subsequent refundSessionReject
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 refund session ID. |
reason
(
RefundSessionRejectionReasonInput!
)
required
|
The rejection reason. |
RefundSessionRejectionReasonInput fields
-
code (
RefundSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
refundSession (
RefundSession
)The updated refund session.
-
userErrors (
[RefundSessionRejectUserError!]!
)List of errors that occurred executing the mutation.
Rejects an open refund session.
After the refundSessionReject
mutation completes on a given refund session, any
refundSessionResolve
mutation attempts will fail. Subsequent refundSessionReject
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 refund session ID. |
reason
(
RefundSessionRejectionReasonInput!
)
required
|
The rejection reason. |
RefundSessionRejectionReasonInput fields
-
code (
RefundSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
refundSession (
RefundSession
)The updated refund session.
-
userErrors (
[RefundSessionRejectUserError!]!
)List of errors that occurred executing the mutation.
Rejects an open refund session.
After the refundSessionReject
mutation completes on a given refund session, any
refundSessionResolve
mutation attempts will fail. Subsequent refundSessionReject
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 refund session ID. |
reason
(
RefundSessionRejectionReasonInput!
)
required
|
The rejection reason. |
RefundSessionRejectionReasonInput fields
-
code (
RefundSessionStatusReasonRejectionCode!
) RequiredThe reason code.
-
merchantMessage (
String
)A custom, localized message for the merchant.
Return fields
-
refundSession (
RefundSession
)The updated refund session.
-
userErrors (
[RefundSessionRejectUserError!]!
)List of errors that occurred executing the mutation.