Cancel a Session
Cancels a checkout session. The session is locked against any further payment attempts, and every in-flight (non-terminal) transaction linked to the session is cancelled in the same call. Transactions that have already reached a terminal state (settled, failed, refunded) are not affected.
If a transaction on the session is being processed by a provider that does not support cancelling an in-progress transaction, the session enters the PENDING_CANCELLATION state instead of CANCELLED. While in this state, no further payment attempts can be initiated against the session, but the session is not considered fully cancelled until the in-flight transaction reaches a terminal state on its own. The response will list the unstoppable transactions in pendingTransactionIds.
Request
Optional free-form reason for the cancellation, recorded for reporting.
Response
The resulting state of the session. CANCELLED indicates the session and all of its in-flight transactions have been cancelled. PENDING_CANCELLATION indicates the session is locked against further payment attempts, but at least one in-flight transaction belongs to a provider that does not support in-process cancellation — the session will move to CANCELLED once those transactions reach a terminal state.
Human-readable status message.
Transactions still in flight that could not be cancelled because their provider does not support in-process cancellation. Populated only when status is PENDING_CANCELLATION. Each entry will progress to its own terminal state independently. UUID v7.