CollectPaymentsManage Payments

Cancel a Transaction

Cancels a single transaction by its identifier. The transaction is the only thing affected — the session it belongs to remains active, and any other transactions on the session continue normally. A transaction can only be cancelled while it is in a non-terminal state and while the originating provider supports cancelling an in-progress transaction. Otherwise the call returns `409`.

Path parameters

transactionIdstringRequiredformat: "uuid"
Identifier of the transaction to cancel. UUID v7.

Request

This endpoint expects an object.
reasonstringOptional

Optional free-form reason for the cancellation, recorded for reporting.

Response

Transaction cancelled.
transactionIdstringformat: "uuid"
Identifier of the cancelled transaction. UUID v7.
statusenum
The resulting state of the transaction.
Allowed values:
messagestring

Human-readable status message.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error