Choose the Documentation MX Merchant MX Connect

Cancel a Transaction

Cancel a transaction that is still in SCHEDULED or PENDING status before it is picked up for processing. This action cannot be undone.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
enum
required

Identifier type for the transaction. Use id for the Passport-assigned reference ID or externalId for the program manager-assigned identifier.

Allowed:
string
required

Unique identifier of the transaction to cancel.

Body Params

Cancellation details including reason and optional comment.

string
enum
required

Reason for cancelling the transaction.

Allowed:
string

Additional comment. Required when reason is OTHERS.

Headers
string
enum
required

Controls response timing. Use NEVER for an immediate synchronous response or ALWAYS for asynchronous processing.

Allowed:
Responses
204

Cancellation accepted. The transaction moves to CANCELLED status and will not be processed.

400

The request could not be processed. The transaction may not be in a cancellable status (SCHEDULED or PENDING).

401

Authentication failed. Verify that the Authorization header contains a valid Bearer token.

403

The authenticated user does not have permission to perform this operation.

404

The requested transaction was not found.

500

An unexpected error occurred on the server while processing the request.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here!