API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

paymentSessionReject mutation

Version unstable

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.

Version 2021-01 (Release candidate)

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.