paymentSessionReject mutation
Rejects an open payment session.
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
id
(
ID!
)
required
|
The payment session ID. |
reason
(
PaymentSessionRejectionReasonInput!
)
required
|
The rejection reason. |
PaymentSessionRejectionReasonInput fields
code
(PaymentSessionStatusReasonRejectionCode!)
Required
|
The reason code. |
merchantMessage
(String)
|
A custom localized message for the merchant. |
Return fields
paymentSession
(PaymentSession)
|
The updated payment session. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |
Rejects an open payment session.
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
id
(
ID!
)
required
|
The payment session ID. |
reason
(
PaymentSessionRejectionReasonInput!
)
required
|
The rejection reason. |
PaymentSessionRejectionReasonInput fields
code
(PaymentSessionStatusReasonRejectionCode!)
Required
|
The reason code. |
merchantMessage
(String)
|
A custom localized message for the merchant. |
Return fields
paymentSession
(PaymentSession)
|
The updated payment session. |
userErrors
([UserError!]!)
|
List of errors that occurred executing the mutation. |