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

voidSessionReject mutation

Version unstable

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

Return fields

Version 2021-07 (Release candidate)

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

Return fields