paymentSessionReject mutation

Version unstable

Rejects an open payment session. After the paymentSessionReject mutation completes on a given payment session, any paymentSessionResolve mutation attempts will fail. Subsequent paymentSessionReject 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 payment session ID.

reason ( PaymentSessionRejectionReasonInput! ) required

The rejection reason.

PaymentSessionRejectionReasonInput fields

Return fields

  • paymentSession (PaymentSession)

    The updated payment session.

  • userErrors ([UserError!]!)

    List of errors that occurred from executing the mutation.

Version 2021-10 (Release candidate)

Rejects an open payment session. After the paymentSessionReject mutation completes on a given payment session, any paymentSessionResolve mutation attempts will fail. Subsequent paymentSessionReject 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.